SRCResult

class persalys.SRCResult(*args)

Get the results of a SRC sensitivity analysis.

Methods

getClassName(self)

Accessor to the object’s name.

getDesignOfExperiment(self)

Design of experiments accessor.

getElapsedTime(self)

Elapsed time in seconds to perform the analysis.

getId(self)

Accessor to the object’s id.

getIndices(self)

SRC indices accessor.

getInputNames(self)

Input variable names accessor.

getName(self)

Accessor to the object’s name.

getOutputNames(self)

Output variable names accessor.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

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.

getCallsNumber

getIndicesInterval

getR2

getSignedIndices

getSignedIndicesInterval

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

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.

getIndices(self)

SRC indices accessor.

Returns
indicesopenturns.Point

SRC indices

getInputNames(self)

Input variable names accessor.

Returns
sampleopenturns.Description

Input variable names

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getOutputNames(self)

Output variable names accessor.

Returns
sampleopenturns.Description

Output variable names

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

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.