QuantileMatchingFactory¶
- class QuantileMatchingFactory(*args)¶
Estimation by matching quantiles.
Implements generic estimation by matching quantiles.
- Parameters:
- distribution
Distribution
The distribution defining the parametric model to be adjusted to data. Its parameters define the starting point of the algorithm.
- probabilitiessequence of float, optional
The probabilities corresponding to the quantiles. The default value of the list of probabilities defined as follows. We define the interval where the value of is defined by the QuantileMatchingFactory-QuantileEpsilon key of the
ResourceMap
. A regular grid of probabilities is defined in the interval , where is the number of parameters of the distribution. The grid is defined by the equation where for .- bounds
Interval
, optional Parameter bounds. The default bounds is an empty interval, which implies that the optimization problem is unbounded.
- distribution
See also
Notes
We consider a distribution with parameters. Given a set of probabilities and a set of quantiles , we want to estimates the parameters of the distribution such that:
for . If a sample is given, then the quantiles are estimated from the data, which leads to the sample quantiles .
The underlying optimization problem seeks to minimize the sum of slacks between the empirical quantiles of the sample and the quantiles of the parametric model:
where is the number of parameters of the distribution, the probabilities, and is the sample quantile and is the quantile of the parametric distribution at the probabilities .
Instead of using a sample, the buildFromQuantiles() method can be used if the quantiles are known. This can be useful if some expert knowledge is available.
Examples
Fit a distribution with 2 parameters. Hence, two quantiles are used to estimate the parameters.
>>> import openturns as ot >>> ot.RandomGenerator.SetSeed(0) >>> sample = ot.Normal(0.9, 1.7).getSample(10) >>> factory = ot.QuantileMatchingFactory(ot.Normal()) >>> inf_distribution = factory.build(sample) >>> print(inf_distribution) Normal(mu = 0.267484, sigma = 1.32218) >>> print(factory.getProbabilities()) [0.01,0.99]
We see that the default value of the parameter is so that we consider the 1% and 99% percentile ranks.
Use 5% and 95% percentile ranks:
>>> probabilities = [0.05, 0.95] >>> factory = ot.QuantileMatchingFactory(ot.Normal(), probabilities) >>> inf_distribution = factory.build(sample)
With parameter bounds:
>>> bounds = ot.Interval([0.8, 1.6], [1.0, 1.8]) >>> factory = ot.QuantileMatchingFactory(ot.Normal()) >>> factory.setOptimizationBounds(bounds) >>> inf_distribution = factory.build(sample)
An example with 4 parameters allows one to see the default grid of probabilities in action.
>>> # A distribution with 4 parameters >>> distribution = ot.Beta(2.0, 3.0, 4.0, 5.0) >>> sample = distribution.getSample(10) >>> distribution = ot.Beta() >>> factory = ot.QuantileMatchingFactory(distribution) >>> inf_distribution = factory.build(sample) >>> print(factory.getProbabilities()) [0.01,0.336667,0.663333,0.99]
Methods
build
(*args)Build the distribution.
buildEstimator
(*args)Build the distribution and the parameter distribution.
buildFromQuantiles
(quantiles)Build from quantiles.
Accessor to the bootstrap size.
Accessor to the object's name.
getId
()Accessor to the object's id.
Accessor to the known parameters indices.
Accessor to the known parameters indices.
getName
()Accessor to the object's name.
Accessor to the solver.
Accessor to the optimization bounds.
Accessor to the probabilities.
Accessor to the object's shadowed id.
Accessor to the object's visibility state.
hasName
()Test if the object is named.
Test if the object has a distinguishable name.
setBootstrapSize
(bootstrapSize)Accessor to the bootstrap size.
setKnownParameter
(values, positions)Accessor to the known parameters.
setName
(name)Accessor to the object's name.
setOptimizationAlgorithm
(solver)Accessor to the solver.
setOptimizationBounds
(optimizationBounds)Accessor to the optimization bounds.
setProbabilities
(probabilities)Accessor to the fractiles.
setShadowedId
(id)Accessor to the object's shadowed id.
setVisibility
(visible)Accessor to the object's visibility state.
- __init__(*args)¶
- build(*args)¶
Build the distribution.
Available usages:
build(sample)
build(param)
- Parameters:
- sample2-d sequence of float
Sample from which the distribution parameters are estimated.
- paramCollection of
PointWithDescription
A vector of parameters of the distribution.
- Returns:
- dist
Distribution
The built distribution.
- dist
- buildEstimator(*args)¶
Build the distribution and the parameter distribution.
- Parameters:
- sample2-d sequence of float
Sample from which the distribution parameters are estimated.
- parameters
DistributionParameters
Optional, the parametrization.
- Returns:
- resDist
DistributionFactoryResult
The results.
- resDist
Notes
According to the way the native parameters of the distribution are estimated, the parameters distribution differs:
Moments method: the asymptotic parameters distribution is normal and estimated by Bootstrap on the initial data;
Maximum likelihood method with a regular model: the asymptotic parameters distribution is normal and its covariance matrix is the inverse Fisher information matrix;
Other methods: the asymptotic parameters distribution is estimated by Bootstrap on the initial data and kernel fitting (see
KernelSmoothing
).
If another set of parameters is specified, the native parameters distribution is first estimated and the new distribution is determined from it:
if the native parameters distribution is normal and the transformation regular at the estimated parameters values: the asymptotic parameters distribution is normal and its covariance matrix determined from the inverse Fisher information matrix of the native parameters and the transformation;
in the other cases, the asymptotic parameters distribution is estimated by Bootstrap on the initial data and kernel fitting.
- buildFromQuantiles(quantiles)¶
Build from quantiles.
- Parameters:
- quantilessequence of float
Quantiles of the distribution, matching the probabilities provided to the constructor.
- Returns:
- dist
Distribution
Estimated distribution.
- dist
Examples
>>> import openturns as ot >>> distribution = ot.Beta(2.3, 2.2, -1.0, 1.0) >>> probabilities = [0.05, 0.25, 0.75, 0.95] >>> quantiles = [distribution.computeQuantile(pi)[0] for pi in probabilities] # Or from expert knowledge >>> factory = ot.QuantileMatchingFactory(ot.Beta(), probabilities) >>> inf_distribution = factory.buildFromQuantiles(quantiles)
- getBootstrapSize()¶
Accessor to the bootstrap size.
- Returns:
- sizeinteger
Size of the bootstrap.
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getId()¶
Accessor to the object’s id.
- Returns:
- idint
Internal unique identifier.
- getKnownParameterIndices()¶
Accessor to the known parameters indices.
- Returns:
- indices
Indices
Indices of fixed parameters.
- indices
- getKnownParameterValues()¶
Accessor to the known parameters indices.
- Returns:
- values
Point
Values of fixed parameters.
- values
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getOptimizationAlgorithm()¶
Accessor to the solver.
- Returns:
- solver
OptimizationAlgorithm
The solver used for numerical optimization of the moments.
- solver
- getOptimizationBounds()¶
Accessor to the optimization bounds.
- Returns:
- bounds
Interval
The bounds used for numerical optimization of the likelihood.
- bounds
- 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.
- setBootstrapSize(bootstrapSize)¶
Accessor to the bootstrap size.
- Parameters:
- sizeinteger
Size of the bootstrap.
- setKnownParameter(values, positions)¶
Accessor to the known parameters.
- Parameters:
- valuessequence of float
Values of fixed parameters.
- indicessequence of int
Indices of fixed parameters.
Examples
>>> import openturns as ot >>> ot.RandomGenerator.SetSeed(0) >>> distribution = ot.Beta(2.3, 2.2, -1.0, 1.0) >>> sample = distribution.getSample(10) >>> factory = ot.QuantileMatchingFactory(ot.Beta()) >>> # set (a,b) out of (r, t, a, b) >>> factory.setKnownParameter([-1.0, 1.0], [2, 3]) >>> inf_distribution = factory.build(sample)
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- setOptimizationAlgorithm(solver)¶
Accessor to the solver.
- Parameters:
- solver
OptimizationAlgorithm
The solver used for numerical optimization of the moments.
- solver
- setOptimizationBounds(optimizationBounds)¶
Accessor to the optimization bounds.
- Parameters:
- bounds
Interval
The bounds used for numerical optimization of the likelihood.
- bounds
- setProbabilities(probabilities)¶
Accessor to the fractiles.
- Parameters:
- probabilitiessequence of float
The probabilities
- 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.
Examples using the class¶
Define a distribution from quantiles