runpandas.types.acessors.metrics.MetricsAcessor.speed¶
-
MetricsAcessor.
speed
(from_distances=False, to_special_column=True, **kwargs)¶ Calculates the speed in meters using an Activity frame.
- Parameters
from_distances (bool, optional) – Should the speeds be calculated from the distance recordings instead of taken from the speed recordings directly? Default is False.
to_special_column (convert the distance calculated (pandas.Series)) – to special runpandas speed column (runpandas.types.columns.Speed). Default is True.
**kwargs (Keyword args to be passed to the speed building method) –
- Returns
speed – A Series of floats representing the speed in meters with the same index of the accessed activity object.
- Return type
pandas.Series or runpandas.types.columns.Speed