pastas.model.Model.observations#
- Model.observations(tmin=None, tmax=None, freq=None, update_observations=False)[source]#
Method that returns the observations series used for calibration.
- Parameters:
tmin (str, optional) – String with a start date for the simulation period (E.g. ‘1980’). If none is provided, the tmin from the oseries is used.
tmax (str, optional) – String with an end date for the simulation period (E.g. ‘2010’). 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”.
update_observations (bool, optional) – If True, force recalculation of the observations, default is False.
- Returns:
oseries_calib – pandas series of the oseries used for calibration of the model.
- Return type:
Notes
This method makes sure the simulation is compared to the nearest observation. It finds the index closest to sim_index, and then returns a selection of the oseries. In the residuals method, the simulation is interpolated to the observation-timestamps.