pandas.DataFrame.xyz.z_gain_threshold

DataFrame.xyz.z_gain_threshold(**kwargs)

Conservatively calculate elevation gain from a series of coordinates.

This algorithm doesn’t count elevation gain until the elevation coordinates rise by at least a threshold value from their prior reference location.

See z_filter_threshold().

Parameters

• **elevation (scalar) – column label in the record DataFrame containing elevation coordinates along the route in meters above sea level. Must be numeric dtype. If a label is not provided, the parameter name itself is used.

• **threshold (float) – the value, in meters, by which an elevation coordinate must exceed the reference elevation coordinate in order to count toward the total. Default 5.0.

Returns

total elevation gain along the route in meters.

Return type

float