pastas.stressmodels.RechargeModel.get_stress#
- pastas.stressmodels.RechargeModel.get_stress(p: pastas.typing.ArrayLike | None = None, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, freq: str | None = None, istress: int | None = None, **kwargs) pandas.Series#
Obtain the recharge stress calculated by the model.
- Parameters:
p (array_like, optional) – array_like object with the values as floats representing the model parameters.
tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start date for the period (E.g. ‘1980-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.
tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the end date for the period (E.g. ‘2020-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.
freq (string, optional) – Frequency for the returned stress series. If None, the original frequency of the input stress is used.
istress (int, optional) – Return one of the stresses used for the recharge calculation. 0 for precipitation, 1 for evaporation and 2 for temperature.
kwargs – Additional keyword arguments. Not used in this method but included for consistency with other stress models.
- Returns:
stress – When no istress is selected, this returns the estimated recharge flux that is convolved with a response function on the simulate method.
- Return type: