Package org.orekit.estimation.sequential

Class KalmanEstimatorBuilder

java.lang.Object

org.orekit.estimation.sequential.KalmanEstimatorBuilder

public class KalmanEstimatorBuilder
extends Object

Builder for a Kalman filter estimator.

Since:

9.2

Author:

Romain Gerbaud, Maxime Journot

Constructor Summary

Constructors

Constructor	Description
KalmanEstimatorBuilder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
KalmanEstimatorBuilder	addPropagationConfiguration(NumericalPropagatorBuilder builder, CovarianceMatrixProvider provider)	Add a propagation configuration.
KalmanEstimator	build()	Construct a KalmanEstimatorReal from the data in this builder.
KalmanEstimatorBuilder	decomposer(MatrixDecomposer matrixDecomposer)	Configure the matrix decomposer.
KalmanEstimatorBuilder	estimatedMeasurementsParameters(ParameterDriversList estimatedMeasurementsParams)	Configure the estimated measurement parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

KalmanEstimatorBuilder

public KalmanEstimatorBuilder()

Default constructor. Set an extended Kalman filter, with linearized covariance prediction.

Method Detail

build

public KalmanEstimator build()
                      throws OrekitException

Construct a KalmanEstimatorReal from the data in this builder.

Before this method is called, {@link #addPropagationConfiguration(NumericalPropagatorBuilder, ProcessNoiseMatrixProvider)addPropagationConfiguration()} must have been called at least once and initialCovarianceMatrix() must have been called, otherwise configuration is incomplete and an exception will be raised.

Returns:

a new KalmanEstimatorReal.

Throws:

OrekitException - if some configuration parameters are missing

decomposer

public KalmanEstimatorBuilder decomposer(MatrixDecomposer matrixDecomposer)

Configure the matrix decomposer.

Parameters:

matrixDecomposer - decomposer to use for the correction phase

Returns:

this object.

addPropagationConfiguration

public KalmanEstimatorBuilder addPropagationConfiguration(NumericalPropagatorBuilder builder,
                                                          CovarianceMatrixProvider provider)

Add a propagation configuration.

This method must be called once for each propagator to managed with the Kalman estimator. The propagators order in the Kalman filter will be the call order.

The provider should return a matrix with dimensions and ordering consistent with the builder configuration. The first 6 rows/columns correspond to the 6 orbital parameters which must all be present, regardless of the fact they are estimated or not. The remaining elements correspond to the subset of propagation parameters that are estimated, in the same order as propagatorBuilder.getPropagationParametersDrivers().getDrivers() (but filtering out the non selected drivers).

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.

See Also:

getProcessNoiseMatrix(previous, current)

estimatedMeasurementsParameters

public KalmanEstimatorBuilder estimatedMeasurementsParameters(ParameterDriversList estimatedMeasurementsParams)

Configure the estimated measurement parameters.

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

Parameters:

estimatedMeasurementsParams - The estimated measurements' parameters list.

Returns:

this object.