CADETProcess.comparison.Comparator.setup_comparison_figure

CADETProcess.comparison.Comparator.setup_comparison_figure#

Comparator.setup_comparison_figure(plot_individual: bool | None = False) tuple[list[Figure], ndarray[tuple[Any, ...], dtype[Axes]]][source]#

Set up a figure for comparing simulation results.

Parameters:
plot_individualOptional[bool], default=False

If True, return figures for individual metrics. Otherwise, return a single figure for all metrics.

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.