tiledbsoma.Scene.set_transform_to_multiscale_image

Scene.set_transform_to_multiscale_image(key: str, subcollection: str | Sequence[str] = 'img', *, transform: CoordinateTransform, coordinate_space: CoordinateSpace | None = None) → MultiscaleImage

Adds the coordinate transform for the scene coordinate space to a multiscale image stored in the scene.

The transform to the multiscale image must be to the coordinate space defined on the reference level for the image. In most cases, this will be the level 0 image.

Parameters:

  • key – The name of the multiscale image.

  • subcollection – The name, or sequence of names, of the subcollection the image is stored in. Defaults to 'img'.

  • transform – The coordinate transformation from the scene to the reference level of the multiscale image.

  • coordinate_space – Optional coordinate space for the image. This will replace the existing coordinate space of the multiscale image.

Returns:

The multiscale image, opened for writing.

Lifecycle: experimental