MetaModelAlgorithm

class MetaModelAlgorithm(*args)

Base class to compute a metamodel.

Available constructor:
MetaModelAlgorithm(distribution, model)
Parameters:
distribution : Distribution

Joint probability density function of the physical input vector.

model : Function

Physical model to be approximated by a metamodel.

Notes

A MetaModelAlgorithm object can be used only through its derived classes:

Methods

getClassName() Accessor to the object’s name.
getDistribution() Accessor to the joint probability density function of the physical input vector.
getId() Accessor to the object’s id.
getInputSample() Accessor to the input sample.
getName() Accessor to the object’s name.
getOutputSample() Accessor to the output sample.
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.
run() Compute the response surfaces.
setDistribution(distribution) Accessor to the joint probability density function of the physical input vector.
setName(name) Accessor to the object’s name.
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__).
getDistribution()

Accessor to the joint probability density function of the physical input vector.

Returns:
distribution : Distribution

Joint probability density function of the physical input vector.
getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.
getInputSample()

Accessor to the input sample.

Returns:
inputSample : Sample

Input sample of a model evaluated apart.
getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.
getOutputSample()

Accessor to the output sample.

Returns:
outputSample : Sample

Output sample of a model evaluated apart.
getShadowedId()

Accessor to the object’s shadowed id.

Returns:
id : int

Internal unique identifier.
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.
run()

Compute the response surfaces.

Notes

It computes the response surfaces and creates a MetaModelResult structure containing all the results.

setDistribution(distribution)

Accessor to the joint probability density function of the physical input vector.

Parameters:
distribution : Distribution

Joint probability density function of the physical input vector.
setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.
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.