FieldMonteCarloResult

class persalys.FieldMonteCarloResult(*args)

Get the results of a Monte Carlo analysis with mesh.

Methods

getClassName(self)

Accessor to the object’s name.

getCorrelationFunction(self)

Correlation function accessor.

getDesignOfExperiment(self)

Design of experiments accessor.

getElapsedTime(self)

Elapsed time in seconds to perform the analysis.

getId(self)

Accessor to the object’s id.

getLowerQuantileSample(self)

Lower quantile accessor.

getMeanSample(self)

Mean trajectory accessor.

getName(self)

Accessor to the object’s name.

getProcessSample(self)

Output values accessor.

getShadowedId(self)

Accessor to the object’s shadowed id.

getUpperQuantileSample(self)

Upper quantile accessor.

getVisibility(self)

Accessor to the object’s visibility state.

getXiSamples(self)

X_i distribution values accessor.

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.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

getKarhunenLoeveResults

__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__).

getCorrelationFunction(self)

Correlation function accessor.

Returns
functionssequence of openturns.Function

Correlation function for each output

getDesignOfExperiment(self)

Design of experiments accessor.

Returns
designDesignOfExperiment

Design of experiments containing the analysed points

getElapsedTime(self)

Elapsed time in seconds to perform the analysis.

Returns
timedouble

Elapsed time in seconds to perform the analysis

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getLowerQuantileSample(self)

Lower quantile accessor.

Returns
sampleopenturns.Sample

Lower quantile trajectory for each output at level defined in persalys.FieldMonteCarloAnalysis.getQuantileLevel()

getMeanSample(self)

Mean trajectory accessor.

Returns
sampleopenturns.Sample

Mean trajectory for each output

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getProcessSample(self)

Output values accessor.

Returns
sampleopenturns.ProcessSample

Output values

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getUpperQuantileSample(self)

Upper quantile accessor.

Returns
sampleopenturns.Sample

Upper quantile trajectory for each output at 1-level defined in persalys.FieldMonteCarloAnalysis.getQuantileLevel()

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

getXiSamples(self)

X_i distribution values accessor.

Returns
samplessequence of openturns.Sample

Distribution values of the X_i variables of the Karhunen Loeve decomposition

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.

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.