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 | None = True, plot_individual: bool | None = False, x_axis_in_minutes: bool | None = True) tuple[list[Figure], ndarray[tuple[Any, ...], dtype[Axes]]][source]#
Plot the comparison of the simulation results with the reference data.
- Parameters:
- simulation_resultsSimulationResults
Simulation results to compare to reference data.
- axsOptional[Axes | list[Axes]], default=None
An array of Axes objects to use for plotting the metrics.
- figsOptional[Figure | list[Figure]]
List of figures to use for plotting the metrics.
- file_nameOptional[str]
Name of the file to save the figure to.
- showOptional[bool], default=True
If True, displays the figure(s) on the screen.
- plot_individualOptional[bool], default=False
If True, generates a separate figure for each metric.
- x_axis_in_minutes: Optional[bool], default=True
If True, the x-axis will be plotted using minutes. The default is True.
- 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.