mne.io.read_raw_egi¶

mne.io.read_raw_egi(input_fname, montage=None, eog=None, misc=None, include=None, exclude=None, preload=False, channel_naming=’E%d’, verbose=None)[source]¶

Read EGI simple binary as raw object.

Note

The trigger channel names are based on the arbitrary user dependent event codes used. However this function will attempt to generate a synthetic trigger channel named STI 014 in accordance with the general Neuromag / MNE naming pattern.

The event_id assignment equals np.arange(n_events - n_excluded) + 1. The resulting event_id mapping is stored as attribute to the resulting raw object but will be ignored when saving to a fiff. Note. The trigger channel is artificially constructed based on timestamps received by the Netstation. As a consequence, triggers have only short durations.

This step will fail if events are not mutually exclusive.

Parameters:

Parameters:	input_fname : str Path to the raw 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. Default is None. misc : list or tuple Names of channels or list of indices that should be designated MISC channels. Default is None. include : None \| list The event channels to be ignored when creating the synthetic trigger. Defaults to None. Note. Overrides exclude parameter. exclude : None \| list The event channels to be ignored when creating the synthetic trigger. Defaults to None. If None, channels that have more than one event and the `sync` and `TREV` channels will be ignored. 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). ..versionadded:: 0.11 channel_naming : str 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’. ..versionadded:: 0.14.0 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 RawEGI A Raw object containing EGI data.

input_fname : str

Path to the raw 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. Default is None.

misc : list or tuple

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

include : None | list

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

exclude : None | list

The event channels to be ignored when creating the synthetic trigger. Defaults to None. If None, channels that have more than one event and the sync and TREV channels will be ignored.

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

..versionadded:: 0.11

channel_naming : str

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

..versionadded:: 0.14.0

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 RawEGI

A Raw object containing EGI data.