Consider interpreting naming conventions from the Nexus format
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
See https://manual.nexusformat.org/datarules.html?highlight=uncertainties#rules-for-storing-data-items-in-nexus-files, specifically the "Reserved suffixes", e.g., _mask is something we could handle:
Reserved suffixes
When naming a field, NeXus has reserved certain suffixes to the names
so that a specific meaning may be attached. Consider a field named DATASET,
the following table lists the suffixes reserved by NeXus.
| suffix | reference | meaning |
|---|---|---|
| _end | NXtransformations | end points of the motions that start with DATASET |
| _errors | NXdata | uncertainties (a.k.a., errors) |
| _increment_set | NXtransformations | intended average range through which the corresponding axis moves during the exposure of a frame |
| _indices | NXdata | Integer array that defines the indices of the signal field which need to be used in the DATASET in order to reference the corresponding axis value |
| _mask | Field containing a signal mask, where 0 means the pixel is not masked. If required, bit masks are defined in NXdetector pixel_mask. | |
| _set | target values | Target value of DATASET |
| _weights | divide DATASET by these weights [4] |
Contributor guide
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 by reading the linked NeXus documentation on reserved suffixes and then inspect how scippnexus currently interprets field names. Determine the intended behavior for suffixes such as _mask, _errors, _indices, _set, and _weights; done should include the supported conventions and tests demonstrating their interpretation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100