SobolResult

class persalys.SobolResult(*args)

Get the results of a Sobol sensitivity analysis.

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.
getInputNames()	Input variables names accessor.
getName()	Accessor to the object's name.
getOutputNames()	Output variables names accessor.
getTotalIndices()	Total indices accessor.
getTotalIndicesInterval()	Total indices interval accessor.
hasName()	Test if the object is named.
setDesignOfExperiment(doe)	Design of experiments accessor.
setName(name)	Accessor to the object's name.

getAggregatedFirstOrderIndices
getAggregatedFirstOrderIndicesInterval
getAggregatedTotalIndices
getAggregatedTotalIndicesInterval

__init__(*args)

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

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

getTotalIndices()

Total indices accessor.

Returns:

indicesopenturns.Sample

Total indices

getTotalIndicesInterval()

Total indices interval accessor.

Returns:

intervalsequence of openturns.Interval

Total indices interval

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

setDesignOfExperiment(doe)

Design of experiments accessor.

Parameters:

doe: :class:`~persalys.DesignOfExperiment`

Design od experiments to be used

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.