pastas.stats.dutch.q_ghg#

pastas.stats.dutch.q_ghg(series: pandas.Series, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, q: float = 0.94, by_year: bool = True) → pandas.Series#

Gemiddeld Hoogste Grondwaterstand (GHG) also called MHGL (Mean High GW Level).

Parameters:

  • series (pandas.Series) – Series to calculate the GHG for.

  • tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start and end dates for the period (E.g. ‘1980-01-01 00:00:00’ and ‘2020-01-01 00:00:00’).

  • tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start and end dates for the period (E.g. ‘1980-01-01 00:00:00’ and ‘2020-01-01 00:00:00’).

  • q (float, optional) – quantile fraction of exceedance (default 0.94)

  • by_year (bool, optional) – Take average over quantiles per year (default True)

Notes

Approximated by taking quantiles of the time series values per year and calculating the mean of the quantiles. The series is first resampled to daily values.