WsfImage.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing 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 WSFIMAGE_HPP
#define WSFIMAGE_HPP
 
#include "wsf_export.h"
 
#include <memory>
#include <string>
#include <vector>
 
#include "UtScriptAccessible.hpp"
class UtScriptClass;
class UtScriptTypes;
 
class WsfPlatform;
class WsfProcessor;
class WsfSensor;
class WsfSimulation;
#include "WsfStringId.hpp"

class WSF_EXPORT WsfImage : public UtScriptAccessible
{
public:
   class WSF_EXPORT Object
   {
   public:
      Object() = default;
      Object(WsfPlatform* aPlatformPtr);

      void GetLocationWCS(double aLocationWCS[3]) const;
      void SetLocationWCS(const double aLocationWCS[3]);

      double GetSignalLevel() const { return mSignalLevel; }
      void   SetSignalLevel(double aSignalLevel) { mSignalLevel = aSignalLevel; }

      double GetPixelCount() const { return mPixelCount; }
      void   SetPixelCount(double aPixelCount) { mPixelCount = aPixelCount; }

      double GetPixelIntensity() const { return mPixelIntensity; }
      void   SetPixelIntensity(double aPixelIntensity) { mPixelIntensity = aPixelIntensity; }

      size_t GetTruthIndex() const { return mTruthIndex; }
      void   SetTruthIndex(unsigned int aTruthIndex) { mTruthIndex = aTruthIndex; }
 
      WsfStringId GetTruthName(WsfSimulation& aSimulation) const;

      WsfStringId GetTruthType() const { return mTruthType; }
      void        SetTruthType(WsfStringId aTruthType) { mTruthType = aTruthType; }

      WsfStringId GetTruthSide() const { return mTruthSide; }
      void        SetTruthSide(WsfStringId aTruthSide) { mTruthSide = aTruthSide; }
 
   private:
      double      mLocationWCS[3]{0.0, 0.0, 0.0};
      double      mSignalLevel{0.0};
      double      mPixelCount{1.0};
      double      mPixelIntensity{1.0};
      size_t      mTruthIndex{0};
      WsfStringId mTruthType{nullptr};
      WsfStringId mTruthSide{nullptr};
   };
 
   using ObjectList     = std::vector<Object>;
   using ObjectListIter = std::vector<Object>::iterator;
 
   WsfImage() = default;
   WsfImage(WsfSensor* aOriginatingSensorPtr);
 
   virtual ~WsfImage() = default;
 
   virtual WsfImage* Clone() const;
 
   const char* GetScriptClassName() const override { return "WsfImage"; }
 
   static std::unique_ptr<UtScriptClass> CreateScriptClass(const std::string& aClassName, UtScriptTypes* aScriptTypesPtr);

   double GetMessageDataTag() const { return mMessageDataTag; }

   void SetMessageDataTag(double aMessageDataTag) { mMessageDataTag = aMessageDataTag; }

   int  GetMessageLength() const { return mMessageLength; }
   void SetMessageLength(int aMessageLength) { mMessageLength = aMessageLength; }

   void GetOriginatorLocationWCS(double aOriginatorLocationWCS[3]) const;
   void SetOriginatorLocationWCS(const double aOriginatorLocationWCS[3]);

   void GetCenterLocationWCS(double aCenterLocationWCS[3]) const;
   void SetCenterLocationWCS(const double aCenterLocationWCS[3]);

   double GetImageTime() const { return mImageTime; }
   void   SetImageTime(double aImageTime) { mImageTime = aImageTime; }

   unsigned int GetImageNumber() const { return mImageNumber; }
   void         SetImageNumber(unsigned int aImageNumber) { mImageNumber = aImageNumber; }

   unsigned int GetStreamNumber() const { return mStreamNumber; }
   void         SetStreamNumber(unsigned int aStreamNumber) { mStreamNumber = aStreamNumber; }

   size_t GetPlatformIndex() const { return mPlatformIndex; }

   WsfStringId GetPlatformNameId() const { return mPlatformNameId; }

   WsfStringId GetPlatformTypeId() const { return mPlatformTypeId; }

   WsfStringId GetSensorNameId() const { return mSensorNameId; }

   WsfStringId GetSensorTypeId() const { return mSensorTypeId; }

   WsfStringId GetSensorModeId() const { return mSensorModeId; }

   double GetFrameTime() const { return mFrameTime; }
   void   SetFrameTime(double aFrameTime) { mFrameTime = aFrameTime; }

   double GetWidth() const { return mWidth; }
   void   SetWidth(double aWidth) { mWidth = aWidth; }

   double GetHeight() const { return mHeight; }
   void   SetHeight(double aHeight) { mHeight = aHeight; }

   double GetWidthResolution() const { return mWidthResolution; }
   void   SetWidthResolution(double aWidthResolution) { mWidthResolution = aWidthResolution; }

   double GetHeightResolution() const { return mHeightResolution; }
   void   SetHeightResolution(double aHeightResolution) { mHeightResolution = aHeightResolution; }

   double GetNoiseLevel() const { return mNoiseLevel; }
   void   SetNoiseLevel(double aNoiseLevel) { mNoiseLevel = aNoiseLevel; }

   double GetBackgroundLevel() const { return mBackgroundLevel; }
   void   SetBackgroundLevel(double aBackgroundLevel) { mBackgroundLevel = aBackgroundLevel; }

   double GetMinimumLevel() const { return mMinimumLevel; }
   void   SetMinimumLevel(double aMinimumLevel) { mMinimumLevel = aMinimumLevel; }

   double GetMaximumLevel() const { return mMaximumLevel; }
   void   SetMaximumLevel(double aMaximumLevel) { mMaximumLevel = aMaximumLevel; }



   double GetRangeError() const { return mRangeError; }
   void SetRangeError(double aRangeError) { mRangeError = aRangeError; }
   double GetBearingError() const { return mBearingError; }
   void SetBearingError(double aBearingError) { mBearingError = aBearingError; }
   double GetElevationError() const { return mElevationError; }
   void SetElevationError(double aElevationError) { mElevationError = aElevationError; }
   double GetRangeRateError() const { return mRangeRateError; }
   void SetRangeRateError(double aRangeRateError) { mRangeRateError = aRangeRateError; }



   double GetCollectionFactor() const { return mCollectionFactor; }
   void SetCollectionFactor(double aCollectionFactor) { mCollectionFactor = aCollectionFactor; }



   double GetTrackQuality() const { return mTrackQuality; }
   void SetTrackQuality(double aTrackQuality) { mTrackQuality = aTrackQuality; }



   void AddObject(Object& aObject) { mObjects.push_back(aObject); }

   const ObjectList& GetObjects() const { return mObjects; }
 
private:
   double      mMessageDataTag{0.0};
   int         mMessageLength{512};
   size_t      mPlatformIndex{0}; 
   WsfStringId mPlatformNameId{nullptr};
   WsfStringId mPlatformTypeId{nullptr};
   WsfStringId mSensorNameId{nullptr};
   WsfStringId mSensorTypeId{nullptr};
   WsfStringId mSensorModeId{nullptr};
   double mFrameTime{0.0};
   double mImageTime{0.0};
   unsigned int mImageNumber{0};
   unsigned int mStreamNumber{0};
 
   double mOriginatorLocationWCS[3]{0.0, 0.0, 0.0}; 
   double mCenterLocationWCS[3]{0.0, 0.0, 0.0};     
 
   double mWidth{0.0};            
   double mHeight{0.0};           
   double mWidthResolution{0.0};  
   double mHeightResolution{0.0}; 
   double mNoiseLevel{0.0};       
   double mBackgroundLevel{0.0};  
   double mMinimumLevel{0.0};     
   double mMaximumLevel{1.0};     
   double mCollectionFactor{1.0}; 
   double mTrackQuality{0.5};     


   double mRangeError{0.0};
   double mBearingError{0.0};
   double mElevationError{0.0};
   double mRangeRateError{0.0};
 
   ObjectList mObjects;
};
 
#endif