runpandas.types.acessors.metrics.MetricsAcessor.distance¶
-
MetricsAcessor.
distance
(correct_distance=False, to_special_column=True, **kwargs)¶ Calculates the distance in meters using haversine distance formula on an Activity frame.
- Parameters
correct_distance (bool, optional) – It computes the distance corrected by the altitude. default is False.
to_special_column (bool, optional) – It converts the distance calculated (pandas.Series) to special runpandas distance cummulative column (runpandas.types.columns.DistancePerPosition). Default is True.
**kwargs (Keyword args to be passed to the haversine method) –
- Returns
haversine_dist – A Series of floats representing the distance in meters with the same index of the accessed activity object.
- Return type
pandas.Series or runpandas.types.columns.DistancePerPosition