pymovements.dataset.Dataset.clip

Dataset.clip(lower_bound: int | float | None, upper_bound: int | float | None, *, input_column: str, output_column: str, verbose: bool = True, **kwargs: Any) → Dataset

Clip gaze signal values.

This method requires a properly initialized experiment attribute.

After success, the gaze dataframe is clipped.

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.

• verbose (bool) – If True, show progress of computation. (default: True)

• **kwargs (Any) – Additional keyword arguments to be passed to the clip() method.

Returns:

Returns self, useful for method cascading.

Return type:

Dataset

Raises:

AttributeError – If gaze is None or there are no gaze dataframes present in the gaze attribute, or if experiment is None.