Package org.orekit.estimation.sequential
Class AbstractKalmanEstimator
- java.lang.Object
-
- org.orekit.estimation.sequential.AbstractKalmanEstimator
-
- Direct Known Subclasses:
KalmanEstimator
,SemiAnalyticalKalmanEstimator
,SemiAnalyticalUnscentedKalmanEstimator
,UnscentedKalmanEstimator
public abstract class AbstractKalmanEstimator extends Object
Base class for Kalman estimators.- Since:
- 11.3
- Author:
- Romain Gerbaud, Maxime Journot, Luc Maisonobe
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractKalmanEstimator(List<? extends PropagatorBuilder> builders)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description 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.ParameterDriversList
getOrbitalParametersDrivers(boolean estimatedOnly)
Get the orbital parameters supported by this estimator.RealMatrix
getPhysicalEstimatedCovarianceMatrix()
Get the "physical" estimated covariance matrix (i.e.RealVector
getPhysicalEstimatedState()
Get the "physical" estimated state (i.e.ParameterDriversList
getPropagationParametersDrivers(boolean estimatedOnly)
Get the propagator parameters supported by this estimator.
-
-
-
Constructor Detail
-
AbstractKalmanEstimator
protected AbstractKalmanEstimator(List<? extends PropagatorBuilder> builders)
Constructor.- Parameters:
builders
- list of propagator builders
-
-
Method Detail
-
getOrbitalParametersDrivers
public ParameterDriversList getOrbitalParametersDrivers(boolean estimatedOnly)
Get the orbital parameters supported by this estimator.If there are more than one propagator builder, then the names of the drivers have an index marker in square brackets appended to them in order to distinguish the various orbits. So for example with one builder generating Keplerian orbits the names would be simply "a", "e", "i"... but if there are several builders the names would be "a[0]", "e[0]", "i[0]"..."a[1]", "e[1]", "i[1]"...
- Parameters:
estimatedOnly
- if true, only estimated parameters are returned- Returns:
- orbital parameters supported by this estimator
-
getPropagationParametersDrivers
public ParameterDriversList getPropagationParametersDrivers(boolean estimatedOnly)
Get the propagator parameters supported by this estimator.- Parameters:
estimatedOnly
- if true, only estimated parameters are returned- Returns:
- propagator parameters supported by this estimator
-
getCurrentMeasurementNumber
public int getCurrentMeasurementNumber()
Get the current measurement number.- Returns:
- current measurement number
-
getCurrentDate
public AbsoluteDate getCurrentDate()
Get the current date.- Returns:
- current date
-
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
-
getKalmanEstimation
protected abstract KalmanEstimation getKalmanEstimation()
Get the provider for kalman filter estimations.- Returns:
- the provider for Kalman filter estimations
-
-