WSF
Classes | Public Member Functions | Public Attributes | Protected Attributes | List of all members
WsfOpticalSensor::OpticalMode Class Reference

A mode of the sensor. More...

#include <WsfOpticalSensor.hpp>

Inheritance diagram for WsfOpticalSensor::OpticalMode:
Inheritance graph
[legend]
Collaboration diagram for WsfOpticalSensor::OpticalMode:
Collaboration graph
[legend]

Classes

struct  CumPd
 a structure to store cumulative probabilities of detection More...
class  GlimpseProbability
 Glimpse probability data. More...

Public Member Functions

 OpticalMode (WsfScenario &aScenario)
 OpticalMode (const OpticalMode &aSrc)
OpticalMode & operator= (const OpticalMode &)=delete
 ~OpticalMode () override=default
WsfMode * Clone () const override
 Create an exact duplicate of this mode.
bool Initialize (double aSimTime) override
bool ProcessInput (UtInput &aInput) override
bool AttemptToDetect (double aSimTime, WsfPlatform *aTargetPtr, Settings &aSettings, WsfSensorResult &aResult) override
void Deselect (double aSimTime) override
void Select (double aSimTime) override
virtual void PlatformDeleted (WsfPlatform *aPlatformPtr)
double ComputeAtmosphericTransmittance (WsfSensorResult &aResult)
double ComputeProbabilityOfDetection (double aSize, double aContrast, size_t aTgtIndex)
double ComputeSimpleTransmittance (double aAttenuationPerMeter, double aHeightMSL_1, double aHeightMSL_2, double aGroundRange)
Public Member Functions inherited from WsfSensorMode
 WsfSensorMode ()
 WsfSensorMode (const WsfSensorMode &aSrc)
WsfSensorMode & operator= (const WsfSensorMode &aRhs)
 ~WsfSensorMode () override
WsfPlatform * GetPlatform () const
 Return the pointer to the platform to which the associated sensor is attached.
WsfSensor * GetSensor () const
 Return the pointer to the sensor with which this mode is associated.
const WsfScenario & GetScenario () const
WsfSimulation * GetSimulation () const
bool ProcessInput (UtInput &aInput) override
size_t GetOnSuccessModeIndex () const
size_t GetOnFailureModeIndex () const
int GetMessageLength () const
 Return the logical length (int bits) of report messages that originate from this sensor mode.
int GetMessagePriority () const
 Return the priority of report messages that originate from this sensor mode.
void UpdateTrackPosition (WsfTrack *aTrackPtr, WsfSensorResult &aResult, const double aTgtLocationWCS[3])
WsfSensor::SlewMode GetCueMode () const
virtual size_t GetBeamCount () const
virtual WsfSensorBeam * GetBeamEntry (size_t aIndex)
virtual double GetAltFreqSelectDelay () const
virtual void ScheduleAltFreqChange (double aSimTime, int aAltFreqId=-1)
virtual bool IsAltFreqChangeScheduled () const
virtual double GetLastAltFreqSelectTime () const
virtual bool IsFrequencyAgile () const
virtual void ApplyMeasurementErrors (WsfSensorResult &aResult)
virtual WSF_DEPRECATED void ComputeMeasurementErrors (WsfSensorResult &aResult, double &aAzError, double &aElError, double &aRangeError, double &aRangeRateError) final
virtual void InitializeTrack (double aSimTime, WsfTrack *&aTrackPtr)
virtual void UpdateSensorCueingLimits ()
virtual void UpdateTrack (double aSimTime, WsfTrack *aTrackPtr, WsfPlatform *aTargetPtr, WsfSensorResult &aResult)
virtual void UpdateTrackReportingFlags (double aSimTime, WsfTrack *aTrackPtr)
virtual bool WithinDetectionRange (double aSimTime, WsfPlatform *aTargetPtr)
double GetMaximumRange () const
 Return the optimistic maximum range of the sensor mode.
int GetMaximumRequestCount () const
 Return the maximum number of cued-search or tracking requests the mode can support.
bool DisablesSearch () const
 Does using this mode prevent this or any other mode from searching?
bool CanSearchWhileTrack () const
 Can this mode continue to search while it is also performing tracking requests.
double GetFrameTime () const
void SetFrameTime (double aFrameTime)
double GetRevisitTime () const
double GetDwellTime () const
double GetRequiredPd () const
double EstablishTrackProbability () const
double MaintainTrackProbability () const
int HitsToEstablishTrack () const
 The number of hits (M) within the window (N) that are required to establish a track.
int EstablishTrackWindow () const
 The window size (N) for establishing a track.
int HitsToMaintainTrack () const
 The number of hits (M) within the window (N) that are required to maintain a track.
int MaintainTrackWindow () const
 The window size (N) for maintaining a track.
unsigned int EstablishTrackMask () const
unsigned int MaintainTrackMask () const
double GetTrackQuality () const
unsigned int GetReportingFlags () const
 Accessors for the reporting flags.
bool ReportsLocation () const
bool ReportsVelocity () const
bool ReportsRange () const
bool ReportsBearing () const
bool ReportsElevation () const
bool ReportsRangeRate () const
bool ReportsSide () const
bool ReportsType () const
bool ReportsIFF_Status () const
bool ReportsSignalToNoise () const
bool ReportsFrequency () const
bool ReportsPulseWidth () const
bool ReportsPulseRepititionInterval () const
const wsf::SensorErrorModelBase * GetErrorModel () const
wsf::SensorErrorModelBase * GetErrorModel ()
void SetErrorModel (std::unique_ptr< wsf::SensorErrorModelBase > aErrorModelPtr)
virtual WSF_DEPRECATED double GetAzErrorStdDev () final
virtual WSF_DEPRECATED double GetElErrorStdDev () final
virtual WSF_DEPRECATED double GetRangeErrorStdDev () final
virtual WSF_DEPRECATED double GetRangeRateErrorStdDev () final
virtual WSF_DEPRECATED void SetAzErrorStdDev (double aAzErrorStdDev) final
virtual WSF_DEPRECATED void SetElErrorStdDev (double aElErrorStdDev) final
virtual WSF_DEPRECATED void SetRangeErrorStdDev (double aRangeErrorStdDev) final
virtual WSF_DEPRECATED void SetRangeRateErrorStdDev (double aRangeRateErrorStdDev) final
Public Member Functions inherited from WsfMode
 WsfMode ()
 ~WsfMode () override=default
size_t GetModeIndex () const
 Return the index of this mode within its associated mode list.
bool IsSelected () const
 Returns 'true' if the mode is selected.
Public Member Functions inherited from WsfNamed
 WsfNamed ()
 WsfNamed (WsfStringId aName)
 WsfNamed (const WsfNamed &)=default
WsfNamed & operator= (const WsfNamed &)=default
virtual ~WsfNamed ()=default
const std::string & GetName () const
WsfStringId GetNameId () const
void SetName (WsfStringId aName)

Public Attributes

std::unique_ptr< WsfEM_Antenna > mAntenna
std::unique_ptr< WsfEM_Rcvr > mRcvr
double mGlimpseTime
 observer glimpse time
double mReacquireTime
 re-acquisition time
double mAtmosphericAttenuation
 Fixed atmospheric attenuation (1/m).
double mBackgroundRadiance
 Fixed background radiance (W/m^2/sr).
double mPathRadiance
 Fixed path radiance (W/m^/sr).
bool mVerbose
UtAtmosphere mAtmosphere
 Atmosphere model.
double mRhoSeaLevel
 Air density at sea level (kg/m^3).

Protected Attributes

std::map< size_t, CumPd > mPdMap
 map to store cumulative probabilities
GlimpseProbability mSearch
 The mode-specific search, re-acquire and track glimpse probabilities.
GlimpseProbability mReacquire
GlimpseProbability mTrack
WsfSensor * mSensorPtr
 Pointer to the sensor with which the mode is associated.
WsfPlatform * mPlatformPtr
 Pointer to the platform with which the sensor is associated.
double mMaximumRange
double mAzCueRate
double mElCueRate
double mMinAzCue
double mMaxAzCue
double mMinElCue
double mMaxElCue
WsfSensor::SlewMode mCueMode
int mMaximumRequestCount
bool mCanSearchWhileTrack
bool mDisablesSearch
double mFrameTime
double mRevisitTime
double mDwellTime
double mRequiredPd
double mEstablishTrackProbability
 When the M/N establish track criteria is met, this is the probability that a track will be established.
double mMaintainTrackProbability
int mHitsToEstablishTrack
 The number of hits (M) within the window (N) that are required to establish a track.
int mEstablishTrackWindow
 The window size (N) for establishing a track.
unsigned int mEstablishTrackMask
int mHitsToMaintainTrack
 The number of hits (M) within the window (N) that are required to maintain a track.
int mMaintainTrackWindow
 The window size (N) for maintaining a track.
unsigned int mMaintainTrackMask
double mTrackQuality
 Base line track quality (0..1].
double mAzErrorStdDev
double mElErrorStdDev
double mRangeErrorStdDev
double mRangeRateErrorStdDev
 Range rate error standard deviation.
ut::CloneablePtr< wsf::SensorErrorModelBase > mErrorModelPtr {nullptr}
 The model that calculates and applies errors to sensor detection results.
WsfStringId mOnSuccessModeName
size_t mOnSuccessModeIndex
WsfStringId mOnFailureModeName
size_t mOnFailureModeIndex
int mMessageLength
 The length of messages originating from this sensor mode.
int mMessagePriority
 The priority of messages originating from this sensor mode.
WsfSpatialDomain mReportsSpatialDomain
ReportingFlags mReportingFlags
ReportingFlags mCapabilitiesFlags

Additional Inherited Members

bool InitializeReporting ()
virtual void SelectAlternateFrequency (double aSimTime, int aAltFreqId=-1)
void SetCapabilities (unsigned int aFlags)
void SetReportingFlags (unsigned int aFlags)
static const unsigned int cNONE = 0
 The following are flags/masks meant to be combined and used in the SetCapabilities method.
static const unsigned int cLOCATION = 1
static const unsigned int cVELOCITY = 2
static const unsigned int cRANGE = 4
static const unsigned int cBEARING = 8
static const unsigned int cELEVATION = 16
static const unsigned int cRANGE_RATE = 32
static const unsigned int cSIDE = 64
static const unsigned int cTYPE = 128
static const unsigned int cIFF_STATUS = 256
static const unsigned int cSIGNAL_TO_NOISE = 512
static const unsigned int cFREQUENCY = 1024
static const unsigned int cPULSEWIDTH = 2048
static const unsigned int cPULSE_REPITITION_INTERVAL = 4096
static const unsigned int cSTATE_COVARIANCE = 8192
static const unsigned int cOTHER = 16384
static const unsigned int cALL = 0xFFFFFFFF
 Catch-all for anything other than the above.

Detailed Description

A mode of the sensor.

Constructor & Destructor Documentation

◆ OpticalMode() [1/2]

WsfOpticalSensor::OpticalMode::OpticalMode ( WsfScenario & aScenario)

References WsfSensorMode::cALL, WsfSensorMode::cFREQUENCY, WsfSensorMode::cPULSE_REPITITION_INTERVAL, WsfSensorMode::cPULSEWIDTH, mAntenna, mAtmosphere, mAtmosphericAttenuation, mBackgroundRadiance, mGlimpseTime, mPathRadiance, mPdMap, mRcvr, mReacquire, mReacquireTime, mRhoSeaLevel, mSearch, mTrack, mVerbose, WsfSensorMode::SetCapabilities(), and WsfSensorMode::WsfSensorMode().

Referenced by Clone(), operator=(), and OpticalMode().

◆ OpticalMode() [2/2]

WsfOpticalSensor::OpticalMode::OpticalMode ( const OpticalMode & aSrc)

References mAntenna, mAtmosphere, mAtmosphericAttenuation, mBackgroundRadiance, mGlimpseTime, mPathRadiance, mPdMap, mRcvr, mReacquire, mReacquireTime, mRhoSeaLevel, mSearch, mTrack, mVerbose, OpticalMode(), and WsfSensorMode::WsfSensorMode().

◆ ~OpticalMode()

WsfOpticalSensor::OpticalMode::~OpticalMode ( )
overridedefault

References AttemptToDetect(), Clone(), ComputeAtmosphericTransmittance(), ComputeProbabilityOfDetection(), ComputeSimpleTransmittance(), Deselect(), Initialize(), PlatformDeleted(), ProcessInput(), Select(), and WsfMode::WsfMode().

Member Function Documentation

◆ AttemptToDetect()

bool WsfOpticalSensor::OpticalMode::AttemptToDetect ( double aSimTime,
WsfPlatform * aTargetPtr,
Settings & aSettings,
WsfSensorResult & aResult )
overridevirtual

Attempt to detect the specified target.

Parameters
aSimTime[input] The current simulation time.
aTargetPtr[input] The platform that will be attempted to be detected.
aSettings[input] The sensor settings.
aResult[output] The results of the detection attempt.
Returns
'true' if the target was detected or 'false' if it was not detected.

Implements WsfSensorMode.

References WsfSensorResult::BeginGenericInteraction(), WsfSensorResult::BeginOneWayInteraction(), WsfEM_Interaction::CategoryIsSet(), WsfSensorResult::cCONCEALMENT, ComputeAtmosphericTransmittance(), WsfEM_Interaction::ComputeOpticalSigAzEl(), ComputeProbabilityOfDetection(), WsfEM_Interaction::cSIGNAL_LEVEL, WsfPlatformPart::DebugEnabled(), WsfPlatform::GetConcealmentFactor(), WsfPlatform::GetIndex(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfSensorMode::GetSensor(), WsfInherentContrast::GetValue(), WsfOpticalSignature::GetValue(), WsfSensor::GetZoneAttenuationModifier(), WsfEM_Interaction::mAbsorptionFactor, WsfEM_Interaction::MaskedByTerrain(), mBackgroundRadiance, WsfEM_Interaction::mCheckedStatus, WsfEM_Interaction::mFailedStatus, WsfEM_Interaction::mMaskingFactor, WsfEM_Interaction::mOpticalSig, WsfEM_Interaction::mOpticalSigAz, WsfEM_Interaction::mOpticalSigEl, mPathRadiance, WsfSensorResult::mPd, mPdMap, WsfEM_Interaction::RelativeData::mRange, mRcvr, WsfEM_Interaction::mRcvrToTgt, WsfSensor::Settings::mRequiredPd, WsfEM_Interaction::mZoneAttenuationValue, WsfSensorComponent::PostAttemptToDetect(), WsfEM_Interaction::Print(), WsfSensorResult::Reset(), WsfEM_Interaction::SetCategory(), WsfEM_Interaction::SetReceiverBeamPosition(), WsfPlatform::Update(), and WsfOpticalSignature::UsesInherentContrast().

Referenced by ~OpticalMode().

◆ Clone()

WsfMode * WsfOpticalSensor::OpticalMode::Clone ( ) const
overridevirtual

Create an exact duplicate of this mode.

Implements WsfSensorMode.

References OpticalMode(), and WsfMode::WsfMode().

Referenced by ~OpticalMode().

◆ ComputeAtmosphericTransmittance()

double WsfOpticalSensor::OpticalMode::ComputeAtmosphericTransmittance ( WsfSensorResult & aResult)

Compute the atmospheric transmittance for the current interaction.

Parameters
aResultThe current interaction data.
Returns
The atmospheric transmittance in the range [0, 1].

References ComputeSimpleTransmittance(), WsfEM_Interaction::LocationData::mAlt, mAtmosphericAttenuation, WsfEM_Interaction::LocationData::mLocWCS, WsfEM_Interaction::mRcvrLoc, and WsfEM_Interaction::mTgtLoc.

Referenced by AttemptToDetect(), and ~OpticalMode().

◆ ComputeProbabilityOfDetection()

double WsfOpticalSensor::OpticalMode::ComputeProbabilityOfDetection ( double aSize,
double aContrast,
size_t aIndex )

Compute the probability of detection.

Parameters
aSize[input] The target solid angle at the sensor
aContrast[input] The contrast of the target at the sensor
aIndex[input] The Index of the target for a Pd map lookup
Returns
The probability of detection in the range [0, 1]

References WsfSensorMode::mFrameTime, mGlimpseTime, mPdMap, mReacquire, WsfOpticalSensor::OpticalMode::CumPd::mReacquirePd, mReacquireTime, mSearch, WsfOpticalSensor::OpticalMode::CumPd::mSearchPd, mTrack, and WsfOpticalSensor::OpticalMode::CumPd::mTrackPd.

Referenced by AttemptToDetect(), and ~OpticalMode().

◆ ComputeSimpleTransmittance()

double WsfOpticalSensor::OpticalMode::ComputeSimpleTransmittance ( double aAttenuationPerMeter,
double aHeightMSL_1,
double aHeightMSL_2,
double aGroundRange )

Determine the simplistic transmittance along a path.

Parameters
aAttenuationPerMeter[input] The attenuation per meter.
aHeightMSL_1[input] The height MSL of the first object (meters)
aHeightMSL_2[input] The height MSL of the second object (meters)
aGroundRange[input] The ground range between the objects (meters)
Returns
The transmittance in the range [0, 1]

References mAtmosphere, and mRhoSeaLevel.

Referenced by ComputeAtmosphericTransmittance(), ProcessInput(), and ~OpticalMode().

◆ Deselect()

void WsfOpticalSensor::OpticalMode::Deselect ( double aSimTime)
overridevirtual

The mode is being deselected. The specific implementation should perform whatever actions are associated with deselecting the mode (e.g.: deactivating transmitters or receivers).

Parameters
aSimTime[input] The current simulation time.

Implements WsfSensorMode.

References mRcvr.

Referenced by ~OpticalMode().

◆ Initialize()

bool WsfOpticalSensor::OpticalMode::Initialize ( double aSimTime)
overridevirtual

Initialize the sensor mode.

Parameters
aSimTimeThe current simulation time.
Returns
'true' if the mode was successfully initialize or 'false' if not.

Reimplemented from WsfSensorMode.

References WsfSensorMode::Initialize(), mAntenna, mRcvr, mReacquire, mSearch, WsfSensorMode::mSensorPtr, mTrack, and ok.

Referenced by ~OpticalMode().

◆ operator=()

OpticalMode & WsfOpticalSensor::OpticalMode::operator= ( const OpticalMode & )
delete

References OpticalMode().

◆ PlatformDeleted()

void WsfOpticalSensor::OpticalMode::PlatformDeleted ( WsfPlatform * aPlatformPtr)
virtual

call each glimpse probability to clean-up PdMap virtual

References WsfPlatform::GetIndex(), and mPdMap.

Referenced by ~OpticalMode().

◆ ProcessInput()

bool WsfOpticalSensor::OpticalMode::ProcessInput ( UtInput & aInput)
overridevirtual

Reimplemented from WsfMode.

References ComputeSimpleTransmittance(), mAntenna, mAtmosphere, mAtmosphericAttenuation, mBackgroundRadiance, mPathRadiance, mRcvr, mReacquire, mReacquireTime, mSearch, mTrack, mVerbose, and WsfSensorMode::ProcessInput().

Referenced by ~OpticalMode().

◆ Select()

void WsfOpticalSensor::OpticalMode::Select ( double aSimTime)
overridevirtual

The mode is being activated. The specific implementation should perform whatever actions are associated with selecting the mode (e.g.: activating transmitters or receivers).

Parameters
aSimTime[input] The current simulation time.

Implements WsfSensorMode.

References mRcvr.

Referenced by ~OpticalMode().

Member Data Documentation

◆ mAntenna

std::unique_ptr<WsfEM_Antenna> WsfOpticalSensor::OpticalMode::mAntenna

Referenced by Initialize(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mAtmosphere

UtAtmosphere WsfOpticalSensor::OpticalMode::mAtmosphere

Atmosphere model.

Referenced by ComputeSimpleTransmittance(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mAtmosphericAttenuation

double WsfOpticalSensor::OpticalMode::mAtmosphericAttenuation

Fixed atmospheric attenuation (1/m).

Referenced by ComputeAtmosphericTransmittance(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mBackgroundRadiance

double WsfOpticalSensor::OpticalMode::mBackgroundRadiance

Fixed background radiance (W/m^2/sr).

Referenced by AttemptToDetect(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mGlimpseTime

double WsfOpticalSensor::OpticalMode::mGlimpseTime

observer glimpse time

Referenced by ComputeProbabilityOfDetection(), OpticalMode(), and OpticalMode().

◆ mPathRadiance

double WsfOpticalSensor::OpticalMode::mPathRadiance

Fixed path radiance (W/m^/sr).

Referenced by AttemptToDetect(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mPdMap

std::map<size_t, CumPd> WsfOpticalSensor::OpticalMode::mPdMap
protected

map to store cumulative probabilities

Referenced by AttemptToDetect(), ComputeProbabilityOfDetection(), OpticalMode(), OpticalMode(), and PlatformDeleted().

◆ mRcvr

std::unique_ptr<WsfEM_Rcvr> WsfOpticalSensor::OpticalMode::mRcvr

Referenced by AttemptToDetect(), Deselect(), Initialize(), OpticalMode(), OpticalMode(), ProcessInput(), and Select().

◆ mReacquire

GlimpseProbability WsfOpticalSensor::OpticalMode::mReacquire
protected

Referenced by ComputeProbabilityOfDetection(), Initialize(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mReacquireTime

double WsfOpticalSensor::OpticalMode::mReacquireTime

re-acquisition time

Referenced by ComputeProbabilityOfDetection(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mRhoSeaLevel

double WsfOpticalSensor::OpticalMode::mRhoSeaLevel

Air density at sea level (kg/m^3).

Referenced by ComputeSimpleTransmittance(), OpticalMode(), and OpticalMode().

◆ mSearch

GlimpseProbability WsfOpticalSensor::OpticalMode::mSearch
protected

The mode-specific search, re-acquire and track glimpse probabilities.

Referenced by ComputeProbabilityOfDetection(), Initialize(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mTrack

GlimpseProbability WsfOpticalSensor::OpticalMode::mTrack
protected

Referenced by ComputeProbabilityOfDetection(), Initialize(), OpticalMode(), OpticalMode(), and ProcessInput().

◆ mVerbose

bool WsfOpticalSensor::OpticalMode::mVerbose

Referenced by OpticalMode(), OpticalMode(), and ProcessInput().

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