Skip to content

Improvements to the text of RFC-3 - #560

Merged
joshmoore merged 17 commits into
ome:mainfrom
jni:rfc-3-improvements
Jul 15, 2026
Merged

Improvements to the text of RFC-3#560
joshmoore merged 17 commits into
ome:mainfrom
jni:rfc-3-improvements

Conversation

@jni

@jni jni commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

This PR updates RFC-3 to account for comments, questions, and data types raised
since it was created:

  • There was discussion that RFC-3 is primarily for exotic use cases.
    I'll admit that I have some of those in mind 😂 but it is actually mostly
    going to serve standard microscopy images, as demonstrated by Zeiss's
    interest
    , as well as comment 3 from Cornelia Wetzker detailing their
    use of FLIM. In private communications, Cornelia mentioned that most of their
    data is in LIF (Leica) format, which supports 6D. I've tried to amend the
    text to front load these standard microscopy use cases.
  • I've added FLIM to the data types that RFC-3 targets, to address Comment-3.
  • I've added some user stories around some of the data types.
  • I've added specifics to the proposal about how the spec's language would
    change.
  • Finally, I've made two sample RFC-3 datasets using real-world data in
    Add two real datasets to the repo clbarnes/ome-zarr-rfc3-data#1 that can be used to test compliance with RFC-3.

Hopefully, this is enough to get this over the finish line soon...!

@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Automated Review URLs

@joshmoore

Copy link
Copy Markdown
Member

Thanks @jni 🙏 Would you mind also updating the version history at the bottom before merge?

@jni

jni commented Jul 4, 2026

Copy link
Copy Markdown
Contributor Author

@joshmoore yup, did the thing!

@jo-mueller

jo-mueller commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Looking cool! Just one more thing that came up during the discussion around ome/ngff-spec#130 (and this is only relevant because RFC3 happened to go in after RFC5):

I think there could (should?) be a statement about the discrete flag in the axes metadata, by which a dimension can declare whether interpolation is well-defined along itself. By extension, this can imform transformations how to treat all non-spatial axes.

@jni

jni commented Jul 4, 2026

Copy link
Copy Markdown
Contributor Author

@jo-mueller what kind of statement? RFC-5 states axes/dimensions can be discrete or not, and RFC-3 has nothing more to say on the matter — we agree! 😂

@jni

jni commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Having looked at it in more detail, the rc0 version of the spec states:

[axes metadata] MAY contain the field discrete. The value MUST be a boolean, and is true if the axis represents a discrete dimension (see below for details).

and

Arrays are inherently discrete (see Array coordinate systems, below) but are often used to store discrete samples of a continuous variable. The continuous values “in between” discrete samples can be retrieved using an interpolation method. If an axis is continuous ("discrete" : false), it indicates that interpolation is well-defined. Axes representing space and time are usually continuous. Similarly, joint interpolation across axes is well-defined only for axes of the same type. In contrast, discrete axes ("discrete" : true) may be indexed only by integers. Axes representing a channel, coordinate, or displacement are usually discrete.

I can reiterate that in the multiscale metadata section, but it would be redundant?

@jni jni moved this from Backlog to In review in OME-Zarr 0.9.dev1 Jul 7, 2026
@jni

jni commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

@joshmoore as far as I'm concerned this is ready to be merged and sent out for (hopefully final) review! 🙏

@lubianat lubianat left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks good!

@joshmoore
joshmoore merged commit 2dabee1 into ome:main Jul 15, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in OME-Zarr 0.9.dev1 Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants