mne-tools / mne-tools/mne-python
Support coordinate systems in SNIRF file
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Describe the new feature or enhancement
The latest release of the SNIRF file specification for fNIRS data includes a new field called 'coordinateSystem'. Prior to this field there was no way of knowing what coordinate system the sensor locations were specified in. As a hack we previously used a custom field called MNE_coordframe. We should implement reading of this new field in the SNIRF reader.
Additional comments
We should also implement writing of this field in the MNE-NIRS repository.
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 with the SNIRF reader entry point in mne-python and compare its handling with the linked SNIRF specification's coordinateSystem field. Confirm how the existing MNE_coordframe field is handled, then define completion as reading coordinateSystem here and writing it in the MNE-NIRS repository, with tests covering both behaviors.
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
- Mostly clear
- Newbie friendliness
- 45/100