Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Aaron Wolen <[email protected]>
  • Loading branch information
jp-dark and aaronwolen authored Sep 27, 2024
1 parent f9a17d7 commit a8b079c
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions apis/python/src/tiledbsoma/_multiscale_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,10 @@ def read_spatial_region(
result_order: options.ResultOrderStr = options.ResultOrder.ROW_MAJOR,
platform_config: Optional[options.PlatformConfig] = None,
) -> somacore.SpatialRead[pa.Tensor]:
"""Reads a user-defined region of space into a :class:`SpatialRead` with data
in either an Arrow tensor or table.
"""Reads a user-defined spatial region from a specific level of the ``MultiscaleImage``.
Reads the bounding box of the input region from the requested image level. This
will return a :class:`SpatialRead` with the image data stored as a
:class:`pa.Tensor`.
Retrieves the data within the specified region from the requested image level, returning
a :class:`SpatialRead`, yielding :class:`pa.Tensor`s.
Args:
level: The image level to read the data from. May use index of the level
Expand Down Expand Up @@ -220,7 +218,7 @@ def image_type(self) -> str:

@property
def level_count(self) -> int:
"""The number of image levels stored in the ``MultiscaleImage``.
"""The number of image resolution levels stored in the ``MultiscaleImage``.
Lifecycle:
Experimental.
Expand Down

0 comments on commit a8b079c

Please sign in to comment.