SobolResult

class persalys.SobolResult(*args)

Get the results of a Sobol sensitivity analysis.

Attributes

thisown

The membership flag

Methods

getCallsNumber()	Number of calls accessor.
getClassName()	Accessor to the object’s name.
getConfidenceIntervalLength()	Confidence interval length accessor.
getDesignOfExperiment()	Design of experiments accessor.
getElapsedTime()	Elapsed time in seconds to perform the analysis.
getFirstOrderIndices()	First order indices accessor.
getFirstOrderIndicesInterval()	First order indices interval accessor.
getId()	Accessor to the object’s id.
getInputNames()	Input variables names accessor.
getName()	Accessor to the object’s name.
getOutputNames()	Output variables names accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getTotalIndices()	Total indices accessor.
getTotalIndicesInterval()	Total indices interval accessor.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
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.

getAggregatedFirstOrderIndices
getAggregatedFirstOrderIndicesInterval
getAggregatedTotalIndices
getAggregatedTotalIndicesInterval

__init__(*args)

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

getCallsNumber()

Number of calls accessor.

Returns

callsint

Number of function calls

getClassName()

Accessor to the object’s name.

Returns

class_namestr

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

getConfidenceIntervalLength()

Confidence interval length accessor.

Returns

lengthfloat

Maximum confidence interval length of all components and both indices

getDesignOfExperiment()

Design of experiments accessor.

Returns

designDesignOfExperiment

Design of experiments containing the analysed points

getElapsedTime()

Elapsed time in seconds to perform the analysis.

Returns

timedouble

Elapsed time in seconds to perform the analysis

getFirstOrderIndices()

First order indices accessor.

Returns

indicesopenturns.Sample

First order indices

getFirstOrderIndicesInterval()

First order indices interval accessor.

Returns

intervalsequence of openturns.Interval

First order indices interval

getId()

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getInputNames()

Input variables names accessor.

Returns

sampleopenturns.Description

Input variables names

getName()

Accessor to the object’s name.

Returns

namestr

The name of the object.

getOutputNames()

Output variables names accessor.

Returns

sampleopenturns.Description

Output variables names

getShadowedId()

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getTotalIndices()

Total indices accessor.

Returns

indicesopenturns.Sample

Total indices

getTotalIndicesInterval()

Total indices interval accessor.

Returns

intervalsequence of openturns.Interval

Total indices interval

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.

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

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.

property thisown

The membership flag