mne.io.read_raw_edf

mne.io.read_raw_edf(input_fname, montage=None, eog=None, misc=None, stim_channel=-1, annot=None, annotmap=None, preload=False, verbose=None)

Reader function for EDF+, BDF conversion to FIF

Parameters:

input_fname : str

Path to the EDF+,BDF 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 or tuple

Names of channels or list of indices that should be designated EOG channels. Values should correspond to the electrodes in the edf file. Default is None.

misc : list or tuple

Names of channels or list of indices that should be designated MISC channels. Values should correspond to the electrodes in the edf file. Default is None.

stim_channel : str | int | None

The channel name or channel index (starting at 0). -1 corresponds to the last channel (default). If None, there will be no stim channel added.

annot : str | None

Path to annotation file. If None, no derived stim channel will be added (for files requiring annotation file to interpret stim channel).

annotmap : str | None

Path to annotation map file containing mapping from label to trigger. Must be specified if annot is not None.

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

Returns:

raw : Instance of RawEDF

A Raw object containing EDF data.

See also

mne.io.Raw
Documentation of attribute and methods.