tiledbsoma.MultiscaleImage.read_spatial_region

MultiscaleImage.read_spatial_region(level: int | str, region: Sequence[int] | Sequence[float] | BaseGeometry | None = None, *, channel_coords: None | int | Slice[int] = None, region_transform: CoordinateTransform | None = None, region_coord_space: CoordinateSpace | None = None, result_order: ResultOrder | Literal['auto', 'row-major', 'column-major'] = ResultOrder.ROW_MAJOR, data_axis_order: Sequence[str] | None = None, platform_config: Dict[str, Mapping[str, Any]] | object | None = None) → SpatialRead[Tensor]

Reads a user-defined spatial region from a specific level of the MultiscaleImage.

Retrieves the data within the specified region from the requested image level, returning a SpatialRead, yielding :class:`pa.Tensor`s.

Parameters:

  • level – The image level to read the data from. May use index of the level or the image name.

  • region – The region to query. May be a box in the form [x_min, y_min, x_max, y_max] (for 2D images), a box in the form [x_min, y_min, z_min, x_max, y_max, z_max] (for 3D images), or a shapely Geometry.

  • channel_coords – An optional slice that defines the channel coordinates to read.

  • region_transform – An optional coordinate transform that provides the transformation from the provided region to the reference level of this image. Defaults to None.

  • region_coord_space – An optional coordinate space for the region being read. The axis names must match the input axis names of the transform. Defaults to None, coordinate space will be inferred from transform.

  • data_axis_order – The order to return the data axes in. Use soma_channel to specify the location of the channel coordinate.

  • result_order – The order data to return results, specified as a ResultOrder or its string value. This is the result order the data is read from disk. It may be permuted if data_axis_order is not the default order.

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

Returns:

The data bounding the requested region as a SpatialRead with pa.Tensor data.

Lifecycle

Experimental.