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()

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.

getInputsSelection(marginal)

Input selection accessor.

getName()

Accessor to the object's name.

getNoEffectBoundary(marginal)

No effect boundary accessor.

getShadowedId()

Accessor to the object's shadowed id.

getVisibility()

Accessor to the object's visibility state.

hasName()

Test if the object is named.

hasVisibleName()

Test if the object has a distinguishable name.

setInputsSelection(marginal, values)

Input selection accessor.

setName(name)

Accessor to the object's name.

setNoEffectBoundary(marginal, value)

No effect boundary accessor.

setShadowedId(id)

Accessor to the object's shadowed id.

setVisibility(visible)

Accessor to the object's visibility state.

getMeanAbsoluteElementaryEffects

getMeanElementaryEffects

getStandardDeviationElementaryEffects

__init__(*args)
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

getId()

Accessor to the object’s id.

Returns:
idint

Internal unique identifier.

getInputsSelection(marginal)

Input selection accessor.

Parameters:
marginalint

Output marginal of interest

Returns:
selectionopenturns.Indices

Whether the inputs are selected

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getNoEffectBoundary(marginal)

No effect boundary accessor.

Parameters:
marginalint

Output marginal of interest

Returns:
boundaryfloat

No effect boundary

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
idint

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleNamebool

True if the name is not empty and not the default one.

setInputsSelection(marginal, values)

Input selection accessor.

Parameters:
marginalpositive int

Output marginal of interest

selectionopenturns.Indices

Whether the inputs are selected

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

setNoEffectBoundary(marginal, value)

No effect boundary accessor.

Parameters:
marginalpositive int

Output marginal of interest

boundaryfloat

No effect boundary

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visiblebool

Visibility flag.