FieldFunctionalChaosResult

class FieldFunctionalChaosResult(*args)

Functional metamodel result.

Warning

This class is experimental and likely to be modified in future releases. To use it, import the openturns.experimental submodule.

Parameters:

inputKLResultCollectionsequence of KarhunenLoeveResult

List of input fields decompositions.

fceResultFunctionalChaosResult

Functional chaos decomposition.

outputKLResultCollectionsequence of KarhunenLoeveResult

List of output fields decompositions.

Methods

getBlockIndices()	Accessor to the block indices.
getClassName()	Accessor to the object's name.
getFCEResult()	Accessor to the chaos decomposition.
getFieldMetamodel()	Accessor to the metamodel.
getFieldToPointMetamodel()	Accessor to the metamodel.
getId()	Accessor to the object's id.
getInputKLResultCollection()	Accessor to the input fields decompositions.
getInputProcessSample()	Accessor to the input process sample.
getInputSample()	Accessor to the input sample.
getModesSample()	Accessor to the modes sample.
getName()	Accessor to the object's name.
getOutputKLResultCollection()	Accessor to the output fields decompositions.
getOutputProcessSample()	Accessor to the output process sample.
getOutputSample()	Accessor to the output sample.
getPointToFieldMetamodel()	Accessor to the metamodel.
getShadowedId()	Accessor to the object's shadowed id.
getVisibility()	Accessor to the object's visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setBlockIndices(blockIndices)	Accessor to the block indices.
setInputProcessSample(inputProcessSample)	Accessor to the input process sample.
setInputSample(inputSample)	Accessor to the input sample.
setMetamodel(*args)	Accessor to the metamodel.
setModesSample(modesSample)	Accessor to the modes sample.
setName(name)	Accessor to the object's name.
setOutputProcessSample(outputProcessSample)	Accessor to the output process sample.
setOutputSample(outputSample)	Accessor to the output sample.
setShadowedId(id)	Accessor to the object's shadowed id.
setVisibility(visible)	Accessor to the object's visibility state.

__init__(*args)

getBlockIndices()

Accessor to the block indices.

Returns:

blockIndicesIndicesCollection

Independent components indices.

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

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

getFCEResult()

Accessor to the chaos decomposition.

Returns:

fceResultFunctionalChaosResult

Functional chaos decomposition.

getFieldMetamodel()

Accessor to the metamodel.

Returns:

metamodelFieldFunction

Metamodel function.

getFieldToPointMetamodel()

Accessor to the metamodel.

Returns:

metamodelFieldToPointFunction

Metamodel function.

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getInputKLResultCollection()

Accessor to the input fields decompositions.

Returns:

inputKLResultCollectionCollection of KarhunenLoeveResult

List of input fields decompositions.

getInputProcessSample()

Accessor to the input process sample.

Returns:

inputProcessSampleProcessSample

Input process sample.

getInputSample()

Accessor to the input sample.

Returns:

inputSampleSample

Input values.

getModesSample()

Accessor to the modes sample.

Returns:

modesSample

Projected modes values.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getOutputKLResultCollection()

Accessor to the output fields decompositions.

Returns:

outputKLResultCollectionCollection of KarhunenLoeveResult

List of output fields decompositions.

getOutputProcessSample()

Accessor to the output process sample.

Returns:

outputProcessSampleProcessSample

Output process sample.

getOutputSample()

Accessor to the output sample.

Returns:

outputSampleSample

Ouput values.

getPointToFieldMetamodel()

Accessor to the metamodel.

Returns:

metamodelPointToFieldFunction

Metamodel function.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

idint

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleNamebool

True if the name is not empty and not the default one.

setBlockIndices(blockIndices)

Accessor to the block indices.

Parameters:

blockIndices2-d sequence of int

Independent components indices.

setInputProcessSample(inputProcessSample)

Accessor to the input process sample.

Parameters:

inputProcessSampleProcessSample

Input process sample.

setInputSample(inputSample)

Accessor to the input sample.

Parameters:

inputSampleSample

Input values.

setMetamodel(*args)

Accessor to the metamodel.

Parameters:

metamodelFieldToPointFunction

Metamodel function.

setModesSample(modesSample)

Accessor to the modes sample.

Parameters:

modesSample

Projected modes values.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setOutputProcessSample(outputProcessSample)

Accessor to the output process sample.

Parameters:

outputProcessSampleProcessSample

Output process sample.

setOutputSample(outputSample)

Accessor to the output sample.

Parameters:

outputSampleSample

Ouput values.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visiblebool

Visibility flag.

Examples using the class

Estimate Sobol indices on a field to point function

Estimate Sobol indices on a field to point function