Skip to content
Snippets Groups Projects
Commit 0f311945 authored by David Schäfer's avatar David Schäfer
Browse files

Update BreakDetection.md

parent c17f56e7
No related branches found
No related tags found
No related merge requests found
......@@ -12,17 +12,17 @@ breaks_spektrumBased(thresh_rel=0.1, thresh_abs=0.01,
smooth=True, smooth_window="3h", smooth_poly_deg=2,)
```
| parameter | data type | default value | description |
|-----------------------|---------------------------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| thresh_rel | float | `0.1` | Minimum relative difference between two values to consider the latter as a break candidate. See condition (1) |
| thresh_abs | float | `0.01` | Minimum absolute difference between two values to consider the latter as a break candidate. See condition (2) |
| first_der_factor | float | `10` | Multiplication factor for arithmetic mean of the first derivatives surrounding a break candidate. See condition (3). |
| first_der_window | [offset string](docs/ParameterDescriptions.md#offset-strings) | `"12h"` | Window around a break candidate for which the arithmetic mean is calculated. See condition (3) |
| scnd_der_ratio_range | float | `0.05` | Range of the area, covering all the values of the second derivatives quotient, that are regarded "sufficiently close to 1" for signifying a break. See condition (5). |
| scnd_der_ratio_thresh | float | `10.0` | Threshold for the ratio of the second derivatives succeeding a break. See condition (5). |
| smooth | bool | `True` | Smooth the time series before differentiation using the Savitsky-Golay filter |
| smooth_window | [offset string](docs/ParameterDescriptions.md#offset-strings) | `None` | Size of the smoothing window of the Savitsky-Golay filter. The default value `None` results in a window of two times the sampling rate (i.e. three values) |
| smooth_poly_deg | integer | `2` | Degree of the polynomial used for smoothing with the Savitsky-Golay filter |
| parameter | data type | default value | description |
|-----------------------|---------------------------------------------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
| thresh_rel | float | `0.1` | Minimum relative difference between two values to consider the latter as a break candidate. See condition (1) |
| thresh_abs | float | `0.01` | Minimum absolute difference between two values to consider the latter as a break candidate. See condition (2) |
| first_der_factor | float | `10` | Multiplication factor for arithmetic mean of the first derivatives surrounding a break candidate. See condition (3). |
| first_der_window | [offset string](docs/ParameterDescriptions.md#offset-strings) | `"12h"` | Window around a break candidate for which the arithmetic mean is calculated. See condition (3) |
| scnd_der_ratio_range | float | `0.05` | Maximum deviation from one of the ratio of the second derivatives of a break candidate and its preceding value. See condition (5) |
| scnd_der_ratio_thresh | float | `10.0` | Threshold for the ratio of the second derivatives of a break candidate and its succeeding value. See condition (5) |
| smooth | bool | `True` | Smooth the time series before differentiation using the Savitsky-Golay filter |
| smooth_window | [offset string](docs/ParameterDescriptions.md#offset-strings) | `None` | Size of the smoothing window of the Savitsky-Golay filter. The default value `None` results in a window of two times the sampling rate (i.e. three values) |
| smooth_poly_deg | integer | `2` | Degree of the polynomial used for smoothing with the Savitsky-Golay filter |
The function flags breaks (jumps/drops) by evaluating the derivatives of a time series.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment