WsfOpticalEnvironment.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 WSFOPTICALBACKGROUND_HPP
#define WSFOPTICALBACKGROUND_HPP
 
#include "wsf_mil_export.h"
 
#include <mutex>
#include <vector>
 
#include "UtCalendar.hpp"
#include "UtLog.hpp"
class UtInput;
#include "UtVec3.hpp"
class WsfPlatform;
#include "WsfEM_Types.hpp"
#include "WsfSensor.hpp"

class WSF_MIL_EXPORT WsfOpticalEnvironment
{
public:
   WsfOpticalEnvironment();
   WsfOpticalEnvironment(const WsfOpticalEnvironment& aSrc);
   WsfOpticalEnvironment& operator=(const WsfOpticalEnvironment&) = delete;
 
   using BandList = std::vector<WsfEM_Types::OpticalBand>;
 
   bool Initialize(double aSimTime, WsfPlatform* aPlatformPtr);
 
   bool ProcessInput(UtInput& aInput);
 
   double ComputeBackgroundRadiance(double aSimTime, const BandList& aBands, WsfSensorResult& aResult, double& aSolarNoise);
 
   double ComputePathRadiance(double aSimTime, const BandList& aBand, WsfSensorResult& aResult);


   double ComputeDynamicBackgroundRadiance(const BandList& aBands,
                                           const UtVec3d&  aViewerLoc,
                                           const UtVec3d&  aViewerDir,
                                           const UtVec3d&  aSunLoc,
                                           const UtVec3d&  aMoonLoc,
                                           double&         aSolarNoise);
 
   static double GetBlackbodyRadiance(const BandList& aBands, double aTemperature);
 
   static double GetSolarRadiantIntensity(const BandList& aBands);
 
   static double GetSolarRadiantIntensity(WsfEM_Types::OpticalBand aBand);
 
   static void GetWavelengthLimits(WsfEM_Types::OpticalBand aBand, double& aLowerWavelength, double& aUpperWavelength);
 
   static void PrintComputedData();
 
private:
   void UpdateSunMoonData(double aSimTime);
 
   double ReadRadianceValue(UtInput& aInput);
 
   static void ComputeAndPrintBandData(const char*             aName,
                                       double                  aLowerWavelength,
                                       double                  aUpperWavelength,
                                       double&                 aL,
                                       double&                 aPhi,
                                       ut::log::MessageStream& aStream);
 
   WsfPlatform* mPlatformPtr;

   double mBackgroundRadianceAboveHorizon;

   double mBackgroundRadianceBelowHorizon;

   double mLowerTransitionAngle;

   double mUpperTransitionAngle;

   double mPathRadiance;

   bool mUseDynamicModel;


   std::recursive_mutex mSunMoonUpdateMutex;    
   double               mLastSunMoonUpdateTime; 
   UtCalendar           mCurrentTime;
   UtVec3d              mSunLoc;
   UtVec3d              mMoonLoc;
};
 
#endif