pastas.stats.dutch.gg#

pastas.stats.dutch.gg(series: pandas.Series, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, fill_method: str = 'nearest', limit: int = 0, output: str = 'mean', min_n_meas: int = 16, min_n_years: int = 8, year_offset: str = year_offset + '-MAR') → pandas.Series | float#

Calculate the ‘Gemiddelde Grondwaterstand’ (Average Groundwater Level).

Parameters:

  • series (pandas.Series with a DatetimeIndex) – The pandas Series of which the statistic is determined.

  • tmin (pandas.Timestamp or str, optional) – A Timestamp or str is expected. The lowest index to take into account (E.g. ‘1980-01-01 00:00:00’).

  • tmax (pandas.Timestamp or str, optional) – A Timestamp or str is expected. The highest index to take into account (E.g. ‘2020-01-01 00:00:00’).

  • fill_method (str, optional) – see .. :mod: pastas.stats.dutch._gxg

  • limit (int or None, optional) – Maximum number of days to fill using fill method, use None to fill nothing.

  • output (str, optional) – output type * ‘mean’ (default) : for mean of yearly values. * ‘yearly’: for series of yearly values. * ‘g3’: for series with selected data for calculating statistic. * ‘semimonthly’: for series with all data points (14th, 28th of each month).

  • min_n_meas (int, optional) – Minimum number of measurements per year (at maximum 24).

  • min_n_years (int, optional) – Minimum number of years.

  • year_offset (resampling offset. Use "YE" for calendar years (jan 1 to dec 31) and)

  • 31). ('YE-MAR' for hydrological years (apr 1 to mar)

Returns:

series of yearly values or mean of yearly values.

Return type:

pd.Series or scalar

Notes

Classic method resampling the series to every 14th and 28th of the month.