| thresh | float | | The threshold, for the total rise (`thresh` $` > 0 `$ ), or total drop (`thresh` $` < 0 `$ ), that value courses must not exceed within a timespan of length `raise_window` |
| raise_window | [offset string](docs/ParameterDescriptions.md#offset-strings) | | The timespan, the rise/drop thresholding refers to. Window is inclusively defined. |
| intended_freq | [offset string](docs/ParameterDescriptions.md#offset-strings) | | The frequency, timeseries to-be-flagged is supposed to be sampled at. Window is inclusively defined. |
| average_window | [offset string](docs/ParameterDescriptions.md#offset-strings) | `None` | See condition (2) below. Window is inclusively defined. The window defaults to 1.5 times the size of `raise_window` |
The function flags rises and drops in value courses, that exceed the threshold
given by `thresh` within a timespan shorter than, or equalling the time window
given by `raise_window`.
Weather rises or drops are flagged, is controlled by the signum of `thresh`.
(positive->rises, negative->drops)
The parameter variety of the function is owned to the intriguing
case of values, that "return" from outlierish or anomalious value levels and
thus exceed the threshold, while actually being usual values.
The value $`x_{k}`$ of a time series $`x`$ with associated
timestamps $`t_i`$, is flagged a rise, if:
1. There is any value $`x_{s}`$, preceeding $`x_{k}`$ within `raise_window` range, so that:
* $` M = |x_k - x_s | > `$ `thresh` $` > 0`$
2. The weighted average $`\mu^*`$ of the values, preceeding $`x_{k}`$ within `average_window` range indicates, that $`x_{k}`$ doesnt return from an outliererish value course, meaning that:
3. Additionally, if `min_slope` is not `None`, $`x_{k}`$ is checked for being sufficiently divergent from its very predecessor $`x_{k-1}`$, meaning that, it is additionally checked if:
