Function read_events

mne/event.py:206–327

Read :term:`events` from fif or text file. See :ref:`tut-events-vs-annotations` and :ref:`tut-event-arrays` for more information about events. Parameters ---------- filename : path-like Name of the input file. If the extension is ``.fif``, events are read assumi

(
    filename,
    include=None,
    exclude=None,
    mask=None,
    mask_type="and",
    return_event_id=False,
    verbose=None,
)

@verbose
def read_events(
    filename,
    include=None,
    exclude=None,
    mask=None,
    mask_type="and",
    return_event_id=False,
    verbose=None,
):
    """Read :term:`events` from fif or text file.

    See :ref:`tut-events-vs-annotations` and :ref:`tut-event-arrays`
    for more information about events.

    Parameters
    ----------
    filename : path-like
        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 | None
        The value of the digital mask to apply to the stim channel values.
        If None (default), no masking is performed.
    mask_type : ``'and'`` | ``'not_and'``
        The type of operation between the mask and the trigger.
        Choose 'and' (default) for MNE-C masking behavior.

        .. versionadded:: 0.13
    return_event_id : bool
        If True, ``event_id`` will be returned. This is only possible for
        ``-annot.fif`` files produced with MNE-C ``mne_browse_raw``.

        .. versionadded:: 0.20
    %(verbose)s

    Returns
    -------
    %(events)s
    event_id : dict
        Dictionary of ``{str: int}`` mappings of event IDs.

    See Also
    --------
    find_events, write_events

    Notes
    -----
    This function will discard the offset line (i.e., first line with zero