mne.read_events

mne.read_events(filename, include=None, exclude=None, mask=0)

Reads events from fif or text file

Parameters:

filename : string

Name of the input file. If the extension is .fif, events are read assuming the file is in FIF format, otherwise (e.g., .eve, .lst, .txt) events are read as coming from text. Note that new format event files do not contain the “time” column (used to be the second column).

include : int | list | None

A event id to include or a list of them. If None all events are included.

exclude : int | list | None

A event id to exclude or a list of them. If None no event is excluded. If include is not None the exclude parameter is ignored.

mask : int

The value of the digital mask to apply to the stim channel values. The default value is 0.

Returns:

events: array, shape (n_events, 3) :

The list of events

Notes

This function will discard the offset line (i.e., first line with zero event number) if it is present in a text file.

Working with downsampled data: Events that were computed before the data was decimated are no longer valid. Please recompute your events after decimation.