pastas.plotting.modelplots.Plotting.contribution#

Plotting.contribution(tmin=None, tmax=None, name=None, plot_stress=True, plot_response=False, block_or_step='step', istress=None, ax=None, **kwargs)[source]#

Plot the contribution of a stressmodel and optionally the stress and the response.

Parameters
  • tmin (str or pd.Timestamp, optional) –

  • tmax (str or pd.Timestamp, optional) –

  • name (str, optional) – Name of the stressmodel to plot the contribution for.

  • plot_stress (bool, optional) – Plot the stress on an overlay axes.

  • plot_response (bool, optional) – Plot the step response on a separate axes on the right.

  • block_or_step (str, optional) – Type of response to plot, either ‘block’ or ‘step’. Default is ‘step’.

  • istress (int, optional) – Index of the stress to plot the response for. Default is None.

  • ax (dict or matplotlib.axes.Axes, optional) – Dictionary containing axes with ‘con’ and ‘rf’ as keys, or a single axes instance for the contribution plot.

  • kwargs (dict, optional) – Passed to the stress plot.

Returns

axes – Dictionary containing the axes for the contribution, and optionally the stress and response.

Return type

dict