Skip to content

Make image label key mandatory for label images #89

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.

Sign up for GitHub

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

Open
dstansby wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Make image label key mandatory for label images #89

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ccb18bf
Make image label key mandatory for label images
dstansby Feb 17, 2026
4c7e8cf
Merge branch 'main' into image-label-must
jo-mueller Mar 3, 2026
e0ebe90
Merge branch 'main' into image-label-must
jo-mueller Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1419,10 +1419,11 @@ For example:
The `zarr.json` file for the label image MUST implement the multiscales specification.
Within the `multiscales` object, the JSON array associated with the `datasets` key MUST have the same number of entries (scale levels) as the original unlabeled image.

In addition to the `multiscales` key, the OME-Zarr Metadata in this image-level `zarr.json` file SHOULD contain another key, `image-label`,
In addition to the `multiscales` key, the OME-Zarr Metadata in this image-level `zarr.json` file MUST contain another key, `image-label`,
whose value is also a JSON object.
The `image-label` object stores information about the display colors, source image,
and optionally, further arbitrary properties of the label image.
The presence of the `image-label` object signals that this image contains labels.
It can optionally store information about the display colors, source image, and further arbitrary properties of the label image.

That `image-label` object SHOULD contain a `colors` key,
whose value MUST be a JSON array describing color information for the unique label values.

Expand Down
Loading