mne.io.read_raw_snirf#

mne.io.read_raw_snirf(fname, optode_frame='unknown', *, sfreq=None, preload=False, verbose=None)[source]#

Reader for a continuous wave SNIRF data.

Note

This reader supports the .snirf file type only, not the .jnirs version. Files with either 3D or 2D locations can be read. However, we strongly recommend using 3D positions. If 2D positions are used the behaviour of MNE functions can not be guaranteed.

Parameters:

fnamepath-like: Path to the SNIRF data file.
optode_framestr: Coordinate frame used for the optode positions. The default is unknown, in which case the positions are not modified. If a known coordinate frame is provided (head, meg, mri), then the positions are transformed in to the Neuromag head coordinate frame (head).
sfreqfloat | None: The nominal sampling frequency at which the data were acquired. If None, will be estimated from the time data in the file.

New in v1.10.
preloadbool | str: Preload data into memory for data manipulation and faster indexing. If True, the data will be preloaded into memory (fast, requires large amount of memory). If preload is a string, it is the name of a freshly created memory-mapped file used to store the data on the hard drive (slower, requires less memory). An existing file is overwritten. The caller owns the file and is responsible for removing it after the Raw object is no longer in use.
verbosebool | str | int | None: Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:

rawinstance of RawSNIRF: A Raw object containing fNIRS data. See mne.io.Raw for documentation of attributes and methods.

Examples using `mne.io.read_raw_snirf`#

Importing data from fNIRS devices

mne.io.read_raw_snirf#

Examples using mne.io.read_raw_snirf#

Examples using `mne.io.read_raw_snirf`#