CADETProcess.comparison.Comparator.add_difference_metric

Comparator.add_difference_metric(reference: ReferenceBase, components: dict[str, list] | None = None, use_total_concentration: bool = False, use_total_concentration_components: bool = True, start: float | None = None, end: float | None = None, transform: Callable | None = None, only_transforms_array: bool = True, resample: bool = True, smooth: bool = False, normalize: bool = False) → None

Initialize an instance of DifferenceBase.

Parameters:

referenceReferenceBase

Reference used for calculating difference metric.

components{str, list}, optional

Solution components to be considered. If None, all components are considered. The default is None.

use_total_concentrationbool, optional

If True, use sum of all components. The default is False.

use_total_concentration_componentsbool, optional

If True, sum concentration of species. The default is True.

startfloat, optional

End time of solution slice to be considerd. The default is None.

endfloat, optional

End time of solution slice to be considerd. The default is None.

transformcallable, optional

Function to transform solution. The default is None.

only_transforms_array: bool, optional

If True, only transform np array of solution object. The default is True.

resamplebool, optional

If True, resample data. The default is True.

smoothbool, optional

If True, smooth data. The default is False.

normalizebool, optional

If True, normalize data. The default is False.