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

Clarification about _ARRAY_DIMENSIONS #217

Closed
tcompa opened this issue Oct 17, 2023 · 3 comments · Fixed by #218
Closed

Clarification about _ARRAY_DIMENSIONS #217

tcompa opened this issue Oct 17, 2023 · 3 comments · Fixed by #218

Comments

@tcompa
Copy link
Contributor

tcompa commented Oct 17, 2023

Hi there,

The current version of 0.4 specs states (https://github.com/ome/ngff/blob/main/0.4/index.bs#L148) that

    ├── .zgroup               # Each image is a Zarr group, or a folder, of other groups and arrays.
    ├── .zattrs               # Group level attributes are stored in the .zattrs file and include
    │                         # "multiscales" and "omero" (see below). In addition, the group level attributes
    │                         # must also contain "_ARRAY_DIMENSIONS" if this group directly contains multi-scale arrays.

but other sources suggest that _ARRAY_DIMENSIONS was removed from the 0.4 NGFF specs:

I'd like to know whether this is just a typo in the specs, or whether v0.4 still requires image groups to have a _ARRAY_DIMENSIONS attribute. Thanks!

@will-moore
Copy link
Member

Thanks for pointing this out and for referencing ome/ome-zarr-py#166 (comment). From the discussion there I see that _ARRAY_DIMENSIONS isn't required by the 0.4 spec, so we need to update the text in the spec accordingly.
e.g.

In addition, the group level attributes
may also contain "_ARRAY_DIMENSIONS" for compatibility with xarray if this group directly contains multi-scale arrays.

@tcompa
Copy link
Contributor Author

tcompa commented Oct 17, 2023

Thanks for the clarification.

so we need to update the text in the spec accordingly. e.g.

In addition, the group level attributes
may also contain "_ARRAY_DIMENSIONS" for compatibility with xarray if this group directly contains multi-scale arrays.

If it's useful I can open a PR with this change.

@will-moore
Copy link
Member

Yes please! - thanks

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 a pull request may close this issue.

2 participants