pymovements.events.event_properties.amplitude

pymovements.events.event_properties.amplitude(position_columns: tuple[str, str] = ('x_pos', 'y_pos')) → Expr

Amplitude of an event.

Parameters:

position_columns – The column names of the pitch and yaw position components.

Raises:

TypeError – If position_columns not of type tuple, position_columns not of length 2, or elements of position_columns not of type str.