SobolResult¶
-
class
persalys.SobolResult(*args)¶ Get the results of a Sobol sensitivity analysis.
Methods
getCallsNumber(self)Number of calls accessor.
getClassName(self)Accessor to the object’s name.
Confidence interval length accessor.
getDesignOfExperiment(self)Design of experiments accessor.
getElapsedTime(self)Elapsed time in seconds to perform the analysis.
getFirstOrderIndices(self)First order indices accessor.
First order indices interval accessor.
getId(self)Accessor to the object’s id.
getInputNames(self)Input variables names accessor.
getName(self)Accessor to the object’s name.
getOutputNames(self)Output variables names accessor.
getShadowedId(self)Accessor to the object’s shadowed id.
getTotalIndices(self)Total indices accessor.
getTotalIndicesInterval(self)Total indices interval accessor.
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.
getAggregatedFirstOrderIndices
getAggregatedFirstOrderIndicesInterval
getAggregatedTotalIndices
getAggregatedTotalIndicesInterval
-
__init__(self, *args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getCallsNumber(self)¶ Number of calls accessor.
- Returns
- callsint
Number of function calls
-
getClassName(self)¶ Accessor to the object’s name.
- Returns
- class_namestr
The object class name (object.__class__.__name__).
-
getConfidenceIntervalLength(self)¶ Confidence interval length accessor.
- Returns
- lengthfloat
Maximum confidence interval length of all components and both indices
-
getDesignOfExperiment(self)¶ Design of experiments accessor.
- Returns
- design
DesignOfExperiment Design of experiments containing the analysed points
- design
-
getElapsedTime(self)¶ Elapsed time in seconds to perform the analysis.
- Returns
- timedouble
Elapsed time in seconds to perform the analysis
-
getFirstOrderIndices(self)¶ First order indices accessor.
- Returns
- indices
openturns.Sample First order indices
- indices
-
getFirstOrderIndicesInterval(self)¶ First order indices interval accessor.
- Returns
- intervalsequence of
openturns.Interval First order indices interval
- intervalsequence of
-
getId(self)¶ Accessor to the object’s id.
- Returns
- idint
Internal unique identifier.
-
getInputNames(self)¶ Input variables names accessor.
- Returns
- sample
openturns.Description Input variables names
- sample
-
getName(self)¶ Accessor to the object’s name.
- Returns
- namestr
The name of the object.
-
getOutputNames(self)¶ Output variables names accessor.
- Returns
- sample
openturns.Description Output variables names
- sample
-
getShadowedId(self)¶ Accessor to the object’s shadowed id.
- Returns
- idint
Internal unique identifier.
-
getTotalIndices(self)¶ Total indices accessor.
- Returns
- indices
openturns.Sample Total indices
- indices
-
getTotalIndicesInterval(self)¶ Total indices interval accessor.
- Returns
- intervalsequence of
openturns.Interval Total indices interval
- intervalsequence of
-
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.
-
