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

Clarify that the equivalent of aicsimageio.types.PhysicalPixelSizes is bioio_base.types.PhysicalPixelSizes #45

Open
SergeEParent opened this issue May 30, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@SergeEParent
Copy link

Feature Description

Please make it clearer in the documentation that the equivalent of aicsimageio.types.PhysicalPixelSizes is bioio_base.types.PhysicalPixelSizes.

Use Case

I was having trouble finding the BioIO equivalent of aicsimageio.types.PhysicalPixelSizes in the documentation and had to delve into the code to find that it was under bioio_base.types. I use it to reassign some missing metadata to an image when saving it with OmeTiffWriter.
I was unable to find it in the AICSImageIO migration guide too (also the Reader Installation Instructions link says "Not Found" and does not lead anywhere on the migration page).

Solution

Add section for bioio_base to the API Reference.

Alternatives

Describe in the AICSImageIO migration guide that "aicsimageio.types.PhysicalPixelSizes is now bioio_base.types.PhysicalPixelSizes".

@SergeEParent SergeEParent added the enhancement New feature or request label May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant