get_discontinuities

method of dascore.core.coords.BaseCoord source

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.
Note

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).

Coordinates without internal segment structure return an empty dataframe.