CalibrationAlgorithm

class CalibrationAlgorithm(*args)

Base class for calibration algorithms.

Parameters:

outputObservations2-d sequence of float

The output data to be fitted.

priorDistribution

The prior distribution of the parameter

Methods

getClassName()	Accessor to the object's name.
getId()	Accessor to the object's id.
getImplementation()	Accessor to the underlying implementation.
getName()	Accessor to the object's name.
getOutputObservations()	Accessor to the output data to be fitted.
getParameterPrior()	Accessor to the parameter prior distribution.
getResult()	Get the result structure.
run()	Launch the algorithm.
setName(name)	Accessor to the object's name.
setResult(result)	Accessor to optimization result.

See also

CalibrationResult

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getImplementation()

Accessor to the underlying implementation.

Returns:

implImplementation

A copy of the underlying implementation object.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getOutputObservations()

Accessor to the output data to be fitted.

Returns:

dataSample

The output data to be fitted.

getParameterPrior()

Accessor to the parameter prior distribution.

Returns:

priorDistribution

The parameter prior distribution.

getResult()

Get the result structure.

Returns:

resCalibrationCalibrationResult

The structure containing all the results of the calibration problem.

Notes

The structure contains all the results of the calibration problem.

run()

Launch the algorithm.

Notes

It launches the algorithm and creates a CalibrationResult, structure containing all the results.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setResult(result)

Accessor to optimization result.

Parameters:

resultCalibrationResult

Result class.