darsia.AbstractBalancingCalibration

class AbstractBalancingCalibration

Bases: object

Abstract class for defining an objective function to be called in ConcentrationAnalysis.calibrate_balancing().

Methods

calibrate_balancing(images, options)	Utility for calibrating the balancing used in darsia.ConcentrationAnalysis.
optimize_balancing(input_images, ...)	Abstract method to define an objective function.
update_balancing_for_calibration(parameters, ...)	Wrapper for updating the balancing (provided as a model), depending on whether it is a single model or a combined model.

calibrate_balancing(images, options)

Utility for calibrating the balancing used in darsia.ConcentrationAnalysis.

NOTE: Require to combine darsia.ConcentrationAnalysis with a calibration model mixin via multiple inheritance.

Parameters:

imageslist of darsia.Image

Calibration images.

optionsdict

Container holding tuning information for the numerical calibration routine.

Returns:

bool

Success of the calibration study.

abstractmethod optimize_balancing(input_images, images_diff, relative_times, options)

Abstract method to define an objective function.

Returns:

callable()

Objective function.

update_balancing_for_calibration(parameters, options)

Wrapper for updating the balancing (provided as a model), depending on whether it is a single model or a combined model.

Parameters:

parametersnp.ndarray

Model parameters,

optionsdict

Further tuning parameters and extra info.