Function make_fixed_length_events

mne/event.py:923–997

Make a set of :term:`events` separated by a fixed duration. Parameters ---------- raw : instance of Raw A raw object to use the data from. id : int The id to use (default 1). start : float Time of first event (in seconds). stop : float | None

(
    raw,
    id=1,  # noqa: A002
    start=0,
    stop=None,
    duration=1.0,
    first_samp=True,
    overlap=0.0,
)

@fill_doc
def make_fixed_length_events(
    raw,
    id=1,  # noqa: A002
    start=0,
    stop=None,
    duration=1.0,
    first_samp=True,
    overlap=0.0,
):
    """Make a set of :term:`events` separated by a fixed duration.

    Parameters
    ----------
    raw : instance of Raw
        A raw object to use the data from.
    id : int
        The id to use (default 1).
    start : float
        Time of first event (in seconds).
    stop : float | None
        Maximum time of last event (in seconds). If None, events extend to the
        end of the recording.
    duration : float
        The duration to separate events by (in seconds).
    first_samp : bool
        If True (default), times will have :term:`first_samp` added to them, as
        in :func:`mne.find_events`. This behavior is not desirable if the
        returned events will be combined with event times that already
        have :term:`first_samp` added to them, e.g. event times that come
        from :func:`mne.find_events`.
    overlap : float
        The overlap between events (in seconds).
        Must be ``0 <= overlap < duration``.

        .. versionadded:: 0.18

    Returns
    -------
    %(events)s
    """
    from .io import BaseRaw

    _validate_type(raw, BaseRaw, "raw")
    _validate_type(id, "int", "id")
    _validate_type(duration, "numeric", "duration")
    _validate_type(overlap, "numeric", "overlap")
    duration, overlap = float(duration), float(overlap)
    if not 0 <= overlap < duration:
        raise ValueError(
            f"overlap must be >=0 but < duration ({duration}), got {overlap}"
        )

    start = raw.time_as_index(start, use_rounding=True)[0]
    if stop is not None:
        stop = raw.time_as_index(stop, use_rounding=True)[0]
    else:
        stop = raw.last_samp + 1
    if first_samp: