get_discontinuities
get_discontinuities(
self ,
kind = all,
tolerance = None,
)-> ‘pd.DataFrame’
Return a dataframe describing discontinuities in the coordinate.
Parameters
| Parameter | Description |
|---|---|
| kind |
Either “all” (every segment boundary) or “gaps” (boundaries whose spacing exceeds the local sampling interval by more than tolerance).
|
| tolerance |
For kind=“gaps”, the excess spacing (beyond the expected sampling interval) required to report a boundary. For time-like coordinates numeric values are interpreted as seconds. Default 0. |
The returned dataframe has columns: index (position of the first sample after the boundary), before, after (values on either side), delta (after - before) and excess (delta minus the expected local sampling interval, NaN when no sampling interval is defined).
A monotonic array reports every spacing which is not its declared step (or its median spacing when it declares none); a segmented coordinate reports the seams between its runs; every other coordinate (a range, an unordered array, a partial or string coordinate) returns an empty dataframe. tolerance may also be a dascore.utils.gaps.GapTolerance.