Modify NIRS coil type names to match SNIRF and add frequency domain types#28
Modify NIRS coil type names to match SNIRF and add frequency domain types#28larsoner merged 3 commits intomne-tools:masterfrom
Conversation
Brings FIFF naming and types in to agreement with https://github.com/fNIRS/snirf/blob/master/snirf_specification.md#appendix
|
FYI @larsoner @agramfort |
Co-authored-by: Alexandre Gramfort <alexandre.gramfort@m4x.org>
|
For Megin this is ok. fNIRS community can decide. |
The two new ones are: And I actually initially had the same thought as you, that there could somehow be a translation between the frequency domain amplitude and phase and the time domain / continuous wave data. However, from what I understand, they are actually distinct in terms of the data they provide:
This is explained better in mne-tools/mne-python#7912 (comment) and the comment that follows it, but basically, the meaning of "raw" is now more specific to mean the continuous wave / DC value that you get by just A/D converting the data. Frequency domain time-varying amplitude and phase of the MHz frequencies could also be considered different "raw" forms/aspects of the measured data, but they seem sufficiently different to warrant a new coil type (like mag vs grad). They are complementary and both can and will be used to estimate the existing other fNIRS types we have (optical density, hbo, and hbr). Does this make sense?
The signal formerly called "raw" that we now call "continuous wave amplitude" is indeed just the momentary amplitude, so I don't think we need to add anything (if it were the Hilbert envelope, indeed something like "envelope amplitude" would make more sense). |
|
I entered through the diff and the second change slipped my eye. Should have read the comment thread bit better. |
|
Okay great, thanks @mkajola @rob-luke @agramfort for the quick work! |
This PR modifies the existing 302 coil type name to better match the SNIRF specification (a common format agreed to by the society for fNIRS) https://github.com/fNIRS/snirf/blob/master/snirf_specification.md#appendix
It also adds two new types (also defined in SNIRF) for frequency domain NIRS.
In mne-tools/mne-python#7912 we have discussed if these types are actually required, but please feel free to continue the discussion here if there are additional questions.