CopulaInferenceSetResult

class persalys.CopulaInferenceSetResult(*args)

Dependence inference result for a set of variables.

Methods

getBICResults()
getClassName() Accessor to the object’s name.
getErrorMessages() Get the sequence of error messages.
getId() Accessor to the object’s id.
getKendallPlotData() Data of the Kendall plot.
getName() Accessor to the object’s name.
getSetOfVariablesNames() Set of variables names accessor.
getShadowedId() Accessor to the object’s shadowed id.
getTestedDistributions() Get the sequence of tested distributions.
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)
getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getErrorMessages()

Get the sequence of error messages.

Returns:

messages : sequence of openturns.Description

Error message for each tested distributions. The error message is empty if the distribution has been well tested

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getKendallPlotData()

Data of the Kendall plot.

Returns:

data : 2D sequence of openturns.Sample

Data of the Kendall plot for each tested distribution and for each pair of variables

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getSetOfVariablesNames()

Set of variables names accessor.

Returns:

names : openturns.Description

Set of variables names

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getTestedDistributions()

Get the sequence of tested distributions.

Returns:

distributions : sequence of openturns.Distribution

Tested distributions

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.