ProjectionStrategy¶
- class ProjectionStrategy(*args)¶
Base class for the evaluation strategies of the approximation coefficients.
- Available constructors:
ProjectionStrategy(projectionStrategy)
- Parameters:
- projectionStrategy
ProjectionStrategy A projection strategy which is a
LeastSquaresStrategyor anIntegrationStrategy.
- projectionStrategy
Methods
Accessor to the object's name.
Accessor to the coefficients.
Accessor to the design proxy.
Accessor to the experiments.
getId()Accessor to the object's id.
Accessor to the underlying implementation.
Accessor to the input sample.
Accessor to the measure.
getName()Accessor to the object's name.
Accessor to the output sample.
Accessor to the relative error.
Accessor to the residual.
Accessor to the weights.
Get the model selection flag.
Get the least squares flag.
setExperiment(weightedExperiment)Accessor to the design of experiment.
setInputSample(inputSample)Accessor to the input sample.
setMeasure(measure)Accessor to the measure.
setName(name)Accessor to the object's name.
setOutputSample(outputSample)Accessor to the output sample.
setWeights(weights)Accessor to the weights.
Notes
This class is used in the functional chaos expansion context implemented in the class
FunctionalChaosAlgorithm. It is not usable outside this context.The model is approximated by the meta model defined in Functional Chaos Expansion by equation (5) and the coefficients
are computed by:
solving the least squares problem defined in Functional Chaos Expansion by equation (6) : use the class
LeastSquaresStrategy,computing the inner product defined in Functional Chaos Expansion by equation (7): use the class
IntegrationStrategy. In that case, the basis of the approximation space must be orthonormal to the input distribution.
- __init__(*args)¶
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getDesignProxy()¶
Accessor to the design proxy.
- Parameters:
- designProxy
DesignProxy The design matrix.
- designProxy
- getExperiment()¶
Accessor to the experiments.
- Returns:
- exp
WeightedExperiment Weighted experiment used to evaluate the coefficients.
- exp
- getId()¶
Accessor to the object’s id.
- Returns:
- idint
Internal unique identifier.
- getImplementation()¶
Accessor to the underlying implementation.
- Returns:
- implImplementation
A copy of the underlying implementation object.
- getMeasure()¶
Accessor to the measure.
- Returns:
- muDistribution
Measure
defining the inner product.
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getRelativeError()¶
Accessor to the relative error.
- Returns:
- efloat
Relative error.
- getResidual()¶
Accessor to the residual.
- Returns:
- erfloat
Residual error.
- involvesModelSelection()¶
Get the model selection flag.
A model selection method can be used to select the coefficients of the decomposition which enable to best predict the output. Model selection can lead to a sparse functional chaos expansion.
- Returns:
- involvesModelSelectionbool
True if the method involves a model selection method.
- isLeastSquares()¶
Get the least squares flag.
There are two methods to compute the coefficients: integration or least squares.
- Returns:
- isLeastSquaresbool
True if the coefficients are estimated from least squares.
- setExperiment(weightedExperiment)¶
Accessor to the design of experiment.
- Parameters:
- exp
WeightedExperiment Weighted design of experiment.
- exp
- setMeasure(measure)¶
Accessor to the measure.
- Parameters:
- mDistribution
Measure
defining the scalar product.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
OpenTURNS