SRCResult

class persalys.SRCResult(*args)

Get the results of a SRC sensitivity analysis.

Methods

getCallsNumber()	Number of calls accessor.
getClassName()	Accessor to the object's name.
getDesignOfExperiment()	Design of experiments accessor.
getElapsedTime()	Elapsed time in seconds to perform the analysis.
getIndices()	SRC indices accessor.
getIndicesInterval()	SRC indices confidence interval accessor.
getInputNames()	Input variable names accessor.
getName()	Accessor to the object's name.
getOutputNames()	Output variable names accessor.
getR2()	R² coefficient accessor.
getSignedIndices()	Signed SRC indices accessor.
getSignedIndicesInterval()	Signed SRC indices confidence interval accessor.
hasName()	Test if the object is named.
setDesignOfExperiment(doe)	Design of experiments accessor.
setName(name)	Accessor to the object's name.

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

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

getIndices()

SRC indices accessor.

Returns:

indicesopenturns.Point

SRC indices

getIndicesInterval()

SRC indices confidence interval accessor.

Returns:

intervalsequence of openturns.Interval

SRC indices confidence interval

getInputNames()

Input variable names accessor.

Returns:

sampleopenturns.Description

Input variable names

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getOutputNames()

Output variable names accessor.

Returns:

sampleopenturns.Description

Output variable names

getR2()

R² coefficient accessor.

Returns:

r2openturns.Point

R² coefficient for each output variable

getSignedIndices()

Signed SRC indices accessor.

Returns:

indicesopenturns.Point

Signed SRC indices

getSignedIndicesInterval()

Signed SRC indices confidence interval accessor.

Returns:

intervalsequence of openturns.Interval

Signed SRC indices confidence 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.