mne.events_from_annotations#

mne.events_from_annotations(raw, event_id='auto', regexp='^(?![Bb][Aa][Dd]|[Ee][Dd][Gg][Ee]).*$', use_rounding=True, chunk_duration=None, tol=1e-08, verbose=None)[source]#

Get events and event_id from an Annotations object.

Parameters:

rawinstance of Raw

The raw data for which Annotations are defined.

event_iddict | callable() | None | 'auto'

Can be:

dict: map descriptions (keys) to integer event codes (values). Only the descriptions present will be mapped, others will be ignored.
callable: must take a string input and return an integer event code, or return None to ignore the event.
None: Map descriptions to unique integer values based on their sorted order.
‘auto’ (default): prefer a raw-format-specific parser:
- Brainvision: map stimulus events to their integer part; response events to integer part + 1000; optic events to integer part + 2000; ‘SyncStatus/Sync On’ to 99998; ‘New Segment/’ to 99999; all others like None with an offset of 10000.
- Other raw formats: Behaves like None.
New in v0.18.

regexpstr | None

Regular expression used to filter the annotations whose descriptions is a match. The default ignores descriptions beginning 'bad' or 'edge' (case-insensitive).

Changed in version 0.18: Default ignores bad and edge descriptions.

use_roundingbool

If True, use rounding (instead of truncation) when converting times to indices. This can help avoid non-unique indices.

chunk_durationfloat | None

Chunk duration in seconds. If chunk_duration is set to None (default), generated events correspond to the annotation onsets. If not, mne.events_from_annotations() returns as many events as they fit within the annotation duration spaced according to chunk_duration. As a consequence annotations with duration shorter than chunk_duration will not contribute events.

tolfloat

The tolerance used to check if a chunk fits within an annotation when chunk_duration is not None. If the duration from a computed chunk onset to the end of the annotation is smaller than chunk_duration minus tol, the onset will be discarded.

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:

eventsndarray of int, shape (n_events, 3): The identity and timing of experimental events, around which the epochs were created. See events for more information.
event_iddict: The event_id variable that can be passed to Epochs.