CADETProcess.comparison.Comparator

class CADETProcess.comparison.Comparator(name)

Class for comparing simulation results against reference data.

Attributes:

namestr

Name of the Comparator instance.

referencesdict

Dictionary containing the reference data to be compared against.

solution_pathsdict

Dictionary containing the solution path for each difference metric.

metricslist

list: List of difference metrics.

Methods

__call__(simulation_results)	Evaluate all metrics for a given simulation and return the results as a list.
add_difference_metric(reference[, ...])	Initialize an instance of DifferenceBase.
add_reference(reference[, update, smooth])	Add Reference to Comparator.
check_required_parameters()	Verify if all required parameters are set.
evaluate(simulation_results)	Evaluate all metrics for a given simulation and return the results as a list.
extract_solution(simulation_results, metric)	Extract the solution for a given metric from the SimulationResults object.
plot_comparison(simulation_results[, axs, ...])	Plot the comparison of the simulation results with the reference data.
setup_comparison_figure([plot_individual])	Set up a figure for comparing simulation results.