# FunctionalChaosResult¶

class FunctionalChaosResult(*args)

Functional chaos result.

Notes

Structure created by the method run() of FunctionalChaosAlgorithm, and obtained thanks to the method getResult().

Methods

 getClassName() Accessor to the object’s name. getCoefficients() Get the coefficients. getComposedMetaModel() Get the composed metamodel. getComposedModel() Get the composed model. getDistribution() Get the input distribution. getId() Accessor to the object’s id. getIndices() Get the indices of the final basis. getInverseTransformation() Get the inverse isoprobabilistic transformation. getMetaModel() Accessor to the metamodel. getModel() Accessor to the model. getName() Accessor to the object’s name. getOrthogonalBasis() Get the orthogonal basis. getReducedBasis() Get the reduced basis. getRelativeErrors() Accessor to the relative errors. getResiduals() Accessor to the residuals. getShadowedId() Accessor to the object’s shadowed id. getTransformation() Get the isoprobabilistic transformation. getVisibility() Accessor to the object’s visibility state. hasName() Test if the object is named. hasVisibleName() Test if the object has a distinguishable name. setMetaModel(metaModel) Accessor to the metamodel. setModel(model) Accessor to the model. setName(name) Accessor to the object’s name. setRelativeErrors(relativeErrors) Accessor to the relative errors. setResiduals(residuals) Accessor to the residuals. setShadowedId(id) Accessor to the object’s shadowed id. setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName()

Accessor to the object’s name.

Returns: class_name : str The object class name (object.__class__.__name__).
getCoefficients()

Get the coefficients.

Returns: coefficients : 2-d sequence of float Coefficients .
getComposedMetaModel()

Get the composed metamodel.

Returns: composedMetamodel : Function
getComposedModel()

Get the composed model.

Returns: composedModel : Function .
getDistribution()

Get the input distribution.

Returns: distribution : Distribution Distribution of the input random vector .
getId()

Accessor to the object’s id.

Returns: id : int Internal unique identifier.
getIndices()

Get the indices of the final basis.

Returns: indices : Indices Indices of the elements of the multivariate basis used in the decomposition.
getInverseTransformation()

Get the inverse isoprobabilistic transformation.

Returns: invTransf : Function such that .
getMetaModel()

Accessor to the metamodel.

Returns: metaModel : Function Metamodel.
getModel()

Accessor to the model.

Returns: model : Function Physical model approximated by a metamodel.
getName()

Accessor to the object’s name.

Returns: name : str The name of the object.
getOrthogonalBasis()

Get the orthogonal basis.

Returns: basis : OrthogonalBasis Factory of the orthogonal basis.
getReducedBasis()

Get the reduced basis.

Returns: basis : list of Function Collection of the K functions used in the decomposition.
getRelativeErrors()

Accessor to the relative errors.

Returns: relativeErrors : Point The relative errors defined as follows for each output of the model: with the vector of the model’s values and the metamodel’s values.
getResiduals()

Accessor to the residuals.

Returns: residuals : Point The residual values defined as follows for each output of the model: with the model’s values and the metamodel’s values.
getShadowedId()

Accessor to the object’s shadowed id.

Returns: id : int Internal unique identifier.
getTransformation()

Get the isoprobabilistic transformation.

Returns: transformation : Function Transformation such that .
getVisibility()

Accessor to the object’s visibility state.

Returns: visible : bool Visibility flag.
hasName()

Test if the object is named.

Returns: hasName : bool True if the name is not empty.
hasVisibleName()

Test if the object has a distinguishable name.

Returns: hasVisibleName : bool True if the name is not empty and not the default one.
setMetaModel(metaModel)

Accessor to the metamodel.

Parameters: metaModel : Function Metamodel.
setModel(model)

Accessor to the model.

Parameters: model : Function Physical model approximated by a metamodel.
setName(name)

Accessor to the object’s name.

Parameters: name : str The name of the object.
setRelativeErrors(relativeErrors)

Accessor to the relative errors.

Parameters: relativeErrors : sequence of float The relative errors defined as follows for each output of the model: with the vector of the model’s values and the metamodel’s values.
setResiduals(residuals)

Accessor to the residuals.

Parameters: residuals : sequence of float The residual values defined as follows for each output of the model: with the model’s values and the metamodel’s values.
setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters: id : int Internal unique identifier.
setVisibility(visible)

Accessor to the object’s visibility state.

Parameters: visible : bool Visibility flag.