should `multiscales` be a collection?

Open
#205 9 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reading the current NGFF specification sections defining multiscales and the examples of ome-ngff containers. Review the issue discussion and investigate whether real-world data uses multiple multiscale metadata instances in one group. Done means reaching and documenting a consensus on the JSON shape and its implications for the specification and implementations.

Written by the indexing model from the issue text.

Description

rfc-8

The purpose of this issue is to discuss whether multiscales should be a collection of multiscale metadata, or just a single instance of multiscale metadata. I.e., should ome-ngff support multiple multiscale images in the same group. My current suspicion is that an overwhelming majority of ome-ngff containers will have just a single element in multiscales, and if that's true, we should re-evaluate whether multiscales should be a JSON array. The argument for not allowing multiple multiscale images to exist in the same multiscale group stems from the complexity it introduces to the spec and implementations. I'm happy to elaborate on this if necessary.

Speaking for the data I manage, I cannot foresee a situation where we would put multiple multiscale images in the same group. But I am curious how many data producers are using or planning to use this feature. Can someone point me to an ome-ngff "in the wild" that has multiple instances of multiscale metadata in multiscales?

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

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.

More from ome/ngff

All issues in ome/ngff

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.