Class Epochs

mne/epochs.py:3449–3698

Epochs extracted from a Raw instance. Parameters ---------- %(raw_epochs)s .. note:: If ``raw`` contains annotations, ``Epochs`` can be constructed around ``raw.annotations.onset``, but note that the durations of the annotations are ignored i

@fill_doc
class Epochs(BaseEpochs):
    """Epochs extracted from a Raw instance.

    Parameters
    ----------
    %(raw_epochs)s

        .. note::
            If ``raw`` contains annotations, ``Epochs`` can be constructed around
            ``raw.annotations.onset``, but note that the durations of the annotations
            are ignored in this case.
    %(events_epochs)s

        .. versionchanged:: 1.7
            Allow ``events=None`` to use ``raw.annotations.onset`` as the source of
            epoch times.
    %(event_id)s
    %(epochs_tmin_tmax)s
    %(baseline_epochs)s
        Defaults to ``(None, 0)``, i.e. beginning of the data until
        time point zero.
    %(picks_all)s
    preload : bool
        %(epochs_preload)s
    %(reject_epochs)s
    %(flat)s
    %(proj_epochs)s
    %(decim)s
    %(epochs_reject_tmin_tmax)s
    %(detrend_epochs)s
    %(on_missing_epochs)s
    %(reject_by_annotation_epochs)s
    %(metadata_epochs)s

        .. versionadded:: 0.16
    %(event_repeated_epochs)s
    %(verbose)s

    Attributes
    ----------
    %(info_not_none)s
    %(event_id_attr)s
    ch_names : list of string
        List of channel names.
    %(selection_attr)s
    preload : bool
        Indicates whether epochs are in memory.
    drop_log : tuple of tuple
        A tuple of the same length as the event array used to initialize the
        Epochs object. If the i-th original event is still part of the
        selection, drop_log[i] will be an empty tuple; otherwise it will be
        a tuple of the reasons the event is not longer in the selection, e.g.:

        - 'IGNORED'
            If it isn't part of the current subset defined by the user
        - 'NO_DATA' or 'TOO_SHORT'
            If epoch didn't contain enough data names of channels that exceeded
            the amplitude threshold