KrigingAnalysisResult

class persalys.KrigingAnalysisResult(*args)

Get the results of a Kriging analysis.

Notes

Structure created by the method run() of KrigingAnalysis, and obtained thanks to the method getResult().

Methods

getAnalyticalValidation()	Analytical validation result accessor.
getClassName()	Accessor to the object’s name.
getElapsedTime()	Elapsed time in seconds to perform the analysis.
getId()	Accessor to the object’s id.
getKFoldValidation()	K-Fold validation result accessor.
getKrigingResultCollection()	Sequence of kriging results accessor.
getLeaveOneOutValidation()	Leave-one-out validation result accessor.
getMetaModel()	Metamodel accessor.
getMetaModelOutputSample()	Output sample accessor.
getName()	Accessor to the object’s name.
getOutputSample()	Output sample accessor.
getResultForVariable(variableName)	Get the kriging result of a variable.
getShadowedId()	Accessor to the object’s shadowed id.
getTestSampleValidation()	Test sample validation result accessor.
getValidations()	Validation results accessor.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setName(name)	Accessor to the object’s name.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVisibility(visible)	Accessor to the object’s visibility state.

__init__(*args)

getAnalyticalValidation()

Analytical validation result accessor.

Returns:

validation : persalys.MetaModelValidationResult

Analytical validation result

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

The object class name (object.__class__.__name__).

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.

getKFoldValidation()

K-Fold validation result accessor.

Returns:

validation : persalys.MetaModelValidationResult

K-Fold validation result

getKrigingResultCollection()

Sequence of kriging results accessor.

Returns:

results : sequence of openturns.KrigingResult

The kriging results of all the outputs of interest

getLeaveOneOutValidation()

Leave-one-out validation result accessor.

Returns:

validation : persalys.MetaModelValidationResult

Leave-one-out validation result

getMetaModel()

Metamodel accessor.

Returns:

metamodel : MetaModel

Metamodel

getMetaModelOutputSample()

Output sample accessor.

Returns:

sample : openturns.Sample

Output sample evaluated with the metamodel

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getOutputSample()

Output sample accessor.

Returns:

sample : openturns.Sample

Output sample

getResultForVariable(variableName)

Get the kriging result of a variable.

Parameters:

variable : str

Name of the variable

Returns:

result : py:class:openturns.KrigingResult

The kriging result of the variable

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getTestSampleValidation()

Test sample validation result accessor.

Returns:

validation : persalys.MetaModelValidationResult

Test sample validation result

getValidations()

Validation results accessor.

Returns:

validations : sequence of persalys.MetaModelValidationResult

All the validation results

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.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

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.