DistributionFactoryResult

class DistributionFactoryResult(*args)

Results of distribution estimation.

This class is the result of a distribution estimation through a DistributionFactory.

Parameters

distributionDistribution

The estimated distribution.

parameterDistributionDistribution

The distribution of the parameter.

See also

DistributionFactory

Examples

We demonstrate the method on a Beta Distribution.

Create a sample from a Beta distribution:

>>> import openturns as ot
>>> sample = ot.Beta().getSample(10)
>>> ot.ResourceMap.SetAsUnsignedInteger('DistributionFactory-DefaultBootstrapSize', 100)

Fit a Beta distribution and create a DistributionFactory:

>>> fittedRes = ot.BetaFactory().buildEstimator(sample)

Get the fitted Beta distribution and its parameters:

>>> fittedBeta =  fittedRes.getDistribution()

Get the asymptotic parameters distribution:

>>> paramDist = fittedRes.getParameterDistribution()

Methods

getClassName()	Accessor to the object's name.
getDistribution()	Accessor to the estimated distribution.
getId()	Accessor to the object's id.
getName()	Accessor to the object's name.
getParameterDistribution()	Accessor to the distribution of the parameter.
getShadowedId()	Accessor to the object's shadowed id.
getVisibility()	Accessor to the object's visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setDistribution(distribution)	Accessor to the estimated distribution.
setName(name)	Accessor to the object's name.
setParameterDistribution(parameterDistribution)	Accessor to the distribution of the parameter.
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_namestr

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

getDistribution()

Accessor to the estimated distribution.

Returns

distributionDistribution

The estimated distribution.

getId()

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns

namestr

The name of the object.

getParameterDistribution()

Accessor to the distribution of the parameter.

Returns

parameterDistributionDistribution

The distribution of the parameter.

getShadowedId()

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns

visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool

True if the name is not empty and not the default one.

setDistribution(distribution)

Accessor to the estimated distribution.

Parameters

distributionDistribution

The estimated distribution.

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setParameterDistribution(parameterDistribution)

Accessor to the distribution of the parameter.

Parameters

parameterDistributionDistribution

The distribution of the parameter.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.