pymovements.Gaze.compute_event_properties#

Gaze.compute_event_properties(event_properties: str | tuple[str, dict[str, Any]] | list[str | tuple[str, dict[str, Any]]], name: str | None = None) → None[source]#

Calculate event properties for given events.

The calculated event properties are added as columns to events.

Parameters:

event_properties (str | tuple[str, dict[str, Any]] | list[str | tuple[str, dict[str, Any]]]) – The event properties to compute.
name (str | None) – Process only events that match the name. (default: None)

Raises:

InvalidProperty – If property_name is not a valid property. See pymovements.events.event_properties for an overview of supported properties.
RuntimeError – If specified event name name is missing from events.
ValueError – If the computed property already exists as a column in events.