CADETProcess.comparison.Comparator.plot_comparison

CADETProcess.comparison.Comparator.plot_comparison#

Comparator.plot_comparison(simulation_results: list[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, use_minutes: bool = True) tuple[list[Figure], list[Axes]][source]#

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

Parameters:
simulation_resultslist of SimulationResults

List of simulation results to compare to reference data.

axslist of AxesSubplot, optional

List of subplot axes to use for plotting the metrics.

figslist of Figure, 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.

use_minutesbool, optional

Option to use x-aches (time) in minutes, default is set to 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.