pastas.plotting.modelplots.Plotting.results_mosaic#

pastas.plotting.modelplots.Plotting.results_mosaic(tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, stderr: bool = False, block_or_step: str = 'step', return_warmup: bool = False, adjust_height: bool = True, figsize: tuple[float, float] | None = None, layout: Literal['constrained', 'tight', 'compressed', 'none'] | None = 'constrained', fig_kwargs: dict[str, Any] | None = None) → dict[str, pastas.typing.Axes]#

Plot the results of the model in a mosaic plot.

Parameters:

  • tmin (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the start date for the period (E.g. ‘1980-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.

  • tmax (pandas.Timestamp or str, optional) – A string or pandas.Timestamp with the end date for the period (E.g. ‘2020-01-01 00:00:00’). Strings are converted to pandas.Timestamp internally.

  • stderr (bool, optional) – If True the standard error of the parameter values are shown.

  • block_or_step (str, optional) – Plot the block- or step-response on the right. Default is ‘step’.

  • adjust_height (bool, optional) – Adjust the height of the graphs, so that the vertical scale of all the subplots on the left is equal. Default is True.

  • return_warmup (bool, optional) – Show the warmup-period. Default is False.

  • figsize (tuple, optional) – tuple of size 2 to determine the figure size in inches.

  • **kwargs (dict, optional) – Optional arguments, passed on to the matplotlib.pyplot.figure method.

Return type:

Dictionary with the matplotlib.axes.Axes

Examples

>>> ml.plots.results_mosaic()