MorrisResult

class persalys.MorrisResult(*args)

Get the result of a Morris analysis.

Notes

Structure created by the method run() of MorrisAnalysis, and obtained thanks to the method getResult().

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.

getInputsSelection(self, marginal)

Input selection accessor.

getName(self)

Accessor to the object’s name.

getNoEffectBoundary(self, marginal)

No effect boundary 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.

setInputsSelection(self, marginal, values)

Input selection accessor.

setName(self, name)

Accessor to the object’s name.

setNoEffectBoundary(self, marginal, value)

No effect boundary accessor.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

getMeanAbsoluteElementaryEffects

getMeanElementaryEffects

getStandardDeviationElementaryEffects

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

getInputsSelection(self, marginal)

Input selection accessor.

Parameters
marginalint

Output marginal of interest

Returns
selectionopenturns.Indices

Whether the inputs are selected

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getNoEffectBoundary(self, marginal)

No effect boundary accessor.

Parameters
marginalint

Output marginal of interest

Returns
boundaryfloat

No effect boundary

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.

setInputsSelection(self, marginal, values)

Input selection accessor.

Parameters
marginalpositive int

Output marginal of interest

selectionopenturns.Indices

Whether the inputs are selected

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setNoEffectBoundary(self, marginal, value)

No effect boundary accessor.

Parameters
marginalpositive int

Output marginal of interest

boundaryfloat

No effect boundary

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.