WSF
Public Member Functions | Public Attributes | List of all members
WsfLADAR_Sensor::LADAR_Mode Class Reference

A mode of the sensor. More...

#include <WsfLADAR_Sensor.hpp>

Inheritance diagram for WsfLADAR_Sensor::LADAR_Mode:
Inheritance graph
[legend]
Collaboration diagram for WsfLADAR_Sensor::LADAR_Mode:
Collaboration graph
[legend]

Public Member Functions

 LADAR_Mode ()
 LADAR_Mode (const LADAR_Mode &aSrc)
LADAR_Mode & operator= (const LADAR_Mode &)=delete
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
virtual bool AttemptToDetect (double aSimTime, WsfPlatform *aTargetPtr, WsfEM_Xmtr &aXmtr, Settings &aSettings, LADAR_Result &aResult)
void Deselect (double aSimTime) override
void Select (double aSimTime) override
void ComputeBackgroundRadiance ()
double ComputeTargetSolarIrradiance (double aTargetArea, double aTargetReflectivity, double aRange, double aTransmittance)
void ComputeProbabilityOfDetection (const WsfEM_Xmtr &aXmtr, LADAR_Result &aResult)
double ComputeGaussianDetectionProbability (double aSignal, double aNoise, double aThreshold) const
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

WsfEM_Antenna mAntenna
WsfEM_Xmtr mXmtr
 The transmitter for a Mode.
WsfEM_Rcvr mRcvr
 The receiver for a Mode.
WsfLASER_XmtrComponent * mLASER_XmtrComponentPtr
 The xmtr component for laser transmission.
WsfLASER_RcvrComponent * mLASER_RcvrComponentPtr
 The rcvr component for laser reception.
double mBackgroundTemperature
 Blackbody temperature for the background. (deg-K).
double mBackgroundSpectralIrradiance
 Background irradiance (user specified or computed from the background temperature).
double mIntegrationGain
 Integration gain for the simple detector.
double mDetectionThreshold
 The detection threshold for the simple detector.
UtCloneablePtr< UtTable::Curve > mDetectionProbabilityPtr
 Probability of detection table (Pd vs. S/N).

Additional Inherited Members

bool InitializeReporting ()
virtual void SelectAlternateFrequency (double aSimTime, int aAltFreqId=-1)
void SetCapabilities (unsigned int aFlags)
void SetReportingFlags (unsigned int aFlags)
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
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

◆ LADAR_Mode() [1/2]

WsfLADAR_Sensor::LADAR_Mode::LADAR_Mode ( )

References WsfSensorMode::cALL, WsfSensorMode::cFREQUENCY, WsfSensorMode::cPULSE_REPITITION_INTERVAL, WsfSensorMode::cPULSEWIDTH, mAntenna, mBackgroundSpectralIrradiance, mBackgroundTemperature, mDetectionProbabilityPtr, mDetectionThreshold, mIntegrationGain, mLASER_RcvrComponentPtr, mLASER_XmtrComponentPtr, mRcvr, mXmtr, WsfSensorMode::SetCapabilities(), and WsfSensorMode::WsfSensorMode().

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

◆ LADAR_Mode() [2/2]

WsfLADAR_Sensor::LADAR_Mode::LADAR_Mode ( const LADAR_Mode & aSrc)

References LADAR_Mode(), mAntenna, mBackgroundSpectralIrradiance, mBackgroundTemperature, mDetectionProbabilityPtr, mDetectionThreshold, mIntegrationGain, mLASER_RcvrComponentPtr, mLASER_XmtrComponentPtr, mRcvr, mXmtr, and WsfSensorMode::WsfSensorMode().

Member Function Documentation

◆ AttemptToDetect() [1/2]

bool WsfLADAR_Sensor::LADAR_Mode::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 WsfSensor::AttemptToDetect(), WsfSensorMode::GetSensor(), mXmtr, and WsfSensorComponent::PostAttemptToDetect().

◆ AttemptToDetect() [2/2]

bool WsfLADAR_Sensor::LADAR_Mode::AttemptToDetect ( double aSimTime,
WsfPlatform * aTargetPtr,
WsfEM_Xmtr & aXmtr,
Settings & aSettings,
LADAR_Result & aResult )
virtual

References WsfSensorResult::BeginGenericInteraction(), WsfSensorResult::BeginTwoWayInteraction(), WsfSensorResult::cCONCEALMENT, WsfEM_Interaction::ComputeAttenuationFactor(), WsfEM_Interaction::ComputeOpticalSigAzEl(), ComputeProbabilityOfDetection(), ComputeTargetSolarIrradiance(), WsfEM_Interaction::cSIGNAL_LEVEL, WsfEM_Interaction::cXMTR_TO_TARGET, WsfPlatformPart::DebugEnabled(), WsfEM_Xmtr::GetAveragePower(), WsfPlatform::GetConcealmentFactor(), WsfObject::GetName(), WsfPlatformPart::GetPlatform(), WsfEM_Xmtr::GetPulseRepetitionInterval(), WsfEM_Xmtr::GetPulseWidth(), WsfSensorMode::GetSensor(), WsfOpticalReflectivity::GetValue(), WsfOpticalSignature::GetValue(), WsfEM_XmtrRcvr::GetWavelength(), WsfSensor::GetZoneAttenuationModifier(), WsfEM_Interaction::mAbsorptionFactor, WsfEM_Interaction::MaskedByTerrain(), WsfEM_Interaction::mCheckedStatus, WsfLADAR_Sensor::LADAR_Result::mDetectionData, WsfEM_Interaction::mFailedStatus, mLASER_RcvrComponentPtr, mLASER_XmtrComponentPtr, WsfEM_Interaction::mOpticalReflectivity, WsfEM_Interaction::mOpticalSig, WsfEM_Interaction::mOpticalSigAz, WsfEM_Interaction::mOpticalSigEl, WsfSensorResult::mPd, WsfLASER_RcvrComponent::DetectionData::mPower, WsfEM_Interaction::RelativeData::mRange, WsfEM_Interaction::mRcvdPower, mRcvr, WsfSensor::Settings::mRequiredPd, WsfEM_Interaction::mXmtdPower, WsfEM_Interaction::mXmtrToTgt, WsfLADAR_Sensor::LADAR_Result::Print(), WsfSensorResult::Reset(), WsfEM_Interaction::SetCategory(), WsfEM_Interaction::SetReceiverBeamPosition(), WsfEM_Interaction::SetTransmitterBeamPosition(), and WsfPlatform::Update().

◆ Clone()

WsfMode * WsfLADAR_Sensor::LADAR_Mode::Clone ( ) const
overridevirtual

Create an exact duplicate of this mode.

Implements WsfSensorMode.

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

◆ ComputeBackgroundRadiance()

void WsfLADAR_Sensor::LADAR_Mode::ComputeBackgroundRadiance ( )

References mBackgroundSpectralIrradiance, mBackgroundTemperature, mRcvr, and WsfLADAR_Sensor::SpectralRadiantEmittance().

Referenced by Initialize().

◆ ComputeGaussianDetectionProbability()

double WsfLADAR_Sensor::LADAR_Mode::ComputeGaussianDetectionProbability ( double aSignal,
double aNoise,
double aThreshold ) const

Compute the probability of detection using the simple Gaussian model.

Parameters
aSignal[input] The returned signal
aNoise[input] The noise
aThreshold[input] The signal-to-noise ratio required to generate a Pd = 0.5.
Returns
The probability of detection in the range [0, 1]

Referenced by ComputeProbabilityOfDetection().

◆ ComputeProbabilityOfDetection()

void WsfLADAR_Sensor::LADAR_Mode::ComputeProbabilityOfDetection ( const WsfEM_Xmtr & aXmtr,
LADAR_Result & aResult )

Computes the probability of detection using the detector model that has been configured.

Parameters
aXmtrThe transmitter that is involved in the interaction.
aResultThe sensor interaction data.
Note
This routine does NOT expect ANY of the 'aResult' data to be valid except a few variables, and the transmitter is only used to get wavelength, pulse width and repetition interval.

References ComputeGaussianDetectionProbability(), WsfEM_Xmtr::GetPulseWidth(), WsfEM_XmtrRcvr::GetWavelength(), WsfLADAR_Sensor::LADAR_Result::mDetectionData, mDetectionProbabilityPtr, mDetectionThreshold, WsfLASER_RcvrComponent::DetectionData::mNoiseCount, WsfSensorResult::mPd, WsfEM_Interaction::mRcvrNoisePower, WsfLASER_RcvrComponent::DetectionData::mSignalCount, and WsfEM_Interaction::mSignalToNoise.

Referenced by AttemptToDetect().

◆ ComputeTargetSolarIrradiance()

double WsfLADAR_Sensor::LADAR_Mode::ComputeTargetSolarIrradiance ( double aTargetArea,
double aTargetReflectivity,
double aRange,
double aTransmittance )

Compute the power per square meter (per meter; spectral irradiance) at the detector due to solar background noise on the target. The solar background photocount rate is computed using the first term of eq 1.27 from Ref 1.

Parameters
aTargetAreaThe area of the targt seen by the receiver. This may be less than the actual area if the receivers IFOV is smaller.
aTargetReflectivityThe reflectivity of the target.
aRangeThe range from the target to the receiver.
aTransmittanceThe atmospheric transmittance between the target and the receiver.
Returns
The photocount rate (Hz or counts/sec) due to background solar radiation.
Note
This count is NOT reduced by the structural masking factor. That is the responsibility of the caller if it is desired.

References mBackgroundSpectralIrradiance.

Referenced by AttemptToDetect().

◆ Deselect()

void WsfLADAR_Sensor::LADAR_Mode::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, and mXmtr.

◆ Initialize()

bool WsfLADAR_Sensor::LADAR_Mode::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 ComputeBackgroundRadiance(), WsfPlatformPart::GetSimulation(), WsfSensorMode::Initialize(), mAntenna, mDetectionProbabilityPtr, mDetectionThreshold, mLASER_RcvrComponentPtr, mLASER_XmtrComponentPtr, mRcvr, WsfSensorMode::mSensorPtr, mXmtr, and ok.

◆ operator=()

LADAR_Mode & WsfLADAR_Sensor::LADAR_Mode::operator= ( const LADAR_Mode & )
delete

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

◆ ProcessInput()

bool WsfLADAR_Sensor::LADAR_Mode::ProcessInput ( UtInput & aInput)
overridevirtual

Reimplemented from WsfMode.

References mAntenna, mBackgroundSpectralIrradiance, mBackgroundTemperature, mDetectionProbabilityPtr, mDetectionThreshold, mIntegrationGain, mRcvr, mXmtr, and WsfSensorMode::ProcessInput().

◆ Select()

void WsfLADAR_Sensor::LADAR_Mode::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, and mXmtr.

Member Data Documentation

◆ mAntenna

WsfEM_Antenna WsfLADAR_Sensor::LADAR_Mode::mAntenna

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

◆ mBackgroundSpectralIrradiance

double WsfLADAR_Sensor::LADAR_Mode::mBackgroundSpectralIrradiance

Background irradiance (user specified or computed from the background temperature).

Referenced by ComputeBackgroundRadiance(), ComputeTargetSolarIrradiance(), LADAR_Mode(), LADAR_Mode(), and ProcessInput().

◆ mBackgroundTemperature

double WsfLADAR_Sensor::LADAR_Mode::mBackgroundTemperature

Blackbody temperature for the background. (deg-K).

Referenced by ComputeBackgroundRadiance(), LADAR_Mode(), LADAR_Mode(), and ProcessInput().

◆ mDetectionProbabilityPtr

UtCloneablePtr<UtTable::Curve> WsfLADAR_Sensor::LADAR_Mode::mDetectionProbabilityPtr

Probability of detection table (Pd vs. S/N).

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

◆ mDetectionThreshold

double WsfLADAR_Sensor::LADAR_Mode::mDetectionThreshold

The detection threshold for the simple detector.

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

◆ mIntegrationGain

double WsfLADAR_Sensor::LADAR_Mode::mIntegrationGain

Integration gain for the simple detector.

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

◆ mLASER_RcvrComponentPtr

WsfLASER_RcvrComponent* WsfLADAR_Sensor::LADAR_Mode::mLASER_RcvrComponentPtr

The rcvr component for laser reception.

Referenced by AttemptToDetect(), Initialize(), LADAR_Mode(), and LADAR_Mode().

◆ mLASER_XmtrComponentPtr

WsfLASER_XmtrComponent* WsfLADAR_Sensor::LADAR_Mode::mLASER_XmtrComponentPtr

The xmtr component for laser transmission.

Referenced by AttemptToDetect(), Initialize(), LADAR_Mode(), and LADAR_Mode().

◆ mRcvr

WsfEM_Rcvr WsfLADAR_Sensor::LADAR_Mode::mRcvr

The receiver for a Mode.

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

◆ mXmtr

WsfEM_Xmtr WsfLADAR_Sensor::LADAR_Mode::mXmtr

The transmitter for a Mode.

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

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