darsia.AbstractModelObjective

class AbstractModelObjective

Bases: object

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

Methods

calibrate_model(images, options[, plot_result])	Utility for calibrating the model used in darsia.ConcentrationAnalysis.
define_objective_function(input_images, ...)	Abstract method to define an objective function.
update_model_for_calibration(parameters, options)	Wrapper for updating the model, depending on whether it is a single model or a combined model.

calibrate_model(images, options, plot_result=False)

Utility for calibrating the model 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.

plot_resultbool

Flag controlling whether the calibration is displayed in a plot.

Returns:

bool

Success of the calibration study.

abstractmethod define_objective_function(input_images, images_diff, times, options)

Abstract method to define an objective function.

Returns:

callable()

Objective function.

update_model_for_calibration(parameters, options)

Wrapper for updating the 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; here, the key “dofs” is used to determine which dofs to update.