Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the MultiscaleImage API #238

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Update the MultiscaleImage API #238

wants to merge 5 commits into from

Conversation

jp-dark
Copy link
Collaborator

@jp-dark jp-dark commented Oct 22, 2024

This PR is a work in progress. The goal is to simplify/improve the MultiscaleImage API.

Comment on lines -716 to -734
class ImageProperties(Protocol):
"""Class requirements for level properties of images.

Lifecycle: experimental
"""

@property
def name(self) -> str:
"""The key for the image.

Lifecycle: experimental
"""

@property
def shape(self) -> Tuple[int, ...]:
"""Size of each axis of the image.

Lifecycle: experimental
"""
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This class didn't add much value as is. We may want to expand it to include more information or just remove it altogether.

coordinate_space: Union[Sequence[str], coordinates.CoordinateSpace] = (
"x",
"y",
),
axis_types: Sequence[str] = ("channel", "height", "width"),
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a better name or better argument to take to distinguish between the on disk data order and the coordinate space?

@jp-dark jp-dark requested review from aaronwolen, ihnorton, johnkerl, ktsitsi and ivirshup and removed request for ihnorton October 22, 2024 20:30
* Remove ``axis_type`` parameter from ``create``
* Add parameters to specify initial Image URI.
* Add ``data_axis_order`` to ``create`` and ``read_spatial_region``.
* Fix DenseNDArray types to be _DenseND
* Add return type for the new `set` methods
* Add `data_axis_order` property
* Add `has_channel_axis` property
* Add `nchannel` property
* Fix docstring for `level_shape`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant