ssSensor.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004 - 2011
// All rights reserved.
//
// This code is the intellectual property of JRM Enterprises, Inc.
// It may not be used or released as source or compiled binary form
// without the prior written consent of JRM Enterprises, Inc.
//
// Original Author:     Eric Olson     Date: May 2004

#ifndef _ssSensor_
#define _ssSensor_

#include "ssdllexport.h"

#include "SigSimStructs.h"
// class: ssSensor
class SIGSIMRT_API ssSensor 
{
public:

    //ssSensor
    ssSensor();

    //~ssSensor
    virtual ~ssSensor();

    //setBand
    bool setBand(double lower, double upper, int numBins);

    //getBand
    bool getBand(double &lower, double &upper, int &numBins);

    //getMinRadiance
    double getMinRadiance() const;

    //getMaxRadiance
    double getMaxRadiance() const;

    // getMinRange
    double getMinRange() const;

    // getMaxRange
    double getMaxRange() const;

   // getDisplayRange
   double getDisplayRange();

   // ssSensor::setDisplayRange
   void setDisplayRange(double range);

    // getMinWedgeExtent
    double getMinWedgeExtent() { return m_minWedgeExtent; }

    // setMinWedgeExtent
    void setMinWedgeExtent( double angle )
    { 
        if( angle >= -360.0 && angle < m_maxWedgeExtent && angle < 360.0 ) 
            m_minWedgeExtent = angle; 
    }

    // getMaxWedgeExtent
    double getMaxWedgeExtent() { return m_maxWedgeExtent; }

    // setMaxWedgeExtent
    void setMaxWedgeExtent( double angle)
    { 
        if( angle > -360.0 && angle > m_minWedgeExtent && angle <= 360.0 ) 
            m_maxWedgeExtent = angle; 
    }

    // getBacksweepState
   bool getBacksweepState( ){  return m_enableBacksweep;  }

    // setBacksweepState
   void setBacksweepState( bool backsweep ){ m_enableBacksweep = backsweep; }

    // getOtwViewState
   bool getOtwViewState(){ return m_showOtwView ;}

    // setOtwViewState
   void setOtwViewState( bool show ){  m_showOtwView = show;   }

    // getHeadingOffset
   double getHeadingOffset(){ return m_headingOffset ;}

    // setHeadingOffset
   void setHeadingOffset( double offset ){   m_headingOffset = offset;  }

   //getMinVelocity
   double getMinVelocity() const;

   //getMaxVelocity
   double getMaxVelocity() const;


    // getDownRangeResolution
    double getDownrangeResolution() const;

    // getCrossrangeResolution
    double getCrossrangeResolution();

    // setTerrainSlantRange
    void setTerrainSlantRange(double slantRange);

    // getTerrainSlantRange
    double getTerrainSlantRange();


    //setMinMaxTemp
    bool setMinMaxTemp(double minTemp, double maxTemp);

    //getMinTemp 
    double getMinTemp();

    //getMaxTemp 
    double getMaxTemp();

    //setMaxLightLevel
    void setMaxLightLevel(double maxLightLevel);

    //getMaxLightLevel 
    const double getMaxLightLevel();


    //getMaxPower 
    const double getMaxPower();


    //getNumberWavelengths
    unsigned int getNumberWavelengths();

    //*getWavelengthsArray
    double *getWavelengthsArray();

    //getWavelength
    double getWavelength(int i);

    //setBandpass
    bool setBandpass(double ax, double bx, double dx);

    //getBandpass
    bool getBandpass(double &ax, double &bx, double &dx);

    //setPemitterW
    bool setPemitterW(double PemitterW);

    //getPemitterW 
    double getPemitterW();

    //setTransmitterGain
    bool setTransmitterGain(double AntGain);

    //getTransmitterGain 
    double getTransmitterGain();

    //setReceiverGain
    bool setReceiverGain(double AntGain);

    //getReceiverGain 
    double getReceiverGain();

   //setSysTempK
   bool setSysTempK(double degK);

   //getSysTempK 
   double getSysTempK();

    //setFCemitterHz
    bool setFCemitterHz(double FCemitterHz);


    //setFCemitterWavelength
    bool setFCemitterWavelength(double wavelength);   // [m]

    //getFCemitterHz 
    double getFCemitterHz();

    //getFCemitterWavelength 
    double getFCemitterWavelength();   // [m]

    //getBWemitterHz 
    double getBWemitterHz() const;

    //setChannelResolutionHz
    bool setChannelResolutionHz(double ChannelResolutionHz);

    //getChannelResolutionHz 
    double getChannelResolutionHz();

    //setPulseWidth
    bool setPulseWidth(double PulseWidth);

    //getPulseWidth 
    double getPulseWidth();

    //setPRF
    bool setPRF(double PRF);

    //getPRF 
    double getPRF();

   //setNFPRF
   bool setNFPRF(double PRF);

   //getNFPRF 
   double getNFPRF();

   //setTransmitterPolarizationAngle
   bool setTransmitterPolarizationAngle(double PolarizationAngle_deg);

   //getTransmitterPolarizationAngle 
   double getTransmitterPolarizationAngle();

   //setReceiverPolarizationAngle
   bool setReceiverPolarizationAngle(double PolarizationAngle_deg);

   //getReceiverPolarizationAngle 
   double getReceiverPolarizationAngle();

   //setBeamWidth
   bool setBeamWidth(double mrad);

   //getBeamWidth
   double getBeamWidth();

   //setGainPattern
   void setGainPattern(int pattern);

   //getGainPattern
   const int getGainPattern();

   //setDisplayType
   void setDisplayType(int type);

   //getDisplayType
   const int getDisplayType();


    // setTAprops
    bool setTAprops(double ThreshDetect, double ThreshClassify, double ThreshRecognize, double ThreshIdentify, double PersistenceTime);

    // getTAprops
    bool getTAprops(double &ThreshDetect, double &ThreshClassify, double &ThreshRecognize, double &ThreshIdentify, double &PersistenceTime);

   // ssSensor::setSaturationRatio
   void setSaturationRatio(double satRatio);

   // ssSensor::getSaturationRatio
   double getSaturationRatio();

   // ssSensor::getRadarIFOVNoisePower
   double getRadarIFOVNoisePower();

   // ssSensor::getRadarReceiverArea()
   double getRadarReceiverArea();

   // ssSensor::getRadarIFOVNominalReturnPower
   double getRadarIFOVNominalReturnPower();

    //isVisualBand
    bool isVisualBand();

    //isNearIRBand
    bool isNearIRBand();

    //isLongWaveBand
    bool isLongWaveBand();

    //isRadarBand
    bool isRadarBand();
    
    //isLadar
    bool isLadar();


    //getSensorSelect
    void getSensorSelect(float &w1, float &w2, float &w3, float &visSensor);

    //setNumberSamples
    void setNumberSamples(unsigned int hsamples, unsigned int vsamples);

    //setNumberHorizontalSamples
    void setNumberHorizontalSamples(unsigned int hsamples);

    //getNumberHorizontalSamples
    unsigned int getNumberHorizontalSamples();

    //setNumberVerticalSamples
    void setNumberVerticalSamples(unsigned int vsamples);

    //getNumberVerticalSamples
    unsigned int getNumberVerticalSamples();

    //setFOV
    void setFOV(double horizontalFOV, double verticalFOV);

    //getFOV
    void getFOV(double &horizontalFOV, double &verticalFOV);

    //getType
    int getType(); 

    //getUniqueID
    int getUniqueID();

    //setUniqueID
    void setUniqueID(int id);

    //*getPlanckIntegralTable
    float *getPlanckIntegralTable();

    //setMaximumPlanckTableTemperature
    void setMaximumPlanckTableTemperature(int max);

    //getMaximumPlanckTableTemperature
    int getMaximumPlanckTableTemperature();

    //setNumberPlanckTableTemperatures
    void setNumberPlanckTableTemperatures(unsigned int num);

    //getNumberPlanckTableTemperatures
    unsigned int getNumberPlanckTableTemperatures();

    //getAutoMaxTemperature
    double getAutoMaxTemperature();

    //getAutoMinTemperature
    double getAutoMinTemperature();

    //getAutoMaxDiurnalLight
    double getAutoMaxDiurnalLight();

    //getAutoMinDiurnalLight
    double getAutoMinDiurnalLight();

    //isAutoRadianceScale
    bool isAutoRadianceScale();

    //setAutoRadianceScale
    void setAutoRadianceScale(bool flag);

    //isDirty
    bool isDirty();

    //isTimeChanged
    bool isTimeChanged();

    //setGeocentricLocation
    void setGeocentricLocation(
        double x, 
        double y, 
        double z);

    //getGeocentricLocation
    void getGeocentricLocation(
        double &x, 
        double &y, 
        double &z);

    //setGeodeticLocation
    void setGeodeticLocation(
        double lat, 
        double lon, 
        double alt);

    //getGeodeticLocation
    void getGeodeticLocation(
        double &lat, 
        double &lon, 
        double &alt);

    //setOrientation
    void setOrientation(
        double h, 
        double p, 
        double r);

    //getOrientation
    void getOrientation(
        double &h, 
        double &p, 
        double &r);


    //setLinearVelocity
    void setLinearVelocity(double e, 
        double n, 
        double u);

    //getLinearVelocity
    void getLinearVelocity(double &e, 
        double &n, 
        double &u);

    //setLinearAcceleration
    void setLinearAcceleration(double e, 
        double n, 
        double u);

    //getLinearAcceleration
    void getLinearAcceleration(double &e, 
        double &n, 
        double &u);

    //setAngularVelocity
    void setAngularVelocity(double e, 
        double n, 
        double u);

    //getAngularVelocity
    void getAngularVelocity(double &e, 
        double &n, 
        double &u);


   void setFRDAngularVelocity(double y, 
                           double p, 
                           double r);


   void getFRDAngularVelocity(double &y, 
                           double &p, 
                           double &r);

   // setSpotfile
   void setSpotfile(char *filename);


   // getSpotfile
   char *getSpotfile();

    //setAngularAcceleration
    void setAngularAcceleration(double e, 
        double n, 
        double u);

    //getAngularAcceleration
    void getAngularAcceleration(double &e, 
        double &n, 
        double &u);

    //convertRUB2NED
    void convertRUB2NED(int hpix, int vpix, float range, float *vector);

    // setTrack
    void setTrack(TRACK *track, int numTracks);

    // setTrackfileUpdate
    void setTrackfileUpdate(double simTime, ::ellipsoid *ellipsoid);

    //computePlanckIntegral
    double computePlanckIntegral (double lowerWaveLength, 
        double upperWaveLength, 
        double temperature);
 
    //computePlanckIntegral
    double computePlanckIntegral (double temperature);

    //getGain
    double getGain();

    //getLevel
    double getLevel();

    //setGain
    void setGain(double gain);

    //setLevel
    void setLevel(double level);


    //*getName
    char *getName();


    //setName
    void setName(const char *name);

    //*getSensorPtr
    SENSOR *getSensorPtr();

    //setSensorPtr
    void setSensorPtr(SENSOR *sensorPtr);

    //setWorldLocation
   void setWorldLocation(double x, double y, double z);

    //getWorldLocation
    void getWorldLocation(double& x, double& y, double& z);

    //setSarReprojection
    void setSarReprojection(bool flag);

    //getSarReprojection
    bool getSarReprojection();

    //isSar
    bool isSar();

    //isIsar
    bool isIsar();

    //isPpi
    bool isPpi();

   //isDopplerColoring
   bool isDopplerColoring();

   //setDopplerColoring
   void setDopplerColoring(bool state);

    //isDopplerSpatialEffects
    bool isDopplerSpatialEffects();

    //setDopplerSpatialEffects
    void setDopplerSpatialEffects(bool state);

    //setSarBoresightROI
    void setSarBoresightROI(double x, double y, double width, double height);
   
    //getSarBoresightROI
    void getSarBoresightROI(double &x, double &y, double &width, double &height);

    //setSarIntegrationPathlength
    void setSarIntegrationPathlength(double length);

    //getSarIntegrationPathlength
    double getSarIntegrationPathlength();

    //setSarShadowOrientationDown
    void setSarShadowOrientationDown(bool flag);

    //getSarShadowOrientationDown
    bool getSarShadowOrientationDown();

    //setRadarIFOVSolidAngle
   void setRadarIFOVSolidAngle(double ifovsr);

    //getRadarIFOVSolidAngle
   double getRadarIFOVSolidAngle();

    //setIsarIntegrationTime
    void setIsarIntegrationTime(double time);

    //getIsarIntegrationTime
   double getIsarIntegrationTime();

    //getIntensityModulationGain
   double getIntensityModulationGain();

    //setIntensityModulationGain
   void setIntensityModulationGain(double imodGain);

    //setNumSpectralBins
   void setNumSpectralBins(int sbins);

    //getNumSpectralBins
   int getNumSpectralBins();

private:

    //initialize
    bool initialize();


    //setAutoMaxTemperature
    void setAutoMaxTemperature(double temp);

    //setAutoMinTemperature
    void setAutoMinTemperature(double temp);

    //setAutoMaxDiurnalLight
    void setAutoMaxDiurnalLight(double light);

    //setAutoMinDiurnalLight
    void setAutoMinDiurnalLight(double light);

    //recomputeMinMaxRadiance
    void recomputeMinMaxRadiance();


    //recomputeMinMaxRange
   void recomputeMinMaxRange();

   // ssSensor::recomputeMinMaxVelocity
   //
   // description: recomputes the min and max velocity 
   //
   void recomputeMinMaxVelocity();

    //updatePlanckIntegralTable
    void updatePlanckIntegralTable();

    //degreesToMilliradians
    double degreesToMilliradians(double deg);

    //clrTimeChanged
    void clrTimeChanged();

    //setTimeChanged
    void setTimeChanged();

    //clrDirty
    void clrDirty();

    //setDirty
    void setDirty();


    int m_id;

   double m_minRange; // Meters
   double m_maxRange; // Meters
   double m_minVel;  // [m/s]
   double m_maxVel;  // [m/s]

    double m_minRadiance;   // [W/cm2/sr]
    double m_maxRadiance;   // [W/cm2/sr]
    float *m_planckTable;
    int m_maxTemperature;
    unsigned int m_numTemperatures;
    SENSOR *m_sensorPtr;

    RF_POWER_DENSITY *m_powerDensity;

    double m_autoMaxTemperature;
    double m_autoMinTemperature;
    double m_maxDiurnalLight; // [W/cm2]
    double m_minDiurnalLight; // [W/cm2]
    bool m_autoRadianceScale;
    bool m_dirty;
    bool m_timeChanged;
    double m_transmitterGain;
   double m_receiverGain;
    double m_pEmitterW;
   double m_sysTempK;
    double m_maxPower;
   double m_satRatio;
   bool m_dopColoring;
   bool m_dopplerSpatialFXState;
   double   m_dopplerThreshold;

    char m_spotFilepath[512];
    
    double m_worldXCoord;
    double m_worldYCoord;
    double m_worldZCoord;

    // Sar projection
    bool m_sarReprojection;

    // SAR Boresight ROI
    double m_sarBoresightRoiX;
    double m_sarBoresightRoiY;
    double m_sarBoresightRoiWidth;
    double m_sarBoresightRoiHeight;
    // SAR Path length
    double m_sarIntegrationPathlength;
    // terrain slant range used for SAR
    double  m_terrainSlantRange;
    // ISAR integration time
    double m_isarIntegrationTime;

   double m_ifovsr;  // [sr] sampling ifov solid angle

    // SAR shadow orientation
    bool m_sarShadowOrientationDown;

   int m_gainPattern;      // For radar modes: 0=Unity, 1=Lobe, 2=Rect
   int m_displayType;      // For radar modes: 0=radiance, 1=power, 2=effective RCS

   //ppi mode display params
   double   m_minWedgeExtent;
   double   m_maxWedgeExtent;
   double   m_displayRange;
   bool  m_enableBacksweep;
   bool  m_showOtwView;
    double  m_headingOffset;

   double m_intensityModulationGain;

   int m_numSpectralBins;

    // For generating the unique id
    static int s_sensorId;

    friend class SigSimRT;
    friend class ssRadar;
    friend class ssEnvironment;
    friend class ssMaterialSet;
    friend class ssAtmosphericTable;
    //friend class MixedSigSimRT;   // CF091221 : Not ready yet for ATM LUT merging code.

};

#endif // _ssSensor_