Add optional "long_name" to "axes"
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 171
- Forks
- 75
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 20
Description
The "axes" metadata currently contains a "name" that is typically { "x", "y", "z", "c", "t' }.
We could also add support for an optional "long_name" to the "axes" metadata. This would be a semantic name that could be standardized across domains, e.g. "anterior-posterior", "width".
While standard, canonical values could help interpretation, this adds more flexibility and the possibility for additional, sometimes crucial metadata. For visualization, this would be the name of the axes label.
This also improves xarray, NetCDF compatibility, so there is a corresponding long_name and units:
https://docs.unidata.ucar.edu/netcdf-c/current/attribute_conventions.html
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the NGFF axes metadata specification linked in the issue, then review the referenced NetCDF attribute conventions and the compatibility implications for xarray. Define how an optional long_name is represented, interpreted, and standardized across domains; the work is done when the specification clearly documents the field and its intended visualization and compatibility behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100