pymovements.gaze.GazeDataFrame.detect

GazeDataFrame.detect(method: Callable[..., pm.EventDataFrame] | str, *, eye: str = 'auto', clear: bool = False, **kwargs: Any) → None

Detect events by applying a specific event detection method.

Parameters:

• method (Callable[..., pm.EventDataFrame] | str) – 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. (default: ‘auto’)

• clear (bool) – If True, event DataFrame will be overwritten with new DataFrame instead of being merged into the existing one. (default: False)

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