mne.io.read_raw_gdf#

mne.io.read_raw_gdf(input_fname, eog=None, misc=None, stim_channel='auto', exclude=(), include=None, preload=False, verbose=None) RawGDF[source]#

Reader function for GDF files.

Parameters:
input_fnamepath-like

Path to the GDF file.

eoglist or tuple

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

misclist or tuple

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

stim_channel'auto' | str | list of str | int | list of int

Defaults to 'auto', which means that channels named 'status' or 'trigger' (case insensitive) are set to STIM. If str (or list of str), all channels matching the name(s) are set to STIM. If int (or list of ints), channels corresponding to the indices are set to STIM.

excludelist of str | str

Channel names to exclude. This can help when reading data with different sampling rates to avoid unnecessary resampling. A str is interpreted as a regular expression.

includelist of str | str

Channel names to be included. A str is interpreted as a regular expression. ‘exclude’ must be empty if include is assigned.

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

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:
rawinstance of RawGDF

The raw instance. See mne.io.Raw for documentation of attributes and methods.

See also

mne.io.read_raw_edf

Reader function for EDF and EDF+ files.

mne.io.read_raw_bdf

Reader function for BDF files.

mne.io.Raw

Documentation of attributes and methods of RawGDF.

Notes

If channels named ‘status’ or ‘trigger’ are present, they are considered as STIM channels by default. Use func:mne.find_events to parse events encoded in such analog stim channels.

Examples using mne.io.read_raw_gdf#

Importing data from EEG devices

Importing data from EEG devices