VR-Vantage 3.1 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Macros | Enumerations | Functions
sigsim.h File Reference

Go to the source code of this file.

Classes

struct  GPUCOEFF2
struct  GPUFACTOR
struct  MATL_PROP_TABLE
struct  MATL_SPECTRAL_TABLE
struct  CELESTIAL_TABLE
struct  THERMAL_CACHE
struct  SIMPLE_BACKGROUND_SPEC
struct  METIN
struct  TA_PROPS
struct  SENSOR

Macros

#define NUM_SSP_PARAMS   5
#define NUM_OP_PARAMS   4
#define NUM_P_PARAMS   5
#define NUM_SR_PARAMS   5
#define NUM_BK_PARAMS   5
#define NUM_SOURCE_TYPES   14

Enumerations

enum  ReflectType { io, rf }
enum  Polarization {
  un, hh, hv, vh,
  vv
}
enum  BRDF_MODEL {
  SIGSIM_PHONG = -1, ORIGINAL_PHONG = 0, SANDFORD_ROBERTSON = 1, BECKMANN = 2,
  PHONG = 3, UDRADAR = 4, SONAR = 5, BRDF_UNKNOWN = 6
}
enum  SOURCE_TYPE {
  UNSPECIFIED, DIRECT_SOLAR, DIFFUSE_SOLAR, DIRECT_LUNAR,
  DIFFUSE_LUNAR, DIRECT_STELLAR, DIFFUSE_STELLAR, DIFFUSE_SKY,
  DIFFUSE_EARTHSHINE, DIRECT_MANMADE, DIFFUSE_MANMADE, NEARBY_THERMAL_EMITTER,
  RADAR, OTHER
}
enum  POLARIZATION { UNPOLARIZED, HORIZONTAL, VERTICAL }
enum  SENSOR_TYPE {
  EO_Blue = -3, EO_Green = -2, EO_Red = -1, EO = 0,
  IR, WAS, ASCAN, LRCS,
  SAR, ISAR, MTI, ACTIVE_SONAR,
  PASSIVE_SONAR, SIG_INT, ACTIVE_COMM, PASSIVE_COMM,
  MMW, PPI, AIR_TO_AIR, CWR
}

Functions

SIGSIM_API int SigSimRegistrationCheck (char *const policiesMsg, const size_t policiesMsgSize)
SIGSIM_API int reg_check (const char *iRegPath)
SIGSIM_API const char * getSigSimVersion ()
SIGSIM_API int Allocate_MATL_PROP_TABLE_SpectralArrays (MATL_PROP_TABLE *mp_table, long nspecrecs)
SIGSIM_API int RemoveMATL_PROP_TABLEFromArray (MATL_PROP_TABLE **mp_table, int *nmatls, int index_to_remove)
SIGSIM_API int Initialize_MATL_PROP_TABLE_NonSpectralArrays (MATL_PROP_TABLE *mp_table)
SIGSIM_API int Initialize_MATL_PROP_TABLE_SpectralArrays (MATL_PROP_TABLE *mp_table)
SIGSIM_API int Allocate_MATL_SPECTRAL_TABLE_Arrays (BRDF_MODEL brdf_type, long nlambda, MATL_SPECTRAL_TABLE *mst)
SIGSIM_API int Free_MATL_PROP_TABLE_SpectralArrays (MATL_PROP_TABLE *mp_table)
SIGSIM_API int Free_MATL_PROP_TABLE_NonSpectralArrays (MATL_PROP_TABLE *mp_table)
SIGSIM_API void Allocate_MATL_PROP_TABLE_LayerMaterialName (MATL_PROP_TABLE *mp_table)
SIGSIM_API int Free_MatlPropTables (MATL_PROP_TABLE **mp_table, long num_matls)
SIGSIM_API int Free_MatlPropTable_Arrays (MATL_PROP_TABLE *mp_table)
SIGSIM_API int Free_MatlSpecTableArrays (MATL_SPECTRAL_TABLE *mst)
SIGSIM_API int Initialize_MatlPropTable_Arrays (MATL_PROP_TABLE *mp_table)
long GetMPIndex (MATL_PROP_TABLE mp_table, enum ReflectType RT, enum Polarization PL, double lambda)
SIGSIM_API int CreateAggregateMaterial (char *ms_indir, char *ms_infile, char *histogram_infile, char *sigsim_data_dir, SPECTRAL_DOMAIN spectrum)
int SkyRadiance (GEODETIC_LOCATION GeoD, double ax, double bx, METIN *metin, int num_entries, CELESTIAL_TABLE *LOS, jrmbool hitflag)
int WriteMetinDiurnalIrradiances (METIN *metin, char *filename)
int ReadMetinDiurnalIrradiances (METIN *metin, char *filename)
int AllocateMetinSkyTable (METIN *metin)
int AllocateMetinDiurnalIrradiances (METIN *metin)
void SetupHomogeneousAtmosphere (METIN *metin, int resetMetin, double ScatCoefficient0, double ScatCoefficient1, double ExtinctCoefficient, int ConstThruLayers, double SolarIrrad, double LunarIrrad)
SIGSIM_API void ClearMetinSpectralArrays (METIN *metin)
SIGSIM_API void FreeMetinSpectralArrays (METIN *metin)
SIGSIM_API int AllocateMetinSpectralArrays (METIN *metin)
SIGSIM_API int Free_Metin_Arrays (METIN *metin)
SIGSIM_API int Free_SIMPLE_BACKGROUND_SPEC (SIMPLE_BACKGROUND_SPEC *background, jrmbool INITFLAG)
SIGSIM_API int AddSIMPLE_BACKGROUND_SPEC (SIMPLE_BACKGROUND_SPEC **c, int *nc, SIMPLE_BACKGROUND_SPEC toadd)
SIGSIM_API int FreeScatterLayerArrays (METIN *metin)
SIGSIM_API int AllocateScatterLayerArrays (METIN *metin)
SIGSIM_API void MetinSetDefaults (METIN *metin)
SIGSIM_API int LoadMetinDefaultBands (METIN *metin)
SIGSIM_API int LoadATMFromPreFilledMetin (char *sigsim_data_dir, char *sigsim_cache_dir, char *atmcoef_file, char *modcard_file, METIN *metin, jrmbool atm_reset)
SIGSIM_API void CalculateEmaxAverages (METIN *metin)
SIGSIM_API int FillMetinDiurnalIrradiances (METIN *metin, double alt_m)
SIGSIM_API int SetBandStructure (int *nbands, BAND **band, long *nlambda, double **lambda, char c1Modtrn)
SIGSIM_API int SetupAtmosphericProfile (jrmbool atmreset, jrmbool dumcol, char *sigsim_data_dir, char *sigsim_cache_dir, char *atm_file, char *modcard_file, long nlayers, METIN *metin)
SIGSIM_API int AllocateAndFillMetinBackgroundSpec (char *sigsim_data_dir, METIN *metin, char *bathymetry_file, char *ms_file)
SIGSIM_API int AllocateSensors (int nsensors, SENSOR **sens)
SIGSIM_API int AllocateSingleSensorSpectra (SENSOR *sens, int nmmls, jrmbool INIT)
SIGSIM_API int AllocateSensorSpectra (int nsensors, SENSOR **sens, int nmmls)
SIGSIM_API void SetSensorDefaults (SENSOR *sensor)
SIGSIM_API void SetSensorTA_Props (TA_PROPS *taprops, double threshDetect, double threshClassify, double threshRecognize, double threshID, double persistTime)
SIGSIM_API int AddSensor (SENSOR **sens, int newNumSensors)
SIGSIM_API int RemoveSensor (SENSOR **sens, int numSensors, int sensorRemoveIndex)
SIGSIM_API int Free_Sensors (SENSOR **sens, int nsensors)
SIGSIM_API void Null_Sensor_Arrays (SENSOR *sens, int nsensors)
SIGSIM_API int Free_Sensor_Arrays (SENSOR *sens, int nsensors)
SIGSIM_API int AllocateAndFillAtmosphericBands (int *nbands, BAND **band, int nsensors, SENSOR **sens)
SIGSIM_API long ValidateSensorBandInputs (SENSOR *sensor)
SIGSIM_API int FillSensorResponse (char *filename, SENSOR *sensor)
SIGSIM_API int GetDynamicRange (double *Mmin, double *Mmax, SENSOR *sens)
SIGSIM_API int UpdateSensorState (SENSOR *sens, ellipsoid E, double simtime)
SIGSIM_API int ConstructSpectralDomain (METIN *metin, int nsensors, SENSOR **sens)
SIGSIM_API int InitializeMatSys (jrmbool matreset, char *sigsim_data_dir, char *ms_filename, char *ms_state_file, long *nmatls, MATL_PROP_TABLE **mp_table, double tod_start, METIN *metin)
int SkyColor (SENSOR *sens, METIN *metin, int num_entries, CELESTIAL_TABLE *LOS, jrmbool hitflag, jrmbool CROP)
SIGSIM_API int AllocateAndFillMetinTablesAndSpectralArrays (char *sigsim_data_dir, METIN *metin, int nsensors, SENSOR **sens, char *mmls_file, char *night_sky_file)
SIGSIM_API int ComputeSpectralReflectanceParameters (long matl_index, MATL_PROP_TABLE *mp_table, BRDF_MODEL brdf_model, SPECTRAL_DOMAIN spectrum, MATL_SPECTRAL_TABLE *mst)
SIGSIM_API int ComputeReflectanceParameters (long matl_index, MATL_PROP_TABLE *mp_table, BRDF_MODEL brdf_model, SPECTRAL_DOMAIN spectrum, MATL_SPECTRAL_TABLE *mst, SENSOR *sens)
int UpdateSensorPassbandEnvironment (METIN *metin, SENSOR *sens, jrmbool PaintStars, jrmbool PaintSky, jrmbool CROP)

Macro Definition Documentation

#define NUM_SSP_PARAMS   5
#define NUM_OP_PARAMS   4
#define NUM_P_PARAMS   5
#define NUM_SR_PARAMS   5
#define NUM_BK_PARAMS   5
#define NUM_SOURCE_TYPES   14

Enumeration Type Documentation

enum ReflectType
Enumerator:
io 
rf 
enum Polarization
Enumerator:
un 
hh 
hv 
vh 
vv 
enum BRDF_MODEL
Enumerator:
SIGSIM_PHONG 
ORIGINAL_PHONG 
SANDFORD_ROBERTSON 
BECKMANN 
PHONG 
UDRADAR 
SONAR 
BRDF_UNKNOWN 
enum SOURCE_TYPE
Enumerator:
UNSPECIFIED 
DIRECT_SOLAR 
DIFFUSE_SOLAR 
DIRECT_LUNAR 
DIFFUSE_LUNAR 
DIRECT_STELLAR 
DIFFUSE_STELLAR 
DIFFUSE_SKY 
DIFFUSE_EARTHSHINE 
DIRECT_MANMADE 
DIFFUSE_MANMADE 
NEARBY_THERMAL_EMITTER 
RADAR 
OTHER 
enum POLARIZATION
Enumerator:
UNPOLARIZED 
HORIZONTAL 
VERTICAL 
enum SENSOR_TYPE
Enumerator:
EO_Blue 
EO_Green 
EO_Red 
EO 
IR 
WAS 
ASCAN 
LRCS 
SAR 
ISAR 
MTI 
ACTIVE_SONAR 
PASSIVE_SONAR 
SIG_INT 
ACTIVE_COMM 
PASSIVE_COMM 
MMW 
PPI 
AIR_TO_AIR 
CWR 

Function Documentation

SIGSIM_API int SigSimRegistrationCheck ( char *const  policiesMsg,
const size_t  policiesMsgSize 
)
SIGSIM_API int reg_check ( const char *  iRegPath)
SIGSIM_API const char* getSigSimVersion ( )
SIGSIM_API int Allocate_MATL_PROP_TABLE_SpectralArrays ( MATL_PROP_TABLE *  mp_table,
long  nspecrecs 
)
SIGSIM_API int RemoveMATL_PROP_TABLEFromArray ( MATL_PROP_TABLE **  mp_table,
int *  nmatls,
int  index_to_remove 
)
SIGSIM_API int Initialize_MATL_PROP_TABLE_NonSpectralArrays ( MATL_PROP_TABLE *  mp_table)
SIGSIM_API int Initialize_MATL_PROP_TABLE_SpectralArrays ( MATL_PROP_TABLE *  mp_table)
SIGSIM_API int Allocate_MATL_SPECTRAL_TABLE_Arrays ( BRDF_MODEL  brdf_type,
long  nlambda,
MATL_SPECTRAL_TABLE *  mst 
)
SIGSIM_API int Free_MATL_PROP_TABLE_SpectralArrays ( MATL_PROP_TABLE *  mp_table)
SIGSIM_API int Free_MATL_PROP_TABLE_NonSpectralArrays ( MATL_PROP_TABLE *  mp_table)
SIGSIM_API void Allocate_MATL_PROP_TABLE_LayerMaterialName ( MATL_PROP_TABLE *  mp_table)
SIGSIM_API int Free_MatlPropTables ( MATL_PROP_TABLE **  mp_table,
long  num_matls 
)
SIGSIM_API int Free_MatlPropTable_Arrays ( MATL_PROP_TABLE *  mp_table)
SIGSIM_API int Free_MatlSpecTableArrays ( MATL_SPECTRAL_TABLE *  mst)
SIGSIM_API int Initialize_MatlPropTable_Arrays ( MATL_PROP_TABLE *  mp_table)
long GetMPIndex ( MATL_PROP_TABLE  mp_table,
enum ReflectType  RT,
enum Polarization  PL,
double  lambda 
)
SIGSIM_API int CreateAggregateMaterial ( char *  ms_indir,
char *  ms_infile,
char *  histogram_infile,
char *  sigsim_data_dir,
SPECTRAL_DOMAIN  spectrum 
)
int SkyRadiance ( GEODETIC_LOCATION  GeoD,
double  ax,
double  bx,
METIN *  metin,
int  num_entries,
CELESTIAL_TABLE *  LOS,
jrmbool  hitflag 
)
int WriteMetinDiurnalIrradiances ( METIN *  metin,
char *  filename 
)
int ReadMetinDiurnalIrradiances ( METIN *  metin,
char *  filename 
)
int AllocateMetinSkyTable ( METIN *  metin)
int AllocateMetinDiurnalIrradiances ( METIN *  metin)
void SetupHomogeneousAtmosphere ( METIN *  metin,
int  resetMetin,
double  ScatCoefficient0,
double  ScatCoefficient1,
double  ExtinctCoefficient,
int  ConstThruLayers,
double  SolarIrrad,
double  LunarIrrad 
)
SIGSIM_API void ClearMetinSpectralArrays ( METIN *  metin)
SIGSIM_API void FreeMetinSpectralArrays ( METIN *  metin)
SIGSIM_API int AllocateMetinSpectralArrays ( METIN *  metin)
SIGSIM_API int Free_Metin_Arrays ( METIN *  metin)
SIGSIM_API int Free_SIMPLE_BACKGROUND_SPEC ( SIMPLE_BACKGROUND_SPEC *  background,
jrmbool  INITFLAG 
)
SIGSIM_API int AddSIMPLE_BACKGROUND_SPEC ( SIMPLE_BACKGROUND_SPEC **  c,
int *  nc,
SIMPLE_BACKGROUND_SPEC  toadd 
)
SIGSIM_API int FreeScatterLayerArrays ( METIN *  metin)
SIGSIM_API int AllocateScatterLayerArrays ( METIN *  metin)
SIGSIM_API void MetinSetDefaults ( METIN *  metin)
SIGSIM_API int LoadMetinDefaultBands ( METIN *  metin)
SIGSIM_API int LoadATMFromPreFilledMetin ( char *  sigsim_data_dir,
char *  sigsim_cache_dir,
char *  atmcoef_file,
char *  modcard_file,
METIN *  metin,
jrmbool  atm_reset 
)
SIGSIM_API void CalculateEmaxAverages ( METIN *  metin)
SIGSIM_API int FillMetinDiurnalIrradiances ( METIN *  metin,
double  alt_m 
)
SIGSIM_API int SetBandStructure ( int *  nbands,
BAND **  band,
long *  nlambda,
double **  lambda,
char  c1Modtrn 
)
SIGSIM_API int SetupAtmosphericProfile ( jrmbool  atmreset,
jrmbool  dumcol,
char *  sigsim_data_dir,
char *  sigsim_cache_dir,
char *  atm_file,
char *  modcard_file,
long  nlayers,
METIN *  metin 
)
SIGSIM_API int AllocateAndFillMetinBackgroundSpec ( char *  sigsim_data_dir,
METIN *  metin,
char *  bathymetry_file,
char *  ms_file 
)
SIGSIM_API int AllocateSensors ( int  nsensors,
SENSOR **  sens 
)
SIGSIM_API int AllocateSingleSensorSpectra ( SENSOR *  sens,
int  nmmls,
jrmbool  INIT 
)
SIGSIM_API int AllocateSensorSpectra ( int  nsensors,
SENSOR **  sens,
int  nmmls 
)
SIGSIM_API void SetSensorDefaults ( SENSOR *  sensor)
SIGSIM_API void SetSensorTA_Props ( TA_PROPS *  taprops,
double  threshDetect,
double  threshClassify,
double  threshRecognize,
double  threshID,
double  persistTime 
)
SIGSIM_API int AddSensor ( SENSOR **  sens,
int  newNumSensors 
)
SIGSIM_API int RemoveSensor ( SENSOR **  sens,
int  numSensors,
int  sensorRemoveIndex 
)
SIGSIM_API int Free_Sensors ( SENSOR **  sens,
int  nsensors 
)
SIGSIM_API void Null_Sensor_Arrays ( SENSOR *  sens,
int  nsensors 
)
SIGSIM_API int Free_Sensor_Arrays ( SENSOR *  sens,
int  nsensors 
)
SIGSIM_API int AllocateAndFillAtmosphericBands ( int *  nbands,
BAND **  band,
int  nsensors,
SENSOR **  sens 
)
SIGSIM_API long ValidateSensorBandInputs ( SENSOR *  sensor)
SIGSIM_API int FillSensorResponse ( char *  filename,
SENSOR *  sensor 
)
SIGSIM_API int GetDynamicRange ( double *  Mmin,
double *  Mmax,
SENSOR *  sens 
)
SIGSIM_API int UpdateSensorState ( SENSOR *  sens,
ellipsoid  E,
double  simtime 
)
SIGSIM_API int ConstructSpectralDomain ( METIN *  metin,
int  nsensors,
SENSOR **  sens 
)
SIGSIM_API int InitializeMatSys ( jrmbool  matreset,
char *  sigsim_data_dir,
char *  ms_filename,
char *  ms_state_file,
long *  nmatls,
MATL_PROP_TABLE **  mp_table,
double  tod_start,
METIN *  metin 
)
int SkyColor ( SENSOR *  sens,
METIN *  metin,
int  num_entries,
CELESTIAL_TABLE *  LOS,
jrmbool  hitflag,
jrmbool  CROP 
)
SIGSIM_API int AllocateAndFillMetinTablesAndSpectralArrays ( char *  sigsim_data_dir,
METIN *  metin,
int  nsensors,
SENSOR **  sens,
char *  mmls_file,
char *  night_sky_file 
)
SIGSIM_API int ComputeSpectralReflectanceParameters ( long  matl_index,
MATL_PROP_TABLE *  mp_table,
BRDF_MODEL  brdf_model,
SPECTRAL_DOMAIN  spectrum,
MATL_SPECTRAL_TABLE *  mst 
)
SIGSIM_API int ComputeReflectanceParameters ( long  matl_index,
MATL_PROP_TABLE *  mp_table,
BRDF_MODEL  brdf_model,
SPECTRAL_DOMAIN  spectrum,
MATL_SPECTRAL_TABLE *  mst,
SENSOR *  sens 
)
int UpdateSensorPassbandEnvironment ( METIN *  metin,
SENSOR *  sens,
jrmbool  PaintStars,
jrmbool  PaintSky,
jrmbool  CROP 
)

Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)