pastas.model.Model.get_contribution#
- Model.get_contribution(name, tmin=None, tmax=None, freq=None, warmup=None, istress=None, return_warmup=False, p=None)[source]#
Method to get the contribution of a stressmodel.
- Parameters
name (str) – String with the name of the stressmodel.
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”.
istress (int, optional) – When multiple stresses are present in a stressmodel, this keyword can be used to obtain the contribution of an individual stress.
return_warmup (bool, optional) – Include warmup in contribution calculation or not.
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.
- Returns
contrib – Pandas.Series with the contribution.
- Return type