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

Operetta/Phenix: calculate physical Z size in micrometers #4253

Merged
merged 1 commit into from
Nov 8, 2024

Conversation

melissalinkert
Copy link
Member

Fixes #4240 (cc @mabruce).

showinf -nopix -omexml on curated/perkinelmer-operetta/public/omer/ without this change should show a PhysicalSizeZ that is very small, and in dm units. With this change, the PhysicalSizeZ should be in µm units, and large enough to not round to 0.

This does require a configuration update, which does flag that two sample plates now have a PhysicalSizeZ of 1µm. See forthcoming configuration PR.

Adding to 8.0.1 for initial evaluation, but this can easily be moved to a later milestone.

@melissalinkert melissalinkert added this to the 8.0.1 milestone Nov 7, 2024
Copy link
Member

@sbesson sbesson left a comment

Choose a reason for hiding this comment

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

While this file format internally supports different length units and nanometers are typically used for excitation wavelength, several quantities including ImageResolutionX, ImageResolutionY, PositionX, PositionY, PositionZ are notoriously stored as meters using scientific notations for their values. This statement applies for all the representative samples in the curated OME QA repository.

The reader internally converts the values of ImageResolutionX and ImageResolutionY into micrometers when populating the Pixels.PhysicalSize{X,Y} values since the introduction of the reader in #22. Note this logic might also reflect the vestige of a time where the OME data model did not support alternative units and the physical sizes had to be stored as micrometers. However, looking at all representative samples, this matches the actual scale of every data acquired by this instrument and received so far and provides a much better user experience for any tool aiming to display this metadata.

In that sense, the change proposed in this PR simply updates the handling of the physical size alongside Z to match the exact same assumptions as the other physical sizes and improves both the reader consistency as well as the user experience.

@sbesson sbesson merged commit 6a548c9 into ome:develop Nov 8, 2024
18 checks passed
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.

OperettaReader: use smaller units when calculating physical Z size
2 participants