DataSensitivityAnalysisResult¶
- class persalys.DataSensitivityAnalysisResult(*args)¶
Results of a data sensitivity analysis.
Provides access to first order sensitivity indices, their confidence intervals, and information about input independence.
Methods
Accessor to the object's name.
Design of experiments accessor.
Elapsed time in seconds to perform the analysis.
Get the first order Sobol' indices.
Get the confidence intervals for the first order Sobol' indices.
Get the warning message if the input variables are not independent.
getName
()Accessor to the object's name.
getR2
()Get the R² values of the linear regression models used to compute SRC indices.
Get the Standardized Regression Coefficients (SRC) indices.
Get the confidence intervals for the Standardized Regression Coefficients (SRC) indices.
Get the signed Standardized Regression Coefficients (SRC) indices.
Get the confidence intervals for the signed Standardized Regression Coefficients (SRC) indices.
hasName
()Test if the object is named.
Performs Spearman test to check if the input variables are independent.
setName
(name)Accessor to the object's name.
- __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:
- design
DesignOfExperiment
Design of experiments containing the analysed points
- design
- getElapsedTime()¶
Elapsed time in seconds to perform the analysis.
- Returns:
- timedouble
Elapsed time in seconds to perform the analysis
- getFirstOrderSobolIndices()¶
Get the first order Sobol’ indices.
- Returns:
- indicessequence of
openturns.Point
First order sensitivity indices for each output.
- indicessequence of
- getFirstOrderSobolIndicesInterval()¶
Get the confidence intervals for the first order Sobol’ indices.
- Returns:
- intervalssequence of
openturns.Interval
Confidence intervals for the first order sensitivity indices.
- intervalssequence of
- getIndependenceWarningMessage()¶
Get the warning message if the input variables are not independent.
- Returns:
- messagestr
Warning message about input independence.
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getR2()¶
Get the R² values of the linear regression models used to compute SRC indices.
- Returns:
- r2_valuessequence of float
R² values for each output.
- getSRCIndices()¶
Get the Standardized Regression Coefficients (SRC) indices.
- Returns:
- indices
openturns.Sample
SRC indices for each output.
- indices
- getSRCIndicesInterval()¶
Get the confidence intervals for the Standardized Regression Coefficients (SRC) indices.
- Returns:
- intervalssequence of
openturns.Interval
Confidence intervals for the SRC indices.
- intervalssequence of
- getSignedSRCIndices()¶
Get the signed Standardized Regression Coefficients (SRC) indices.
- Returns:
- indices
openturns.Sample
Signed SRC indices for each output.
- indices
- getSignedSRCIndicesInterval()¶
Get the confidence intervals for the signed Standardized Regression Coefficients (SRC) indices.
- Returns:
- intervalssequence of
openturns.Interval
Confidence intervals for the signed SRC indices.
- intervalssequence of
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- isIndependent()¶
Performs Spearman test to check if the input variables are independent.
- Returns:
- isIndependentbool
if False, the input variables are not independent.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.