This documentation is for development version 0.18.dev0.

mne.io.read_raw_eeglab

mne.io.read_raw_eeglab(input_fname, montage=None, eog=(), preload=False, uint16_codec=None, stim_channel=False, verbose=None)[source]

Read an EEGLAB .set file.

Parameters:
input_fname : str

Path to the .set file. If the data is stored in a separate .fdt file, it is expected to be in the same folder as the .set file.

montage : str | None | instance of Montage

Path or instance of montage containing electrode positions. If None, sensor locations are (0,0,0). See the documentation of mne.channels.read_montage() for more information.

eog : list | tuple | ‘auto’

Names or indices of channels that should be designated EOG channels. If ‘auto’, the channel names containing EOG or EYE are used. Defaults to empty tuple.

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). Note that preload=False will be effective only if the data is stored in a separate binary file.

uint16_codec : str | None

If your *.set file contains non-ascii characters, sometimes reading it may fail and give rise to error message stating that “buffer is too small”. uint16_codec allows to specify what codec (for example: ‘latin1’ or ‘utf-8’) should be used when reading character arrays and can therefore help you solve this problem.

stim_channel : False

Deprecated, will be removed in 0.19; migrate code to use mne.events_from_annotations() instead.

New in version 0.17.

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 RawEEGLAB

A Raw object containing EEGLAB .set data.

See also

mne.io.Raw
Documentation of attribute and methods.

Notes

New in version 0.11.0.