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

Merged
merged 5 commits into from
Oct 31, 2024
Merged

Update the MultiscaleImage API #238

merged 5 commits into from
Oct 31, 2024

Conversation

jp-dark
Copy link
Collaborator

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

This PR addresses feedback from PR #219 regarding the MultiscaleImage API. It includes the following changes:

  • Directly take the CoordinateSpace as a creation parameter.
  • Remove confusing image_type property/creation parameter. Use data_axis_order instead which uses the axis names the user provided.
  • Create the first resolution level when creating the MultiscaleImage.
  • Require the add_new_level to only add images smaller than the base (level=0) image.
  • Add a set method for adding images that exist outside of SOMA.
  • Add a property to check the number of channels in the image.
  • Remove ImageProperties class.

* 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`
@jp-dark jp-dark marked this pull request as ready for review October 31, 2024 13:42
Copy link
Member

@aaronwolen aaronwolen left a comment

Choose a reason for hiding this comment

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

Changes look good!

@jp-dark jp-dark merged commit d1ffae8 into main Oct 31, 2024
6 checks passed
@jp-dark jp-dark deleted the dark/multiscale-image branch October 31, 2024 20:40
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.

2 participants