pymovements.events.event_properties.peak_velocity

pymovements.events.event_properties.peak_velocity(velocity_columns: tuple[str, str] = ('x_vel', 'y_vel')) → Expr

Peak velocity of an event.

Parameters:

velocity_columns – The column names of the pitch and yaw velocity components.

Raises:

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