pastas.model.Model.residuals#
- pastas.model.Model.residuals(p: pastas.typing.ArrayLike | None = None, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, freq: str | None = None, warmup: float | None = None) pandas.Series#
Method to calculate the residual series.
- Parameters:
p (array_like, optional) – array_like object with the values as floats representing the model parameters. See Model.get_parameters() for more info if parameters is None.
tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start date for the simulation period (E.g. ‘1980-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally. If none is provided, the tmin from the oseries is used.
tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the end date for the simulation period (E.g. ‘2020-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally. If none is provided, the tmax from the oseries is used.
freq (str, optional) – String with the frequency the stressmodels are simulated. Must be one of the following: (D, h, m, s, ms, us, ns) or a multiple of that e.g. “7D”.
warmup (float, optional) – Warmup period (in Days).
- Returns:
res – pandas.Series with the residuals.
- Return type: