search

mne-tools / mne-python

MNE: Magnetoencephalography (MEG) and Electroencephalography (EEG) in Python
https://mne.tools
BSD 3-Clause "New" or "Revised" License
2.72k stars 1.32k forks source link

Add file reader for Artinis fNIRS devices #8001

Closed rob-luke closed 3 years ago

rob-luke commented 4 years ago

This issue is about adding support for Artinis Medical Systems fNIRS devices to MNE.

The first step is to collect some small (approximately 10 second) recordings to be used in unit tests. The details of how the data is collected should be documented including all hardware and software parameters. The test data should be committed to the mne-testing-data repository. Here is an example of the first NIRS test file that was added which is a good example of the minimum level of detail preferred, additional testing data was added as support was expanded to include more hardware and software versions. It is handy if the data can include some trigger information too.

Based on the OxyMon Leaflet - rev. 1901 the OxyMon is a continuous wave device so we can use the type fnirs_cw_amplitude (see https://github.com/mne-tools/mne-python/issues/7912 for discussion of different types). This is the same data type as used for the NIRX reader, so that can be used as a template. Please correct me if I am wrong here, I don't have access to a device.

A file reader will need to be created and unit tests for the reader. As an example you can view the NIRX file reader here and the tests can be viewed here. It is also worth looking at the non NIRS data readers too as they may be more similar to the Artinis format.

larsoner commented 4 years ago

Sounds like a good plan to me

rob-luke commented 4 years ago

Alternatively if there is an Artinis to SNIRF converter then we can just ensure the SNIRF reader is sufficient.

HanBnrd commented 3 years ago

Just referencing a few items that may be useful:

rob-luke commented 3 years ago

Artinis have added a tutorial on their website about how to use Artinis data with MNE https://www.artinis.com/blogpost-all/2021/fnirs-analysis-toolbox-series-mne-python so combined with the changes from @HanBnrd I guess this is closed. Please reopen if the artinis provided solution is not sufficient.