clip

pymovements.transforms.clip(lower_bound: int | float | None, upper_bound: int | float | None, *, input_column: str, output_column: str, n_components: int) → Expr

Clip gaze signal to a lower and upper bound.

Parameters:

• lower_bound (int | float | None) – Lower bound of the clipped column.

• upper_bound (int | float | None) – Upper bound of the clipped column.

• input_column (str) – Name of the input column.

• output_column (str) – Name of the output column.

• n_components (int) – Number of components in input column.

Returns:

The respective polars expression.

Return type:

pl.Expr