mne.io.read_raw_nirx

mne.io.read_raw_nirx(fname, preload=False, verbose=None)[source]

Reader for a NIRX fNIRS recording.

This function has only been tested with NIRScout devices.

Parameters
fnamestr

Path to the NIRX data folder or header file.

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, or 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 RawNIRX

A Raw object containing NIRX data.

See also

mne.io.Raw

Documentation of attribute and methods.

Examples using mne.io.read_raw_nirx