Package org.orekit.estimation.sequential

Class AbstractKalmanEstimator

java.lang.Object

org.orekit.estimation.sequential.AbstractKalmanEstimator

All Implemented Interfaces:

ParameterEstimator

Direct Known Subclasses:

KalmanEstimator, SemiAnalyticalKalmanEstimator, SemiAnalyticalUnscentedKalmanEstimator, UnscentedKalmanEstimator

public abstract class AbstractKalmanEstimator
extends Object
implements ParameterEstimator

Base class for Kalman estimators.

Since:

11.3

Author:

Romain Gerbaud, Maxime Journot, Luc Maisonobe

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractKalmanEstimator(MatrixDecomposer decomposer, List<? extends PropagatorBuilder> builders)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected List<? extends PropagatorBuilder>	getBuilders()	Get the list of propagator builders.
AbsoluteDate	getCurrentDate()	Get the current date.
int	getCurrentMeasurementNumber()	Get the current measurement number.
ParameterDriversList	getEstimatedMeasurementsParameters()	Get the list of estimated measurements parameters.
protected abstract KalmanEstimation	getKalmanEstimation()	Get the provider for kalman filter estimations.
protected abstract KalmanFilter<MeasurementDecorator>	getKalmanFilter()	Get the Hipparchus filter.
protected MatrixDecomposer	getMatrixDecomposer()	Get the matrix decomposer.
KalmanObserver	getObserver()	Get the observer.
RealMatrix	getPhysicalEstimatedCovarianceMatrix()	Get the "physical" estimated covariance matrix (i.e. not normalized)
RealVector	getPhysicalEstimatedState()	Get the "physical" estimated state (i.e. not normalized)
PropagatorBuilder[]	getPropagatorBuilders()	Getter for the propagator builders.
protected AbsoluteDate	getReferenceDate()	Get the reference date.
protected abstract double[]	getScale()	Get the parameter scaling factors.
void	setObserver(KalmanObserver observer)	Set the observer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.estimation.ParameterEstimator

getOrbitalParametersDrivers, getPropagationParametersDrivers

Constructor Detail

AbstractKalmanEstimator

protected AbstractKalmanEstimator(MatrixDecomposer decomposer,
                                  List<? extends PropagatorBuilder> builders)

Constructor.

Parameters:

decomposer - matrix decomposer for filter

builders - list of propagator builders

Method Detail

getCurrentMeasurementNumber

public int getCurrentMeasurementNumber()

Get the current measurement number.

Returns:

current measurement number

getCurrentDate

public AbsoluteDate getCurrentDate()

Get the current date.

Returns:

current date

setObserver

public void setObserver(KalmanObserver observer)

Set the observer.

Parameters:

observer - the observer

getObserver

public KalmanObserver getObserver()

Get the observer.

Returns:

the observer

getPhysicalEstimatedState

public RealVector getPhysicalEstimatedState()

Get the "physical" estimated state (i.e. not normalized)

For the Semi-analytical Kalman Filters it corresponds to the corrected filter correction. In other words, it doesn't represent an orbital state.

Returns:

the "physical" estimated state

getPhysicalEstimatedCovarianceMatrix

public RealMatrix getPhysicalEstimatedCovarianceMatrix()

Get the "physical" estimated covariance matrix (i.e. not normalized)

Returns:

the "physical" estimated covariance matrix

getEstimatedMeasurementsParameters

public ParameterDriversList getEstimatedMeasurementsParameters()

Get the list of estimated measurements parameters.

Returns:

the list of estimated measurements parameters

getBuilders

protected List<? extends PropagatorBuilder> getBuilders()

Get the list of propagator builders.

Returns:

the list of propagator builders

getPropagatorBuilders

public PropagatorBuilder[] getPropagatorBuilders()

Description copied from interface: ParameterEstimator

Getter for the propagator builders.

Specified by:

getPropagatorBuilders in interface ParameterEstimator

Returns:

builders

getKalmanEstimation

protected abstract KalmanEstimation getKalmanEstimation()

Get the provider for kalman filter estimations.

Returns:

the provider for Kalman filter estimations

getMatrixDecomposer

protected MatrixDecomposer getMatrixDecomposer()

Get the matrix decomposer.

Returns:

the decomposer

getReferenceDate

protected AbsoluteDate getReferenceDate()

Get the reference date.

Returns:

the date

getKalmanFilter

protected abstract KalmanFilter<MeasurementDecorator> getKalmanFilter()

Get the Hipparchus filter.

Returns:

the filter

getScale

protected abstract double[] getScale()

Get the parameter scaling factors.

Returns:

the parameters scale