pyacs.gts.lib.l1trend.breakpoints module

Breakpoint detection and extraction from L1-trend filtered time series.

pyacs.gts.lib.l1trend.breakpoints.l1trend_to_breakpoints(self, tol='auto', threshold=[1.0, 1.0, 5.0])[source]

Convert a Gts resulting from a L1-trend-filtering to a dictionary of breakpoints. The breakpoints are computed by looking for significant changes in the slope of the time series.

Parameters:
  • tol (float or 'auto') – Tolerance for detecting breakpoints in mm/yr. If ‘auto’, finds the greatest tol such that the max difference between interpolated breakpoints and the time series is below a threshold for each component.

  • threshold (list of floats) – List of thresholds in mm for each component (‘N’, ‘E’, ‘U’) to determine the best tolerance if tol is ‘auto’. Default is [1., 1., 5.] for ‘N’, ‘E’, and ‘U’ respectively. If tol is a float, this parameter is ignored.

Returns:

bp – Dictionary with keys as component names (‘E’, ‘N’, ‘U’) and dates/values as bp[component][0], H_bp[component][1]

Return type:

record