WSF
wsf::SensorErrorModel< ErrorType > Class Template Referenceabstract

This class defines the interface to compute specific measurement errors. More...

#include <WsfSensorErrorModel.hpp>

Inheritance diagram for wsf::SensorErrorModel< ErrorType >:
Collaboration diagram for wsf::SensorErrorModel< ErrorType >:

Public Member Functions

virtual std::unique_ptr< ErrorType > ComputeMeasurementErrors (WsfSensorResult &aResult) const =0
virtual void ApplyMeasurementErrors (const ErrorType &aErrors, WsfSensorResult &aResult)=0
void ApplyMeasurementErrors (WsfSensorResult &aResult) final
Public Member Functions inherited from wsf::SensorErrorModelBase
bool ProcessInput (UtInput &aInput) override
virtual bool Initialize (WsfSensorMode *aSensorModePtr)
SensorErrorModelBaseClone () const override=0
 Create a clone of "this" object.
virtual bool IsNullModel () const
 Is this a null model (i.e., ApplyMeasurementErrors has no effect).
virtual bool IsStandardModel () const
bool DebugEnabled () const
WsfSensorModeGetSensorMode () const
void SetSensorMode (WsfSensorMode *aSensorModePtr)
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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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 wsf::SensorErrorModelBase
using SensorModelTypes = WsfObjectTypeList<SensorErrorModelBase>
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).

Detailed Description

template<typename ErrorType>
class wsf::SensorErrorModel< ErrorType >

This class defines the interface to compute specific measurement errors.

Member Function Documentation

◆ ApplyMeasurementErrors() [1/2]

template<typename ErrorType>
virtual void wsf::SensorErrorModel< ErrorType >::ApplyMeasurementErrors ( const ErrorType & aErrors,
WsfSensorResult & aResult )
pure virtual

Apply measurement errors computed with ComputeMeasurementErrors to a sensor result.

Parameters
aErrorsThe sensor errors as returned from ComputeMeasurementErrors.
aResultThe sensing chance result to which the error is applied.

Implemented in wsf::AbsoluteSensorErrorModel, wsf::RadarSensorErrorModel, wsf::StandardSensorErrorModel, wsf::SurfaceWaveRadarSensorErrorModel, WsfEOIR_Sensor::EOIR_ErrorModel, WsfPassiveSensor::PassiveMode::PassiveErrorModel, and WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel.

Referenced by ApplyMeasurementErrors().

◆ ApplyMeasurementErrors() [2/2]

template<typename ErrorType>
void wsf::SensorErrorModel< ErrorType >::ApplyMeasurementErrors ( WsfSensorResult & aResult)
inlinefinalvirtual

Compute and apply measurement errors to the current detection attempt.

Parameters
aResultThe results of a sensing chance to be modified by the error model.
Note
This method is defined in wsf::SensorErrorModel.

Implements wsf::SensorErrorModelBase.

References ApplyMeasurementErrors(), and ComputeMeasurementErrors().

◆ ComputeMeasurementErrors()

template<typename ErrorType>
virtual std::unique_ptr< ErrorType > wsf::SensorErrorModel< ErrorType >::ComputeMeasurementErrors ( WsfSensorResult & aResult) const
pure virtual

Compute the sensor errors associated with this model and return them.

Parameters
aResultThe sensing chance result that is used as a basis for the error computation.
Returns
The computed sensor errors for the given sensing chance.
Note
This method is used to implement the single parameter ApplyMeasurementErrors method, and it may also be used in the sensor mode when the errors are applied to more than one sensor result.

Implemented in wsf::AbsoluteSensorErrorModel, wsf::StandardSensorErrorModel, WsfPassiveSensor::PassiveMode::PassiveErrorModel, and WsfSAR_Sensor::SAR_Mode::SAR_ErrorModel.

Referenced by ApplyMeasurementErrors().


The documentation for this class was generated from the following file:
Copyrights Multiple, All Rights Reserved