CADETProcess.stationarity.StationarityEvaluator

CADETProcess.stationarity.StationarityEvaluator#

class CADETProcess.stationarity.StationarityEvaluator(name)[source]#

Class for checking two succeding chromatograms for stationarity.

Attributes:
aggregated_parameters

dict: Aggregated parameters of the instance.

bad_metrics

list: Worst case metrics for all difference metrics.

criteria

list: List of criteria.

labels

list: List of metric labels.

metrics

list: List of difference metrics.

missing_parameters

list: Parameters that are required but not set.

n_diffference_metrics

int: Number of difference metrics in the Comparator.

n_metrics

int: Number of metrics to be evaluated.

name
parameters

dict: Parameters of the instance.

polynomial_parameters

dict: Polynomial parameters of the instance.

required_parameters

list: Parameters that have no default value.

sized_parameters

dict: Sized parameters of the instance.

Methods

__call__(simulation_results)

Evaluate all metrics for a given simulation and return the results as a list.

add_criterion(criterion)

Add a criterion to the list of criteria.

add_difference_metric(reference[, ...])

Initialize an instance of DifferenceBase.

add_reference(reference[, update, smooth])

Add Reference to Comparator.

assert_stationarity(simulation_results)

Check stationarity of two succeeding cycles.

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.