This documentation is for development version 0.18.dev0.

mne.io.read_raw_fif

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

Reader function for Raw FIF data.

Parameters:
fname : str

The raw file to load. For files that have automatically been split, the split part will be automatically loaded. Filenames should end with raw.fif, raw.fif.gz, raw_sss.fif, raw_sss.fif.gz, raw_tsss.fif or raw_tsss.fif.gz.

allow_maxshield : bool | str (default False)

If True, allow loading of data that has been recorded with internal active compensation (MaxShield). Data recorded with MaxShield should generally not be loaded directly, but should first be processed using SSS/tSSS to remove the compensation signals that may also affect brain activity. Can also be “yes” to load without eliciting a warning.

preload : bool 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).

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
raw : instance of Raw

A Raw object containing FIF data.

Notes

New in version 0.9.0.

Examples using mne.io.read_raw_fif