pymovements.datasets.public_dataset.PublicDataset.detect_events#

PublicDataset.detect_events(method: EventDetectionCallable, eye: str = '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 or right. If auto is passed, left will only be chosen if the right eye is not available in the gaze data frame.

  • 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.