runpandas.types.acessors.metrics.MetricsAcessor.gradient

MetricsAcessor.gradient(to_special_column=True, **kwargs)

Calculates the gradient ratio from an Activity frame.

Parameters

• to_special_column (convert the distance calculated (pandas.Series)) – to special runpandas Gradient column (runpandas.types.columns.Gradient). Default is True.

• **kwargs (Keyword args to be passed to the Gradient build method) –

Returns

grad – A Series of floats representing the vertical altitude speed in meters with the same index of the accessed activity object.

Return type

pandas.Series or runpandas.types.columns.Gradient