mne.io.read_raw_egi

mne.io.read_raw_egi(input_fname, eog=None, misc=None, include=None, exclude=None, preload=False, channel_naming='E%d', *, events_as_annotations=True, event_key=None, verbose=None)

Read EGI simple binary as raw object.

Parameters:

input_fnamepath-like

Path to the raw file. Files with an extension .mff are automatically considered to be EGI’s native MFF format files.

eoglist or tuple

Names of channels or list of indices that should be designated EOG channels. Default is None.

misclist or tuple

Names of channels or list of indices that should be designated MISC channels. Default is None.

includeNone | list

The event channels to be included when creating the synthetic trigger or annotations. Defaults to None. Note. Overrides exclude parameter.

excludeNone | list

The event channels to be ignored when creating the synthetic trigger or annotations. Defaults to None. If None, the sync and TREV channels will be ignored. This is ignored when include is not None.

preloadbool | str

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

New in v0.11.

channel_namingstr

Channel naming convention for the data channels. Defaults to 'E%d' (resulting in channel names 'E1', 'E2', 'E3'…). The effective default prior to 0.14.0 was 'EEG %03d'.

New in v0.14.0.

events_as_annotationsbool

If True, annotations are created from experiment events. If False (default), a synthetic trigger channel STI 014 is created from experiment events. See the Notes section for details. The default will change from False to True in version 1.9.

New in v1.8.0.

event_keystr | None

The MFF event key whose value is appended to annotation descriptions and extras when events_as_annotations=True, and to stim channel names when events_as_annotations=False. For example, event_key='cel#' will convert an MFF event code 'stim' with cel#=1 to 'stim_1'. These will also appear as 'event_key_cel#': 1 in annotations.extras Only supported for MFF files.

New in v1.11.0.

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 RawEGI

A Raw object containing EGI data. See mne.io.Raw for documentation of attributes and methods.

See also

mne.io.Raw

Documentation of attributes and methods of RawEGI.

Notes

When events_as_annotations=True, event codes on stimulus channels like DIN1 are stored as annotations with the description set to the stimulus channel name.

When events_as_annotations=False and events are present on the included stimulus channels, a new stim channel STI 014 will be synthesized from the events. It will contain 1-sample pulses where the Netstation file had event timestamps. A raw.event_id dictionary is added to the raw object that will have arbitrary sequential integer IDs for the events. This will fail if any timestamps are duplicated. The event_id will also not survive a save/load roundtrip.

For these reasons, it is recommended to use events_as_annotations=True.

MFF event track XML files can store additional metadata in a <keys> child element of each <event> element. This corresponds to the ECI Event Data Stream “Key List” described in the EGI Amp Server Pro SDK User Guide. For example, E-Prime driven experiments sometimes store the experimental condition in a 'cel#' event key.

Examples using mne.io.read_raw_egi

Getting impedances from raw files

Getting impedances from raw files

Removing the fMRI gradient artifact

Removing the fMRI gradient artifact

Working with eye tracker data in MNE-Python

Working with eye tracker data in MNE-Python