QuantileAnalysisResult

class persalys.QuantileAnalysisResult(*args)

Get the results of a quantile analysis.

Methods

getClassName()	Accessor to the object's name.
getDesignOfExperiment()	Design of experiments accessor.
getName()	Accessor to the object's name.
getPValue(varName, tailType)	P-value accessor.
getQuantiles(varName)	Quantile accessor.
getType()	Type accessor.
getWilksValidity(varName, tailType)	Validity accessor.
hasName()	Test if the object is named.
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

designDesignOfExperiment

Design of experiments containing the analysed points

getName()

Accessor to the object’s name.

Returns

namestr

The name of the object.

getPValue(varName, tailType)

P-value accessor.

Parameters

varNamestr

Name of the marginal

tailTypeenum

Tail type, either persalys.QuantileAnalysisResult.Lower or persalys.QuantileAnalysisResult.Upper.

Returns

p-valuedouble

P-value for the corresponding marginal and tail.

getQuantiles(varName)

Quantile accessor.

Parameters

varNamestr

Name of the marginal

Returns

quantileopenturns.SampleCollection

Each item in the collection contains the quantiles for a given tail type, each point in each item contains the quantile and its confidence interval for a given target probability.

getType()

Type accessor.

Returns

typeenum

Analysis type, either persalys.QuantileAnalysisResult.MonteCarlo or persalys.QuantileAnalysisResult.GeneralizedPareto.

getWilksValidity(varName, tailType)

Validity accessor.

Parameters

varNamestr

Name of the marginal

tailTypeenum

Tail type, either persalys.QuantileAnalysisResult.Lower, persalys.QuantileAnalysisResult.Upper or persalys.QuantileAnalysisResult.Bilateral.

Returns

validityopenturns.Interval.BoolCollection

Indicates for each target probability if the quantile is valid or not.

hasName()

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.