OpenTURNS
CalibrationResult¶
-
class
CalibrationResult(*args)¶ Calibration result.
Returned by calibration algorithms, see
CalibrationAlgorithm.- Parameters
- parameterPrior
Distribution The prior distribution of the parameter.
- parameterPosterior
Distribution The posterior distribution of the parameter.
- parameterMapsequence of float
The maximum a posteriori estimate of the parameter.
- observationsError
Distribution The distribution of the observations error.
- outputObservations
Sample The sample of output observations.
- residualFunction
Function The residual function.
- parameterPrior
Notes
The residual function returns model(inputObservations) - outputObservations.
Methods
getClassName(self)Accessor to the object’s name.
getId(self)Accessor to the object’s id.
getName(self)Accessor to the object’s name.
getObservationsError(self)Accessor to the observations error distribution.
getOutputObservations(self)Accessor to the output observations.
getParameterMAP(self)Accessor to the maximum a posteriori parameter estimate.
getParameterPosterior(self)Accessor to the parameter posterior distribution.
getParameterPrior(self)Accessor to the parameter prior distribution.
getResidualFunction(self)Accessor to the residual function.
getShadowedId(self)Accessor to the object’s shadowed id.
getVisibility(self)Accessor to the object’s visibility state.
hasName(self)Test if the object is named.
hasVisibleName(self)Test if the object has a distinguishable name.
setName(self, name)Accessor to the object’s name.
setObservationsError(self, observationsError)Accessor to the observations error distribution.
setOutputObservations(self, outputObservations)Accessor to the output observations.
setParameterMAP(self, parameterMAP)Accessor to the maximum a posteriori parameter estimate.
setParameterPosterior(self, parameterPosterior)Accessor to the parameter posterior distribution.
setParameterPrior(self, parameterPrior)Accessor to the parameter prior distribution.
setResidualFunction(self, residualFunction)Accessor to the residual function.
setShadowedId(self, id)Accessor to the object’s shadowed id.
setVisibility(self, visible)Accessor to the object’s visibility state.
-
__init__(self, \*args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getId(self)¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getName(self)¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getObservationsError(self)¶ Accessor to the observations error distribution.
- Returns
- observationsError
Distribution The observations error distribution.
- observationsError
-
getOutputObservations(self)¶ Accessor to the output observations.
- Returns
- outputObservations
Sample The sample of output observations.
- outputObservations
-
getParameterMAP(self)¶ Accessor to the maximum a posteriori parameter estimate.
- Returns
- parameterPosterior
Point The maximum a posteriori parameter estimate.
- parameterPosterior
-
getParameterPosterior(self)¶ Accessor to the parameter posterior distribution.
- Returns
- parameterPosterior
Distribution The posterior distribution of the parameter.
- parameterPosterior
-
getParameterPrior(self)¶ Accessor to the parameter prior distribution.
- Returns
- parameterPrior
Distribution The prior distribution of the parameter.
- parameterPrior
-
getResidualFunction(self)¶ Accessor to the residual function.
- Returns
- residualFunction
Function The residual function.
- residualFunction
-
getShadowedId(self)¶ Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
-
getVisibility(self)¶ Accessor to the object’s visibility state.
- Returns
- visiblebool
Visibility flag.
-
hasName(self)¶ Test if the object is named.
- Returns
- hasNamebool
True if the name is not empty.
-
hasVisibleName(self)¶ Test if the object has a distinguishable name.
- Returns
- hasVisibleNamebool
True if the name is not empty and not the default one.
-
setName(self, name)¶ Accessor to the object’s name.
- Parameters
- namestr
The name of the object.
-
setObservationsError(self, observationsError)¶ Accessor to the observations error distribution.
- Parameters
- observationsError
Distribution The observations error distribution.
- observationsError
-
setOutputObservations(self, outputObservations)¶ Accessor to the output observations.
- Parameters
- outputObservations
Sample The sample of output observations.
- outputObservations
-
setParameterMAP(self, parameterMAP)¶ Accessor to the maximum a posteriori parameter estimate.
- Parameters
- parameterPosteriorsequence of float
The maximum a posteriori parameter estimate.
-
setParameterPosterior(self, parameterPosterior)¶ Accessor to the parameter posterior distribution.
- Parameters
- parameterPosterior:
Distribution The posterior distribution of the parameter.
- parameterPosterior:
-
setParameterPrior(self, parameterPrior)¶ Accessor to the parameter prior distribution.
- Parameters
- parameterPrior:
Distribution The prior distribution of the parameter.
- parameterPrior:
-
setResidualFunction(self, residualFunction)¶ Accessor to the residual function.
- Parameters
- residualFunction
Function The residual function.
- residualFunction
-
setShadowedId(self, id)¶ Accessor to the object’s shadowed id.
- Parameters
- idint
Internal unique identifier.
-
setVisibility(self, visible)¶ Accessor to the object’s visibility state.
- Parameters
- visiblebool
Visibility flag.