WsfLASER_RcvrComponent.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2018 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFLASER_RCVRCOMPONENT_HPP
#define WSFLASER_RCVRCOMPONENT_HPP
 
#include "WsfEM_Rcvr.hpp"
#include "WsfMilComponentRoles.hpp"

class WsfLASER_RcvrComponent : public WsfEM_RcvrComponent
{
public:
   WsfLASER_RcvrComponent();
   WsfLASER_RcvrComponent(const WsfLASER_RcvrComponent& aSrc) = default;
   WsfLASER_RcvrComponent& operator=(const WsfLASER_RcvrComponent&) = delete;


   WsfStringId   GetComponentName() const override;
   WsfComponent* CloneComponent() const override;
   const int*    GetComponentRoles() const override;
   void*         QueryInterface(int aRole) override;


   bool Initialize(double aSimTime) override;
   bool ProcessInput(UtInput& aInput) override;
 
   double GetAntennaGain(double aXmtr_Wavelength) const;

   double GetInstantaneousFieldOfView() const { return mIFOV; }

   double GetApertureDiameter() const { return mApertureDiameter; }

   double GetApertureSolidAngle() const { return mApertureSolidAngle; }

   double GetApertureArea() const { return mApertureArea; }

   double GetOpticsTransmissionFactor() const { return mOpticsTransmissionFactor; }

   double GetResponsivity() const { return mResponsivity; }

   class DetectionData
   {
   public:
      DetectionData() = default;
 
      double mPower{0.0};       
      double mEnergy{0.0};      
      double mSignalCount{0.0}; 
      double mEnvironmentalNoiseRate{0.0}; 
      double mEnvironmentalNoiseCount{0.0}; 
      double mDarkNoiseRate{0.0};           
      double mDarkNoiseCount{0.0};          
      double mSignalShotNoiseCount{0.0}; 
      double mThermalNoiseCount{0.0}; 
      double mDetectorNoiseCount{0.0}; 
      double mNoiseCount{0.0};         
   };

   virtual DetectionData ComputeDetectionData(double aSignalRadiance,       // W/m^2/sr
                                              double aSignalIrradiance,     // W/m^2
                                              double aBackgroundRadiance,   // W/m^2/m/sr
                                              double aBackgroundIrradiance, // W/m^2/m
                                              double aIntegrationTime);
 
protected:
   double mApertureDiameter;         
   double mApertureSolidAngle;       
   double mApertureArea;             
   double mOpticsTransmissionFactor; 
   double mFocalLength;              
   double mDetectorSize;             
   double mPhotonEnergy;             
   double mIFOV;              
   double mQuantumEfficiency; 
   double mResponsivity; 
   double mDetectorGain;       
   double mCircuitTemperature; 
   double mCircuitCapacitance; 
   double mCircuitResistance;   
   double mThermalNoiseCountSq; 
   double mBulkDarkCountRate;   
   double mBandPass; 
   double mSurfaceDarkCountRate; 
   double mExcessNoiseFactor; 
   double mNoiseEquivalentPower;       
   double mNoiseEquivalentCountRate;   
   double mPointingTransmissionFactor; 
};
 
WSF_DECLARE_COMPONENT_ROLE_TYPE(WsfLASER_RcvrComponent, cWSF_COMPONENT_LASER_RCVR)
 
#endif