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

computeHSICPValuesAsymptotic(hsicType)	Whether asymptotic p-values for HSIC indices of the given type were computed.
computeHSICPValuesPermutation(hsicType)	Whether permutation p-values for HSIC indices of the given type were computed.
getClassName()	Accessor to the object's name.
getDesignOfExperiment()	Design of experiments accessor.
getElapsedTime()	Elapsed time in seconds to perform the analysis.
getFirstOrderSobolIndices()	Get the first order Sobol' indices.
getFirstOrderSobolIndicesInterval()	Get the confidence intervals for the first order Sobol' indices.
getHSICIndices(hsicType)	Get the HSIC indices of the given type.
getIndependenceWarningMessage()	Get the warning message if the input variables are not independent.
getInterestVariables()	Get the variables of interest for the sensitivity analysis.
getName()	Accessor to the object's name.
getPValuesAsymptotic(hsicType)	Get the asymptotic p-values for the HSIC indices of the given type.
getPValuesPermutation(hsicType)	Get the permutation p-values for the HSIC indices of the given type.
getR2()	Get the R² values of the linear regression models used to compute SRC indices.
getR2HSICIndices(hsicType)	Get the R2-HSIC indices of the given type.
getSRCIndices()	Get the Standardized Regression Coefficients (SRC) indices.
getSRCIndicesInterval()	Get the confidence intervals for the Standardized Regression Coefficients (SRC) indices.
getSignedSRCIndices()	Get the signed Standardized Regression Coefficients (SRC) indices.
getSignedSRCIndicesInterval()	Get the confidence intervals for the signed Standardized Regression Coefficients (SRC) indices.
hasName()	Test if the object is named.
isIndependent()	Performs Spearman test to check if the input variables are independent.
setDesignOfExperiment(doe)	Design of experiments accessor.
setName(name)	Accessor to the object's name.

__init__(*args)

computeHSICPValuesAsymptotic(hsicType)

Whether asymptotic p-values for HSIC indices of the given type were computed.

Parameters:

hsicTypeint

Type of HSIC indices (Global, Target or Conditional).

Returns:

computebool

True if asymptotic p-values were computed, false otherwise.

computeHSICPValuesPermutation(hsicType)

Whether permutation p-values for HSIC indices of the given type were computed.

Parameters:

hsicTypeint

Type of HSIC indices (Global, Target or Conditional).

Returns:

computebool

True if permutation p-values were computed, false otherwise.

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

getFirstOrderSobolIndices()

Get the first order Sobol’ indices.

Returns:

indicessequence of openturns.Point

First order sensitivity indices for each output.

getFirstOrderSobolIndicesInterval()

Get the confidence intervals for the first order Sobol’ indices.

Returns:

intervalssequence of openturns.Interval

Confidence intervals for the first order sensitivity indices.

getHSICIndices(hsicType)

Get the HSIC indices of the given type.

Parameters:

hsicTypeint

Type of HSIC indices (Global, Target or Conditional).

Returns:

indicessequence of openturns.Point

HSIC indices for each output.

getIndependenceWarningMessage()

Get the warning message if the input variables are not independent.

Returns:

messagestr

Warning message about input independence.

getInterestVariables()

Get the variables of interest for the sensitivity analysis.

Returns:

interest_variablessequence of str

Variables of interest for the sensitivity analysis.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getPValuesAsymptotic(hsicType)

Get the asymptotic p-values for the HSIC indices of the given type.

Parameters:

hsicTypeint

Type of HSIC indices (Global or Target).

Returns:

p_valuessequence of openturns.Point

Asymptotic p-values for the HSIC indices.

getPValuesPermutation(hsicType)

Get the permutation p-values for the HSIC indices of the given type.

Parameters:

hsicTypeint

Type of HSIC indices (Global, Target or Conditional).

Returns:

p_valuessequence of openturns.Point

Permutation p-values for the HSIC indices.

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.

getR2HSICIndices(hsicType)

Get the R2-HSIC indices of the given type.

Parameters:

hsicTypeint

Type of HSIC indices (Global, Target or Conditional).

Returns:

indicessequence of openturns.Point

R2-HSIC indices for each output.

getSRCIndices()

Get the Standardized Regression Coefficients (SRC) indices.

Returns:

indicesopenturns.Sample

SRC indices for each output.

getSRCIndicesInterval()

Get the confidence intervals for the Standardized Regression Coefficients (SRC) indices.

Returns:

intervalssequence of openturns.Interval

Confidence intervals for the SRC indices.

getSignedSRCIndices()

Get the signed Standardized Regression Coefficients (SRC) indices.

Returns:

indicesopenturns.Sample

Signed SRC indices for each output.

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.

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.

setDesignOfExperiment(doe)

Design of experiments accessor.

Parameters:

doe: :class:`~persalys.DesignOfExperiment`

Design od experiments to be used

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.