CADETProcess.comparison.Comparator.plot_comparison

CADETProcess.comparison.Comparator.plot_comparison#

Comparator.plot_comparison(simulation_results: SimulationResults, axs: Axes | list[Axes] | None = None, figs: Figure | list[Figure] | None = None, file_name: str | None = None, show: bool = True, plot_individual: bool = False, x_axis_in_minutes: bool = True) tuple[list[Figure], list[Axes]][source]#

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

Parameters:
simulation_resultsSimulationResults

Simulation results to compare to reference data.

axslist of Axes, optional

List of subplot axes to use for plotting the metrics.

figslist of Figures, optional

List of figures to use for plotting the metrics.

file_namestr, optional

Name of the file to save the figure to.

showbool, optional

If True, displays the figure(s) on the screen.

plot_individualbool, optional

If True, generates a separate figure for each metric.

x_axis_in_minutes: bool, optional

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

Returns:
figslist of Figure

List of figures used for plotting the metrics.

axslist of AxesSubplot

List of subplot axes used for plotting the metrics.