pymovements.EventGazeProcessor.process#

EventGazeProcessor.process(events: Events, gaze: pm.Gaze, identifiers: str | list[str], name: str | None = None) → pl.DataFrame[source]#

Process event and gaze dataframe.

Parameters:

events (Events) – Event data to process event properties from.
gaze (pm.Gaze) – Gaze data to process event properties from.
identifiers (str | list[str]) – Column names to join on events and gaze dataframes.
name (str | None) – Process only events that match the name. (default: None)

Returns:

polars.DataFrame with properties as columns and rows refering to the rows in the source dataframe.

Return type:

pl.DataFrame

Raises:

ValueError – If list of identifiers is empty.
InvalidProperty – If property_name is not a valid property. See pymovements.events for an overview of supported properties.
RuntimeError – If specified event name name is missing from events.