LogNormalMuSigmaOverMu

class LogNormalMuSigmaOverMu(*args)

LogNormal distribution parameters.

Parameters:
mufloat

Mean \mu > 0.

Default value is e^{0.5}.

deltafloat

Variation coefficient \delta = \frac{\sigma}{\mu}.

Default value is (\sqrt{e^{2}-e})e^{-0.5}.

gammafloat, optional

Location parameter.

Default value is 0.0.

See also

LogNormal

Notes

Let X be a random variable that follows a LogNormal distribution such that:

\Expect{X} &= \mu \\ \Var{X} &= \sigma^2

The native parameters of X are \mu_\ell and \sigma_\ell, which are such that \log X follows a normal distribution whose mean is \mu_\ell and whose variance is \sigma_\ell^2. Then we have:

\sigma_l &= \sqrt{\log{ \left(1+\frac{(\delta \mu)^2}{(\mu-\gamma)^2} \right)}}\\ \mu_l &= \log{(\mu-\gamma)} - \frac{\sigma_l^2}{2}

The default values of (\mu, \delta, \gamma) are defined so that the associated native parameters have the default values: (\mu_\ell, \sigma_\ell, \gamma_\ell) = (0.0, 1.0, 0.0).

Examples

Create the parameters of the LogNormal distribution:

>>> import openturns as ot
>>> parameters = ot.LogNormalMuSigmaOverMu(0.63, 5.24, -0.5)

Convert parameters into the native parameters:

>>> print(parameters.evaluate())
[-1.00525,1.50164,-0.5]

The gradient of the transformation of the native parameters into the new parameters:

>>> print(parameters.gradient())
[[  0.256272  0.418663  0        ]
 [ -0.170824  0.113758  0        ]
 [ -1.6771    0.527516  1        ]]

Methods

__call__(inP)

Call self as a function.

evaluate()

Compute native parameters values.

getClassName()

Accessor to the object's name.

getDescription()

Get the description of the parameters.

getDistribution()

Build a distribution based on a set of native parameters.

getId()

Accessor to the object's id.

getName()

Accessor to the object's name.

getShadowedId()

Accessor to the object's shadowed id.

getValues()

Accessor to the parameters values.

getVisibility()

Accessor to the object's visibility state.

gradient()

Get the gradient.

hasName()

Test if the object is named.

hasVisibleName()

Test if the object has a distinguishable name.

inverse(inP)

Convert to native parameters.

setName(name)

Accessor to the object's name.

setShadowedId(id)

Accessor to the object's shadowed id.

setValues(values)

Accessor to the parameters values.

setVisibility(visible)

Accessor to the object's visibility state.
__init__(*args)
evaluate()

Compute native parameters values.

Returns:
valuesPoint

The native parameter values.

getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getDescription()

Get the description of the parameters.

Returns:
collectionDescription

List of parameters names.

getDistribution()

Build a distribution based on a set of native parameters.

Returns:
distributionDistribution

Distribution built with the native parameters.

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.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
idint

Internal unique identifier.

getValues()

Accessor to the parameters values.

Returns:
valuesPoint

List of parameters values.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visiblebool

Visibility flag.

gradient()

Get the gradient.

Returns:
gradientMatrix

The gradient of the transformation of the native parameters into the new parameters.

Notes

If we note (p_1, \dots, p_q) the native parameters and (p'_1, \dots, p'_q) the new ones, then the gradient matrix is \left( \dfrac{\partial p'_i}{\partial p_j} \right)_{1 \leq i,j \leq q}.

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.

inverse(inP)

Convert to native parameters.

Parameters:
inPsequence of float

The non-native parameters.

Returns:
outPPoint

The native parameters.

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
idint

Internal unique identifier.

setValues(values)

Accessor to the parameters values.

Parameters:
valuessequence of float

List of parameters values.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visiblebool

Visibility flag.