pymovements.events.event_properties.amplitude#

pymovements.events.event_properties.amplitude(*, position_column: str = 'position', n_components: int = 2) → Expr[source]#

Amplitude of an event.

Parameters:

  • position_column – The column name of the position tuples.

  • n_components – Number of positional components. Usually these are the two components yaw and pitch.

Raises:

ValueError – If number of components is not 2.