This documentation is for development version 0.18.dev0.

mne.preprocessing.find_eog_events

mne.preprocessing.find_eog_events(raw, event_id=998, l_freq=1, h_freq=10, filter_length='10s', ch_name=None, tstart=0, reject_by_annotation=False, thresh=None, verbose=None)[source]

Locate EOG artifacts.

Parameters:
raw : instance of Raw

The raw data.

event_id : int

The index to assign to found events.

l_freq : float

Low cut-off frequency to apply to the EOG channel in Hz.

h_freq : float

High cut-off frequency to apply to the EOG channel in Hz.

filter_length : str | int | None

Number of taps to use for filtering.

ch_name: str | None

If not None, use specified channel(s) for EOG

tstart : float

Start detection after tstart seconds.

reject_by_annotation : bool

Whether to omit data that is annotated as bad.

thresh : float

Threshold to trigger EOG event.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
eog_events : array

Events.