mne-tools / mne-tools/mne-python
Support NIRSport devices
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Currently, mne.io.read_raw_nirx has been thoroughly tested only with data from NIRScout. However, we should add support for the other two devices from the company (NIRSport and the newer NIRSport2). As mentioned in #7894 and #7905, most generated files differ between devices except for the raw intensities (.wl1 and .wl2) so that we need to adapt the current reader accordingly. Test recordings for both devices are available in #7905.
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 mne.io.read_raw_nirx and compare the NIRSport and NIRSport2 recordings available in #7905 with the currently supported NIRScout data. Review how the raw intensity files (.wl1 and .wl2) are handled, then adapt the reader for the differing generated files and verify it against recordings from both devices.
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
- 35/100