mne.io.read_raw_snirf

mne.io.read_raw_snirf(fname, optode_frame='unknown', 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
fnamestr

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).

preloadbool or str (default False)

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, preload is the file name of a memory-mapped file which is used to store the data on the hard drive (slower, requires less memory).

verbosebool | str | int | None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.

Returns
rawinstance of RawSNIRF

A Raw object containing fNIRS data.

See also

mne.io.Raw

Documentation of attribute and methods.

Examples using mne.io.read_raw_snirf