pastas.stats.signatures.low_pulse_duration#

pastas.stats.signatures.low_pulse_duration(series: pandas.Series, quantile: float = 0.2, rolling_window: str | None = '7D') → float#

Average duration of pulses where the head is below a certain threshold.

Parameters:

  • series (pandas.Series) – Pandas Series with DatetimeIndex and head values.

  • quantile (float, optional) – Quantile used as a threshold.

  • rolling_window (str, optional) – Rolling window to use for smoothing the time series. Default is 7 days. Set to None to disable. See the pandas documentation for more information.

Returns:

Average duration (in days) of pulses where the head drops below a certain threshold.

Return type:

float

Notes

Average duration of pulses (in days) where the head drops below a certain threshold.

Warning

This method is sensitive to measurement noise, e.g., every change is sign in the differences is counted as a pulse. Therefore, it is recommended to smooth the time series first (which is also the default).