ome / ome/ngff

No way to distinguish image and labels-image groups in 0.5

Open
#339 16 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
171
Forks
75
Avg merge
2d 3h
Merged PRs (30d)
20

Description

In version 0.4, it was possible to tell whether a group was a image group or an image labels group, because an image labels group was required to have a image-label entry in the metadata (https://ngff.openmicroscopy.org/0.4/index.html#label-md).

In version 0.5, it is no longer possible to distinguish between these two types of group, because image labels are no longer required to have an image-label entry. Instead, the spec only says this entry should (not must) be present. (https://ngff.openmicroscopy.org/0.5/index.html#labels-md).

This means that every valid image group is also a valid image-label group, and vice versa.

Would it be useful to still distinguish between these two types of group, and if so, introduce some new metadata that allows them to be distinguished?

Personally I think there is value in distinguishing between these groups so they can be interpreted differently by image veiwers (a labels dataset should be displayed differently to an imaging dataset for example) and readers, and for scientists to signal their intent as to whether a group is an image or labels.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the 0.4 label metadata section with the 0.5 labels metadata section linked in the issue. Determine whether the specification needs an unambiguous distinction between image and image-label groups, and document the agreed metadata rule or resolution in the relevant 0.5 specification text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.