Package org.orekit.estimation.sequential

Class SemiAnalyticalUnscentedKalmanEstimatorBuilder

java.lang.Object

org.orekit.estimation.sequential.SemiAnalyticalUnscentedKalmanEstimatorBuilder

public class SemiAnalyticalUnscentedKalmanEstimatorBuilder
extends Object

Builder for an Unscented Semi-analytical Kalman filter estimator.

Since:

11.3

Author:

Gaëtan Pierre, Bryan Cazabonne

Constructor Summary

Constructors

Constructor	Description
SemiAnalyticalUnscentedKalmanEstimatorBuilder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
SemiAnalyticalUnscentedKalmanEstimatorBuilder	addPropagationConfiguration(DSSTPropagatorBuilder builder, CovarianceMatrixProvider provider)	Add a propagation configuration.
SemiAnalyticalUnscentedKalmanEstimator	build()	Construct a SemiAnalyticalUnscentedKalmanEstimator from the data in this builder.
SemiAnalyticalUnscentedKalmanEstimatorBuilder	decomposer(MatrixDecomposer matrixDecomposer)	Configure the matrix decomposer.
SemiAnalyticalUnscentedKalmanEstimatorBuilder	estimatedMeasurementsParameters(ParameterDriversList estimatedMeasurementsParams, CovarianceMatrixProvider provider)	Configure the estimated measurement parameters.
SemiAnalyticalUnscentedKalmanEstimatorBuilder	unscentedTransformProvider(UnscentedTransformProvider transformProvider)	Configure the unscented transform provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SemiAnalyticalUnscentedKalmanEstimatorBuilder

public SemiAnalyticalUnscentedKalmanEstimatorBuilder()

Default constructor. Set an Unscented Semi-analytical Kalman filter.

Method Details

build

public SemiAnalyticalUnscentedKalmanEstimator build()

Construct a SemiAnalyticalUnscentedKalmanEstimator from the data in this builder.

Before this method is called, addPropagationConfiguration() must have been called at least once, otherwise configuration is incomplete and an exception will be raised.

In addition, the unscentedTransformProvider() must be called to configure the unscented transform provider use during the estimation process, otherwise configuration is incomplete and an exception will be raised.

Returns:

a new SemiAnalyticalUnscentedKalmanEstimator.

decomposer

public SemiAnalyticalUnscentedKalmanEstimatorBuilder decomposer(MatrixDecomposer matrixDecomposer)

Configure the matrix decomposer.

Parameters:

matrixDecomposer - decomposer to use for the correction phase

Returns:

this object.

unscentedTransformProvider

public SemiAnalyticalUnscentedKalmanEstimatorBuilder unscentedTransformProvider(UnscentedTransformProvider transformProvider)

Configure the unscented transform provider.

Parameters:

transformProvider - unscented transform to use for the prediction phase

Returns:

this object.

addPropagationConfiguration

public SemiAnalyticalUnscentedKalmanEstimatorBuilder addPropagationConfiguration(DSSTPropagatorBuilder builder,
 CovarianceMatrixProvider provider)

Add a propagation configuration.

This method must be called once initialize the propagator builder used by the Semi-Analytical Unscented Kalman Filter.

Parameters:

builder - The propagator builder to use in the Kalman filter.

provider - The process noise matrices provider to use, consistent with the builder.

Returns:

this object.

estimatedMeasurementsParameters

public SemiAnalyticalUnscentedKalmanEstimatorBuilder estimatedMeasurementsParameters(ParameterDriversList estimatedMeasurementsParams,
 CovarianceMatrixProvider provider)

Configure the estimated measurement parameters.

If this method is not called, no measurement parameters will be estimated.

Parameters:

estimatedMeasurementsParams - The estimated measurements' parameters list.

provider - covariance matrix provider for the estimated measurement parameters

Returns:

this object.