CalibrationAlgorithm¶
- class CalibrationAlgorithm(*args)¶
Base class for calibration algorithms.
- Parameters:
- outputObservations2-d sequence of float
The output data to be fitted.
- prior
Distribution
The prior distribution of the parameter
See also
Methods
Accessor to the object's name.
getId
()Accessor to the object's id.
Accessor to the underlying implementation.
getName
()Accessor to the object's name.
Accessor to the output data to be fitted.
Accessor to the parameter prior distribution.
Get the result structure.
run
()Launch the algorithm.
setName
(name)Accessor to the object's name.
setResult
(result)Accessor to optimization result.
- __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:
- data
Sample
The output data to be fitted.
- data
- getParameterPrior()¶
Accessor to the parameter prior distribution.
- Returns:
- prior
Distribution
The parameter prior distribution.
- prior
- getResult()¶
Get the result structure.
- Returns:
- resCalibration
CalibrationResult
The structure containing all the results of the calibration problem.
- resCalibration
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:
- result
CalibrationResult
Result class.
- result