pastas.stats.signatures.colwell_constancy#

pastas.stats.signatures.colwell_constancy(series: pandas.Series, bins: int = 11, freq: str = 'W', method: Literal['mean'] = 'mean', normalize: bool = True) → tuple[float, float, float]#

Colwells constancy index after Colwell [1974].

Parameters:

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

  • bins (int) – number of bins to determine the states of the groundwater.

  • freq (str, optional) – frequency to resample the series to.

  • method (str, optional) – Method to use for resampling. Only “mean” is allowed now.

  • normalize (bool, optional) – normalize the time series to values between zero and one.

Returns:

c – Colwell’s constancy.

Return type:

float

Notes

One minus the sum of entropy with respect to state, divided by the logarithm of the absolute number of possible states.