tiledbsoma.MultiscaleImage.create

classmethod MultiscaleImage.create(uri: str, *, type: DataType, level_shape: Sequence[int], level_key: str = 'level0', level_uri: str | None = None, coordinate_space: Sequence[str] | CoordinateSpace = ('x', 'y'), data_axis_order: Sequence[str] | None = None, has_channel_axis: bool = True, platform_config: Dict[str, Mapping[str, Any]] | object | None = None, context: SOMATileDBContext | None = None, tiledb_timestamp: int | datetime | None = None) → Self

Creates a new MultiscaleImage at the given URI.

Parameters:

  • uri – The URI where the collection will be created.

  • type – The Arrow type to store the image data in the array. If the type is unsupported, an error will be raised.

  • level_shape – The shape of the multiscale image for level=0. Must include the channel dimension if there is one.

  • level_key – The name for the level=0 image. Defaults to level0.

  • level_uri – The URI for the level=0 image. If the URI is an existing SOMADenseNDArray it must match have the shape provided by level_shape and type specified in type. If set to ``None, the level_key will be used to construct a default child URI. For more on URIs see collection.Collection.add_new_collection().

  • coordinate_space – Either the coordinate space or the axis names for the coordinate space the level=0 image is defined on. This does not include the channel dimension, only spatial dimensions.

  • data_axis_order – The order of the axes as stored on disk. Use soma_channel to specify the location of a channel axis. If no axis is provided, this defaults to the channel axis followed by the coordinate space axes in reverse order (e.g. ("soma_channel", "y", "x") if coordinate_space=("x", "y")).

  • has_channel_axis – Save the image with a dedicated “channel” axis.

  • platform_config – platform-specific configuration; keys are SOMA implementation names.

  • context – Other implementation-specific configuration.

  • tiledb_timestamp – set timestamp for created TileDB SOMA objects.

Returns:

The newly created MultiscaleImage, with the initial image array open for writing.

Lifecycle

Experimental.