pastas.model.Model.get_step_response#

pastas.model.Model.get_step_response(name, p: pastas.typing.ArrayLike | None = None, add_0: bool = False, dt: float | None = None, **kwargs) → pandas.Series | None#

Method to obtain the step response for a stressmodel.

The optimal parameters are used when available, initial otherwise.

Parameters:

  • name (str) – String with the name of the stressmodel.

  • 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.

  • add_0 (bool, optional) – Adds 0 at t=0 at the start of the response, defaults to False.

  • dt (float, optional) – timestep for the response function.

  • kwargs (dict, optional) – Kwargs are passed onto _get_response()

Returns:

s – Pandas.Series with the step response. The index is based on the frequency that is present in the model.settings.

Return type:

pandas.Series or None