mne_nirs.io.fold_channel_specificity#

mne_nirs.io.fold_channel_specificity(raw, fold_files=None, atlas='Juelich', interpolate=False)[source]#

Return the landmarks and specificity a channel is sensitive to.

Parameters:
rawBaseRaw

The fNIRS data.

fold_fileslist | path-like | None

If None, will use the MNE_NIRS_FOLD_PATH config variable. If path-like, should be a path to a directory containing ‘10-10.xls’ and ‘10-5.xls’. If list, should be paths to the fold toolbox files. See Notes for details.

atlasstr

Brain atlas to use.

interpolatebool

If the optimal source-detector pair is not found in the fOLD files False (default) will yield no results for that pairing, whereas True will use the next closest match. See Notes for an example.

Warning

The sensitivity profile can differ substantially for nearest neighbors, so use interpolate=True with caution.

Returns:
speclist of DataFrame

List of dataframes, one for each channel.

See also

fold_landmark_specificity

Notes

fOLD Toolbox

Specificity values are provided by the fOLD toolbox [1] excel files. For licensing reasons, these files are not distributed with MNE-NIRS. You need to download them from the author’s website. To automatically utilize the MNE_NIRS_FOLD_PATH config for the fold_files parameter, you can download the entire fOLD-public repository as a zip and expand it to some suitable location like ~/mne_data/fOLD/fOLD-public-master, and then set the config value on your machine by using mne.set_config() like:

>>> mne.set_config('MNE_NIRS_FOLD_PATH', '~/mne_data/fOLD/fOLD-public-master/Supplementary')

From then on, fold_channel_specificity() and fold_landmark_specificity() will automatically use this directory to find the fOLD xls files when you pass fold_files=None (which is the default). We recommend following this procedure so that the files can be reused automatically.

Interpolation

For an example of interpolation, consider the pairings P5-PO7 nor P6-PO8, neither of which are listed in the fOLD toolbox:

  • With interpolate=False, the returned spec will not have entries for these channels. When

  • With interpolate=True, entries like P7-PO7 and P8-PO8, respectively, might be used instead. A warning is emitted if such substitutions are made.

References

Examples using mne_nirs.io.fold_channel_specificity#

Group Level GLM Analysis

Group Level GLM Analysis