pandas.DataFrame.xyz.z_filter_threshold

DataFrame.xyz.z_filter_threshold(**kwargs)

Filter elevation coordinates by ignoring changes smaller than some threshold value.

The resulting series of values will look like a staircase with varying tread lengths; the same reference value persists until the unfiltered coordinate series attains a value that has changed from that baseline by at least the threshold value, then that new coordinate value becomes the reference value.

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) – threshold, in meters, beyond which a change in elevation is registered by the algorithm. Default 5.0.

Returns

elevation coordinates filtered by the threshold value.

Return type

pandas.Series