WsfOrbitDeterminationKalmanFilter Class Reference

Implement an OrbitDeterminationKalmanFilter as a WsfFilter. More...

#include <WsfOrbitDeterminationKalmanFilter.hpp>

Inheritance diagram for WsfOrbitDeterminationKalmanFilter:

Collaboration diagram for WsfOrbitDeterminationKalmanFilter:

Public Member Functions
	WsfOrbitDeterminationKalmanFilter (const WsfScenario &aScenario)
	WsfOrbitDeterminationKalmanFilter (const WsfOrbitDeterminationKalmanFilter &aSrc)=default
	~WsfOrbitDeterminationKalmanFilter () override=default
bool	ProcessInput (UtInput &aInput) override
WsfOrbitDeterminationKalmanFilter *	Clone () const override
void	SetStatePropagator (std::unique_ptr< UtOrbitalPropagatorBase > aStatePropagatorPtr)
bool	Initialize (double aSimTime, const ut::OrbitalState &aState)
const ut::OrbitalState &	GetOrbitalState () const
bool	Initialize (double aSimTime, WsfSimulation *aSimulationPtr, const UtMatrixd *aInitialStatePtr) override
bool	HyperbolicOrbitAllowed () const
bool	UsingDefaultPropagator () const
	Return whether a filter propagator was set during input.
const UtOrbitalPropagatorBase *	GetStatePropagator () const
Public Member Functions inherited from WsfFilter
	WsfFilter ()=delete
	WsfFilter (TrackingFilters::Filter *aFilterPtr)
	WsfFilter (const WsfFilter &aSrc)
WsfFilter &	operator= (const WsfFilter &aRhs)
	~WsfFilter () override
void	Reset (double aSimTime, const UtMatrixd *aInitialStatePtr=nullptr)
void	Update (double aSimTime, const UtMeasurementData &aDataIn, UtMeasurementData &aDataOut)
void	NoDetectUpdate (double aSimTime, UtMeasurementData &aDataOut)
void	GetKinematicEstimate (double aSimTime, UtMeasurementData &aDataOut)
const UtCovariance *	GetStateCovariance ()
const UtCovariance *	GetResidualCovariance ()
bool	GetPredictedStateCovariance (double aSimTime, UtCovariance &aCovariance)
bool	GetPredictedResidualCovariance (double aSimTime, UtCovariance &aCovariance)
bool	GetCurrentMeasurementTrackScore (double &aCurrentScore)
bool	GetAverageTrackScore (double &aAverageScore)
bool	IsStable () const
void	SetFrameTime (double aFrameTime)
	Set the 'frame time' for the sensor, which is the typical time to complete a scan.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from WsfFilter
TrackingFilters::Filter *	mFilterPtr

Detailed Description

Implement an OrbitDeterminationKalmanFilter as a WsfFilter.

Constructor & Destructor Documentation

WsfOrbitDeterminationKalmanFilter() [1/2]

WsfOrbitDeterminationKalmanFilter::WsfOrbitDeterminationKalmanFilter

(

const WsfScenario &

aScenario

)

References WsfFilter::WsfFilter().

Referenced by Clone(), and WsfOrbitDeterminationKalmanFilter().

WsfOrbitDeterminationKalmanFilter() [2/2]

WsfOrbitDeterminationKalmanFilter::WsfOrbitDeterminationKalmanFilter ( const WsfOrbitDeterminationKalmanFilter & aSrc )

default

References WsfOrbitDeterminationKalmanFilter().

~WsfOrbitDeterminationKalmanFilter()

WsfOrbitDeterminationKalmanFilter::~WsfOrbitDeterminationKalmanFilter ( )

overridedefault

Member Function Documentation

Clone()

WsfOrbitDeterminationKalmanFilter * WsfOrbitDeterminationKalmanFilter::Clone ( ) const

inlineoverridevirtual

Clone this filter.

Returns

a pointer to the new object.

Implements WsfFilter.

References WsfOrbitDeterminationKalmanFilter().

GetOrbitalState()

const ut::OrbitalState & WsfOrbitDeterminationKalmanFilter::GetOrbitalState

(

)

const

GetStatePropagator()

const UtOrbitalPropagatorBase * WsfOrbitDeterminationKalmanFilter::GetStatePropagator ( ) const

inline

Return the state propagator. If UsingDefaultPropagator is false, the return value will be non-null; Otherwise it will be non-null after Initialize is called.

HyperbolicOrbitAllowed()

bool WsfOrbitDeterminationKalmanFilter::HyperbolicOrbitAllowed ( ) const

inline

Initialize() [1/2]

bool WsfOrbitDeterminationKalmanFilter::Initialize	(	double	aSimTime,
		const ut::OrbitalState &	aState )

Initialize the filter using the specified orbital state. If a prototype propagator is specified in a "propagator" block, that propagator will be cloned and set as the filter's state propagator. The filter is initialized with the provided state.

Initialize() [2/2]

bool WsfOrbitDeterminationKalmanFilter::Initialize ( double aSimTime, WsfSimulation * aSimulationPtr, const UtMatrixd * aInitialStatePtr )

overridevirtual

Initialize the filter with the option of providing simulation and / or scenario specific data, and an initial state.

Parameters

aSimTime	The simulation time at which the initial state (if any) is valid; otherwise, the current simulation time.
aSimulationPtr	The simulation object pointer.
aInitialStatePtr	An optional initial state (6x1) vector, consisting of a WCS location vector (first three values), and a WCS velocity vector (second three values).

Reimplemented from WsfFilter.

References WsfSimulation::GetDateTime(), and WsfDateTime::GetStartDateAndTime().

ProcessInput()

bool WsfOrbitDeterminationKalmanFilter::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput

a reference to a UtInput object.

Returns

'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase

(or an object derived from it) if the command was recognized but contains some sort of error.

Note

If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfFilter.

References WsfOrbitalPropagatorTypes::Get().

SetStatePropagator()

void WsfOrbitDeterminationKalmanFilter::SetStatePropagator

(

std::unique_ptr< UtOrbitalPropagatorBase >

aStatePropagatorPtr

)

UsingDefaultPropagator()

bool WsfOrbitDeterminationKalmanFilter::UsingDefaultPropagator ( ) const

inline

Return whether a filter propagator was set during input.

---

The documentation for this class was generated from the following files:

• WsfOrbitDeterminationKalmanFilter.hpp
• WsfOrbitDeterminationKalmanFilter.cpp