pymovements.dataset.Dataset.pos2vel

Dataset.pos2vel(method: str = 'fivepoint', *, verbose: bool = True, **kwargs: Any) → Dataset

Compute gaze velocites in dva/s from dva coordinates.

This method requires a properly initialized experiment attribute.

After success, the gaze dataframe is extended by the resulting velocity columns.

Parameters:

• method (str) – Computation method. See pos2vel() for details. (default: ‘fivepoint’)

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

• **kwargs (Any) – Additional keyword arguments to be passed to the pos2vel() 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.