tiledbsoma.Scene.add_new_multiscale_image

Scene.add_new_multiscale_image(key: str, subcollection: str | Sequence[str], *, transform: CoordinateTransform | None, uri: str | None = None, coordinate_space: Sequence[str] | CoordinateSpace = ('x', 'y'), type: pa.DataType, level_shape: Sequence[int], level_key: str = 'level0', level_uri: str | None = None, data_axis_order: Sequence[str] | None = None, has_channel_axis: bool = True, platform_config: options.PlatformConfig | None = None) → MultiscaleImage

Adds a MultiscaleImage to the scene and sets a coordinate transform between the scene and the dataframe.

See add_new_collection() for details about child URIs.

Parameters:

  • key – The name of the multiscale image.

  • subcollection – The name, or sequence of names, of the subcollection the dataframe is stored in.

  • transform – The coordinate transformation from the scene to the dataframe.

  • uri – If provided, overrides the default URI what would be used to create this object. This may be aboslution or relative.

  • kwargs – Additional keyword arugments as specified in spatial.MultiscaleImage.create().

Returns:

The newly create MultiscaleImage, opened for writing.

Lifecycle

Experimental.