Package org.hipparchus.util
Class JulierUnscentedTransform
java.lang.Object
org.hipparchus.util.AbstractUnscentedTransform
org.hipparchus.util.JulierUnscentedTransform
- All Implemented Interfaces:
UnscentedTransformProvider
Unscented transform as defined by Julier and Uhlmann.
The unscented transform uses three parameters: alpha, beta and kappa. Alpha determines the spread of the sigma points around the process state, kappa is a secondary scaling parameter, and beta is used to incorporate prior knowledge of the distribution of the process state.
The Julier transform is a particular case of MerweUnscentedTransform with alpha = 1 and beta = 0.
- Since:
- 2.2
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final doubleDefault value for kappa, (0.0, see reference). -
Constructor Summary
ConstructorsConstructorDescriptionJulierUnscentedTransform(int stateDim) Default constructor.JulierUnscentedTransform(int stateDim, double kappa) Simple constructor. -
Method Summary
Methods inherited from class org.hipparchus.util.AbstractUnscentedTransform
unscentedTransformMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hipparchus.util.UnscentedTransformProvider
getUnscentedCovariance, getUnscentedMeanState, inverseUnscentedTransform
-
Field Details
-
DEFAULT_KAPPA
public static final double DEFAULT_KAPPADefault value for kappa, (0.0, see reference).- See Also:
-
-
Constructor Details
-
JulierUnscentedTransform
public JulierUnscentedTransform(int stateDim) Default constructor.This constructor uses default value for kappa.
- Parameters:
stateDim- the dimension of the state- See Also:
-
JulierUnscentedTransform
public JulierUnscentedTransform(int stateDim, double kappa) Simple constructor.- Parameters:
stateDim- the dimension of the statekappa- fscaling factor
-
-
Method Details
-
getWc
Get the covariance weights.- Returns:
- the covariance weights
-
getWm
Get the mean weights.- Returns:
- the mean weights
-
getMultiplicationFactor
protected double getMultiplicationFactor()Get the factor applied to the covariance matrix during the unscented transform.- Specified by:
getMultiplicationFactorin classAbstractUnscentedTransform- Returns:
- the factor applied to the covariance matrix during the unscented transform
-