pymovements.datasets.gazebase.GazeBase.detect_events#

GazeBase.detect_events(method: EventDetectionCallable, eye: str | None = 'auto', clear: bool = False, verbose: bool = True, **kwargs) → None[source]#

Detect events by applying a specific event detection method.

Parameters:

  • method (EventDetectionCallable) – The event detection method to be applied.

  • eye (str) – Select which eye to choose. Valid options are auto, left, right or None. If auto is passed, eye is inferred in the order ['right', 'left', 'eye'] from the available gaze dataframe columns.

  • clear (bool) –

    If True, event DataFrame will be overwritten with new DataFrame instead of being

    merged into the existing one.

  • verbose (bool) – If True, show progress bar.

  • **kwargs – Additional keyword arguments to be passed to the event detection method.

Raises:

AttributeError – If gaze files have not been loaded yet or gaze files do not contain the right columns.