Single-scale images

Open
#207 3 comments 0 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
Quiet
Domain
documentation

Research direction

Start by reading this issue and the linked discussions in issues 187, 179, 200, and 102 to understand the competing metadata models. Determine whether the specification should define single-scale datasets as a valid type and document the resulting metadata and access behavior; done requires agreement on the proposal and corresponding specification changes.

Written by the indexing model from the issue text.

Description

enhancement rfc-8

Images are not always scale pyramids, but single-image arrays also benefit from some of the metadata we apply to multiscale groups. I suppose these are implicitly supported in the spec ("just add a coordinateTransformations and axes specified elsewhere") but IMO it would be useful to define single-scale datasets as their own valid type. The use case for me is extracting a small ROI from a single scale level of a larger volume.

You can, of course, define a multiscale group with only one dataset in it, but then it becomes quite verbose, as well as having to bounce between the group and array metadata.

This is sort of the opposite of https://github.com/ome/ngff/issues/187 : that asks to define some image metadata in a group above the containing group, where this asks to define some image metadata on the array itself.

This probably falls under https://github.com/ome/ngff/issues/179 , although that is specifically about labels and how to store them in a hierarchy rather than the broader class of single-scale images.

I believe this converges with with proposed solution "c" in https://github.com/ome/ngff/issues/200 (also discussed in https://github.com/ome/ngff/issues/102 ) . This would also simplify the access API: it's the same whether you're accessing a single-scale array, or if you only care about a single scale of a multiscale group.

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.