CADETProcess.stationarity.StationarityEvaluator.plot_comparison

CADETProcess.stationarity.StationarityEvaluator.plot_comparison#

StationarityEvaluator.plot_comparison(simulation_results: SimulationResults, x_axis_in_minutes: bool | None = True, ax: ndarray[Axes] | None = None, setup_figure_kwargs: dict | None = None) tuple[Figure, ndarray[tuple[Any, ...], dtype[Axes]]]#

Plot the comparison of the simulation results with the reference data.

Parameters:
simulation_resultsSimulationResults

Simulation results to compare to reference data.

x_axis_in_minutes: Optional[bool], default=True

If True, the x-axis will be plotted using minutes. The default is True.

axnp.ndarray[plt.Axes] | None, default=None

Optional array of Matplotlib Axes. If not provided, a new figure is created.

setup_figure_kwargsdict | None, default=None

Additional options to setup the figure.

Returns:
tuple

A tuple containing: - list[plt.Figure]: A list of Matplotlib Figure objects. - npt.NDArray[plt.Axes]: An array of Axes objects with one Axes per

difference metric.