ssMaterialSet.h

Go to the documentation of this file.

// Copyright JRM Enterprises, Inc. 2004 - 2012
// 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 _ssMaterialSet_
#define _ssMaterialSet_

#ifdef WIN32
#include <windows.h>
#endif

#include "ssEnvironment.h"
#include "ssdllexport.h"
#include "ssMaterialTable.h"
#include "ssMaterialProperties.h"

#include <atomic>

#define NUM_DC_LABELS 10

namespace makSigSim
{
   class DtTask;
   class DtTaskScheduler;
   class DtDynamicThermalSpinupTask;
}

// ssMaterialSet
class SIGSIMRT_API ssMaterialSet : public ssMaterialProperties
{

public:

    typedef struct  {
        double BaseSurface; 
        double CosSurface;  
        double Surface;     
    } ssEmission;

    typedef struct  {
        double BaseSurfaceTemp;  
        double CosSurfaceTemp;   
        double QdiffH;           
        double SurfaceTemp;      
    } ssTemperature;

   typedef struct {
      char materialName[256]; 
      double visualAvg;       
      double visualDev;    
      double IMType;       
      double NVGGain;         
      double FLIRGain;        
      double RFGain;          
   } ssIntensityModulationParameters;



    //   ssMaterialSet
    ssMaterialSet();

    //ssMaterialSet
    ~ssMaterialSet();

    //*getResponseData
    float *getResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters); // BRDF or radar
#if(0)

    //*getBRDFResponseData
   float *getBRDFResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);
#else

    //*getPhongResponseData
    float *getPhongResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);
 
    //*getSandfordRobertsonResponseData
    float *getSandfordRobertsonResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);
#endif

    //*getRadarResponseData
    float *getRadarResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);

    //*getSonarResponseData
    float *getSonarResponseData(ssSensor *sensor, unsigned int &numMaterials, unsigned int &numBins, unsigned int &numParameters);


    // getVisualdata
    float *getVisualData(unsigned int &numMaterials, ssSensor *sensor);


    //*getMSBandDHR
   float getMSBandDHR(ssMaterialTable *table, ssSensor *sensor, int msindex, double ax, double bx, double thetarad);

#if(0)

    //getBRDFMaterialResponse
    void getBRDFMaterialResponse(ssSensor *sensor, unsigned int matCode, float &ambient, float &emission, float &cosEmission);



#else

    //getPhongMaterialResponse
    void getPhongMaterialResponse(ssSensor *sensor, unsigned int matCode,
                                  float &ambient, float &emission, float &cosEmission);


    //getSandfordRobertson
    void getSanfordRobertson(ssSensor *sensor, unsigned int matCode, float &reflectance, float &lobeWidth, float &emissivity, float &grazingB) ;

#endif

    //getNumberMaterials
    unsigned int getNumberMaterials();

    //getNumberResponses
    unsigned int getNumberResponses();

    //getNumberResponseValues
     unsigned int getNumberResponseValues();

    //initializeEmats
    bool initializeEmats (ssEnvironment *env);

   // getEmatBulkProps
   //
   // description: gets the Eigenmaterial bulk properties (not sensor or environment - dependent)
   //
   // \param {density*specificheat*thickness}
   // \param {lateralconductivity*thickness}
   // \param Emat index
   //
   void getEmatBulkProps(double &inertia, double &latconduct, unsigned int index);

    // getEmatEmission
    //
    void getEmatEmission(double &baseEmission, double &cosEmission, double &twoSideFlag, double &absorbRatio, double &conductionFactor, double &shadowFlag, ssSensor *sensor, unsigned int index);

    // getEmatIndex
    int getEmatIndex(unsigned int ematIndex);

    //setThermalSpinUpTime
    bool setThermalSpinUpTime(double spinUp);

    //getThermalSpinUp
    double getThermalSpinUpTime();

    //*setFullResponseEnable
    void setFullResponseEnable(bool flag);

    //*getFullResponseEnable
    bool getFullResponseEnable();

    //*setIncludeEmissivity
    void setIncludeEmissivity(bool flag);

    //*getIncludeEmissivity
    bool getIncludeEmissivity();

    //*getMaximumTemperature
    double getMaximumTemperature();

    //*getMinimumTemperature
    double getMinimumTemperature();

   //getNumberTemperatures
   unsigned int getNumberTemperatures();

   //setNumberTemperatures
   void setNumberTemperatures(unsigned int n);

    //setAutoRadianceScale
    void setAutoRadianceScale(bool flag);

    //isAutoRadianceScale
    bool isAutoRadianceScale();

    //getAverageAbsorbRatio
    double getAverageAbsorbRatio();

    //getAverageTwoSidedFlag
    double getAverageTwoSidedFlag();

   //getConductionFactor
   double getConductionFactor(int mtlIndex);

    //getAverageConductionFactor
    double getAverageConductionFactor(); 

    //setAbsorbRatio
    void setAbsorbRatio(double absorbRatio);

    //getAbsorbRatio
    double getAbsorbRatio(); 

    //setTwoSidedFlag
    void setTwoSidedFlag(double twoSidedFlag);

    //getTwoSidedFlag
    double getTwoSidedFlag();

    //setAppendLightData
    void setAppendLightData(bool flag);

    //isAppendLightData
    bool isAppendLightData();

    //isEmatType
    bool isEmatType(); 

    //setEmatTextureType
    void setEmatType(bool flag);

    //setNumberEMats
    void setNumberEMats(unsigned int numEmats);

    //getNumberEMats
    unsigned int getNumberEMats();

   //*getMaterialPropertyTablePtr
   ssMaterialProperties::MaterialSystemTablePtrType getMaterialPropertyTablePtr();

    //*getEmatFractionsPtr
    MATERIAL_EIGENFRACTIONS *getEmatFractionsPtr();

   //isIrradianceCacheDirty
   bool isIrradianceCacheDirty(ssEnvironment *env) ;


   //isTemperatureCacheDirty
   bool isTemperatureCacheDirty(ssEnvironment *env) ;

   //forceCacheUpdate
   void forceCacheUpdate();

   //getUseInstance
   bool getUseInstance();

   //setUseInstance
   void setUseInstance(bool flag);

    //initActiveRegions
    void initActiveRegions();

    //getActiveMaterials
    ssMaterialProperties *getActiveMaterials(); 

    //getInactiveMaterials
    ssMaterialProperties *getInactiveMaterials(); 

    //setActiveRegion
    bool setActiveRegion(unsigned int index, bool activeFlag); 

    //sendActiveRegionImpulse
    bool sendActiveRegionImpulse(unsigned int index);

    //getActiveRegionImpulseCount
    int getActiveRegionImpulseCount(unsigned int index);

    //getActiveRegionImpulseDeltaTime
    double getActiveRegionImpulseDeltaTime(unsigned int index);

    //getActiveRegion
    bool getActiveRegion(unsigned int index);

   //getNumberActiveRegions
   int getNumberActiveRegions();

   //getActiveRegionName
   char *getActiveRegionName(int index);

   //hasActiveRegionsFile
   bool hasActiveRegionsFile(char *msName = NULL);

   // ssMaterialSet::getAcousticImpedanceData
   //
   // description: gets the acoustic impedance data for this material set
   //
   // parameter: nmats - dimension of x (num materials)
   //          ncomps - dimension of y (num components)
   //
   // return: float pointer to material set's acoustic impedance data 
   //
   float *getAcousticImpedanceData(unsigned int &nmats, unsigned int &ncomps);

    // getRCSData
#if 0
    float *getRCSData(ssSensor *sensor, unsigned int &numBins,  unsigned int &x, unsigned int &y);
#else


   float *getRCSData(ssSensor *sensor, unsigned int &numBins, unsigned int &x, unsigned int &y, unsigned int &z);
#endif

    //setNumberRCSangle
    void setNumberRCSangle(unsigned int angles);

    //getNumberRCSangle
   unsigned int getNumberRCSangle();

   //hasIntensityModulationFile
   bool hasIntensityModulationFile();

   //loadIntensityModulationFile
   bool loadIntensityModulationFile();

   //writeIntensityModulationFile
   void writeIntensityModulationFile();

   //setIntensityModulationParameters
   void setIntensityModulationParameters(ssIntensityModulationParameters imodGain, int index);

   //setIntensityModulationParameters
   void setIntensityModulationParameters(double visAvg, double visDev, double IMType, double NVGGain, double IRGain, double RFGain, int index);

   //getIntensityModulationParameters
   void getIntensityModulationParameters(ssIntensityModulationParameters &imodGain, int index);

   //getIntensityModulationParameters
   void getIntensityModulationParameters(double &visAvg, double &visDev, double &IMType, double &NVGGain, double &FLIRGain, double &RFGain, int index);

    //getMSFilename
   const char *getMSfilename();

   //setFixedTempBCs
   void setFixedTempBCs();

private:
   //setWeakSelfPointer
   void setWeakSelfPointer(std::shared_ptr<ssMaterialSet>& set);

    //initialize
    bool initialize(ssEnvironment *env, char *dataDir, char* cacheDir);

    //update
    void update(ssSensor *sensor, ssEnvironment *env);


    //insertMaterialTable
    bool insertMaterialTable(ssSensor *sensor);
    // helpers
#if(0)
   bool insertBRDFMaterialTable(ssSensor *sensor);
#else
    bool insertPhongMaterialTable(ssSensor *sensor);
    bool insertSRMaterialTable(ssSensor *sensor);
#endif
    bool insertRadarMaterialTable(ssSensor *sensor);
   bool insertSonarMaterialTable(ssSensor *sensor);

    // Helpers, do not call directly..
#if(0)
   void updateBRDF(ssSensor *sensor, ssEnvironment *env, bool dirty);
#else
    void updatePhong(ssSensor *sensor, ssEnvironment *env, bool dirty);
    void updateSR(ssSensor *sensor, ssEnvironment *env, bool dirty);
#endif
    void updateRadar(ssSensor *sensor, ssEnvironment *env, bool dirty);
    void updateSonar(bool dirty);

    //getTemperatureData
    void getTemperatureData(ssEnvironment *env);


    //thermalSpinUp
   bool thermalSpinUp(ssEnvironment *env);

   // dynamicThermalSpinUp
   //
   bool dynamicThermalSpinUp(ssEnvironment *env, float deltaTime, std::atomic<bool>* cancelled);

    //computeSpectralReflectanceParameters
    bool computeSpectralReflectanceParameters(ssSensor *sensor, ssMaterialTable *table);

    //computeBaseAndLoadedRadiances
    void computeBaseAndLoadedRadiances(ssTemperature inTemp, double ax,
        double bx, double emissivity, ssEmission &emission);

    //updateFullTemperatureCache
    void updateFullTemperatureCache(ssEnvironment *env);

    //queryTemperatureCache
    bool queryTemperatureCache(ssEnvironment *env); 

    //getTemperatureCache
   ssTemperature *getTemperatureCache();


    //saveTemperatureCache
    void saveTemperatureCache(ssEnvironment *env);

    //getEmatTemperatureCache
   ssTemperature *getEmatTemperatureCache();

    //compareFloat
    bool compareFloat(float float1, float float2);

   //loadActiveRegionsFile
   bool loadActiveRegionsFile();

   // dynamicThermalSpinUpAsync
   //
   void dynamicThermalSpinUpAsync(ssEnvironment* env, float deltaTime, makSigSim::DtTaskScheduler* ts);

   // needResponseBufferUpdate
   //
   bool needResponseBufferUpdate() const;

    ssMaterialTable *m_visualMaterialTable; 
    SENSOR m_visualSensor; 
    float *m_visualData;

    bool m_fullResponse;
    bool m_includeEmissivity;
    ssTemperature *m_temperatureCache;
    ssTemperature *m_temperatureData;

    ssTemperature *m_eMatTemperatureCache;
    ssTemperature *m_eMatTemperatureData;
    ssTemperature *m_eMatRadianceData;

    JRMTIME m_updateTime;
    double m_thermalSpinUp;
    double m_userAbsorbRatio;
    double m_userTwoSidedFlag;

    double m_maxTemperature;
    double m_minTemperature;
    bool m_autoRadianceScale;
    bool m_appendLightData;
    bool m_ematType;
    MATERIAL_EIGENFRACTIONS *m_EmatFractions;
    int *m_ematIndexes;
    unsigned int m_numEMats;

   bool m_cacheForceUpdate;
   bool m_useInstance;

    ssMaterialProperties m_activeMaterials;
    ssMaterialProperties m_inactiveMaterials;

    unsigned int m_numRCSangles;

    ssMaterialTable *m_acousticMaterialTable;

   struct Implementation;
   Implementation *m_impl;
   std::string myUniqueFilename;

    friend class ssObject;
    friend class SigSimRT;
    friend class makSigSim::DtDynamicThermalSpinupTask;
};

#endif // _ssMaterialSet_