SRCResult

class persalys.SRCResult(*args)

Get the results of a SRC sensitivity analysis.

Methods

getCallsNumber()
getClassName() Accessor to the object’s name.
getDesignOfExperiment() Design of experiments accessor.
getElapsedTime() Elapsed time in seconds to perform the analysis.
getId() Accessor to the object’s id.
getIndices() SRC indices accessor.
getIndicesInterval()
getInputNames() Input variable names accessor.
getName() Accessor to the object’s name.
getOutputNames() Output variable names accessor.
getR2()
getShadowedId() Accessor to the object’s shadowed id.
getSignedIndices()
getSignedIndicesInterval()
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.
__init__(*args)
getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getDesignOfExperiment()

Design of experiments accessor.

Returns:

design : DesignOfExperiment

Design of experiments containing the analysed points

getElapsedTime()

Elapsed time in seconds to perform the analysis.

Returns:

time : double

Elapsed time in seconds to perform the analysis

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getIndices()

SRC indices accessor.

Returns:

indices : openturns.Point

SRC indices

getInputNames()

Input variable names accessor.

Returns:

sample : openturns.Description

Input variable names

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getOutputNames()

Output variable names accessor.

Returns:

sample : openturns.Description

Output variable names

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.

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.