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.
getMeanAbsoluteElementaryEffects(outputMarginal)
getMeanElementaryEffects(outputMarginal)
getName()	Accessor to the object’s name.
getNoEffectBoundary(marginal)	No effect boundary accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getStandardDeviationElementaryEffects(…)
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.

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

getInputsSelection(marginal)

Input selection accessor.

Parameters:

marginal : int

Output marginal of interest

Returns:

selection : openturns.Indices

Whether the inputs are selected

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getNoEffectBoundary(marginal)

No effect boundary accessor.

Parameters:

marginal : int

Output marginal of interest

Returns:

boundary : float

No effect boundary

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.

setInputsSelection(marginal, values)

Input selection accessor.

Parameters:

marginal : positive int

Output marginal of interest

selection : openturns.Indices

Whether the inputs are selected

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setNoEffectBoundary(marginal, value)

No effect boundary accessor.

Parameters:

marginal : positive int

Output marginal of interest

boundary : float

No effect boundary

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.