sigsim.h

Go to the documentation of this file.

/* © 1998 JRM Technologies, Inc.*/


#include "sigsimDLLstub.h"

#ifdef __cplusplus
extern "C"
{
#endif

//SIGSIM49_API int Free_SIMPLE_BACKGROUND_SPEC(SIMPLE_BACKGROUND_SPEC *background, jrmbool INITFLAG);
//SIGSIM49_API int AddSIMPLE_BACKGROUND_SPEC(SIMPLE_BACKGROUND_SPEC **c, int *nc, SIMPLE_BACKGROUND_SPEC toadd);
//SIGSIM49_API int Free_Metin_Arrays(METIN *metin);
//SIGSIM49_API int Free_LightSourceTables(LIGHT_SOURCE_TABLE *lstable, int nlstables);
//SIGSIM49_API int Free_ManmadeLightSourceTables(MANMADE_LIGHTSOURCE_TABLE *mmlstable);
//SIGSIM49_API int Free_Sensors(SENSOR *sens, int nsensors);
//SIGSIM49_API int Free_Sensor_Arrays(SENSOR *sens, int nsensors);
//SIGSIM49_API int Free_MatlOGLTables(MATL_OGL_TABLE **mogl);
//SIGSIM49_API int Free_MatlPropTables(MATL_PROP_TABLE **mp_table, long num_matls);
//SIGSIM49_API int Free_MatlPropTable_Arrays(MATL_PROP_TABLE *mp_table);
//SIGSIM49_API int Initialize_MatlPropTable_Arrays(MATL_PROP_TABLE *mp_table);
//SIGSIM49_API int Free_Objects(OBJECT **object);
//SIGSIM49_API int Free_Acquires(ACQUIRE *acquire);
//SIGSIM49_API int Free_Prophets(PROPHET *prophet);
//SIGSIM49_API int Free_ACSs(ACS *acs);
//SIGSIM49_API int Free_MatlSpecTableArrays(MATL_SPECTRAL_TABLE *mst);
//SIGSIM49_API int Free_SPECTRAL_DOMAIN_Arrays(SPECTRAL_DOMAIN *spectrum);
//SIGSIM49_API void FreeSpectrum(SPECTRUM *spectrum);

/* ---------------- GENERAL NATIVE DATA TYPE ARRAYS ------------------ */

//SIGSIM49_API int AddVector(int *NV, VECTOR **V, VECTOR toadd);
//SIGSIM49_API int RemoveVector(VECTOR **V, int *NV, int index);
//SIGSIM49_API void FreeVectors(int *NV, VECTOR **V);
//SIGSIM49_API int AddInt(int **c, int *nc, int toadd);
//SIGSIM49_API int InsertInt(int **F, int *nF, int toinsert, int index);
//SIGSIM49_API int RemoveInt(int **F, int *nF, int index);
//SIGSIM49_API void FreeIntArray(int **c, int *nc, jrmbool init);
//SIGSIM49_API int AddDouble(double **c, int *nc, double toadd);
//SIGSIM49_API int RemoveDouble(double **F, int *nF, int index);
//SIGSIM49_API void FreeDoubleArray(double **c, int *nc, jrmbool init);
//SIGSIM49_API void FreeDOUBLE_TABLE(DOUBLE_TABLE *c, jrmbool init);
//SIGSIM49_API void FreeDOUBLE_TABLEArray(DOUBLE_TABLE **c, int *nc, jrmbool init);
//SIGSIM49_API int AllocateDOUBLE_TABLEArray(DOUBLE_TABLE **c, int nc);
//SIGSIM49_API int CopyDOUBLE_TABLE(DOUBLE_TABLE in, DOUBLE_TABLE *out);
//SIGSIM49_API int Free_Double_Array(long **array);
//SIGSIM49_API void FreeComplexArray(complex **c, int *nc, jrmbool init);
//SIGSIM49_API int Allocate_Complex_Array(complex **array, long nvals);
//SIGSIM49_API int Free_Long_Array(long **array);
//SIGSIM49_API int Free_Char_Array(char **array);
//SIGSIM49_API int LoadDoubleArrayFromScanline(char *scanline, double **c, int *nc);
//SIGSIM49_API int AllocateMATERIAL_EIGENFRACTIONSArray(MATERIAL_EIGENFRACTIONS **matlfraction, long nmatls, int neigenmaterials);
//SIGSIM49_API int AllocateMATERIAL_EIGENFRACTIONSFractionArrays(MATERIAL_EIGENFRACTIONS **matlfraction, long nmatls, int neigenmaterials);
//SIGSIM49_API void FreeMATERIAL_EIGENFRACTIONSArray(MATERIAL_EIGENFRACTIONS **matlfraction, long nmatls);
//SIGSIM49_API int AllocateSpectrum(SPECTRUM *spectrum, long nlambda);

//SIGSIM49_API int FreeScatterLayerArrays(METIN *metin);
//SIGSIM49_API int AllocateScatterLayerArrays(METIN *metin);

SIGSIM49_API void MetinSetDefaults(METIN *metin);

//void SigSimStructInit(METIN *metin, LIGHT_SOURCE_TABLE **ls_table, MATL_PROP_TABLE **mp_table, MATL_OGL_TABLE **mogl_table, SENSOR **sens);
SIGSIM49_API int SetBandStructure(int *nbands, BAND** band, long* nlambda, double** lambda, char c1Modtrn);
//int Update_MS_BoundaryConditions(char *sigsim_data_dir, char *ms_filename, char *ms_state_file, long *nmatls, MATL_PROP_TABLE **mp_table, MATL_OGL_TABLE **mogl_table, double tod_start, METIN *metin);
//int InitializeMatSysAndMatOGL(jrmbool matreset, char *sigsim_data_dir, char *ms_filename, char *ms_state_file, long *nmatls, MATL_PROP_TABLE **mp_table, MATL_OGL_TABLE **mogl_table, double tod_start, METIN *metin);
//int InitializeSpecATM(jrmbool atmreset, jrmbool dumcol, char *sigsim_data_dir, char *atm_file, char *night_sky_file, METIN *metin, long nlayers, int nsensors, SENSOR *sens, LIGHT_SOURCE_TABLE *lstable);
//int AllocateSensors(int nsensors, SENSOR **sens);
//int AllocateSingleSensorSpectra(SENSOR *sens, int nmmls, jrmbool INIT);
//int AllocateSensorSpectra(int nsensors, SENSOR *sens, int nmmls);
//int AllocateLightSourceTables(int num_ls, LIGHT_SOURCE_TABLE **ls_table);
//int AllocateManMadeLightSourceOGLOutput(int num_ls, LIGHT_SOURCE_TABLE **ls_table, int nmmls);
//int AllocateManmadeLightSourceTables(int num_mm_ls, MANMADE_LIGHTSOURCE_TABLE **mm_lstable);
//int AllocateAndFillMetinTablesAndSpectralArrays(char *sigsim_data_dir, METIN *metin, int nsensors, SENSOR **sens, char *night_sky_file);
SIGSIM49_API int SetupAtmosphericProfile(jrmbool atmreset, jrmbool dumcol, char *sigsim_data_dir, char *atm_file, char *modcard_file, long nlayers, METIN *metin);
int AllocateAndFillAtmosphericBands(int *nbands, BAND **band, int nsensors, SENSOR **sens);
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);
SIGSIM49_API int AllocateMetinSpectralArrays(METIN *metin);
SIGSIM49_API void FreeMetinSpectralArrays(METIN *metin);
SIGSIM49_API void CalculateEmaxAverages(METIN *metin);
SIGSIM49_API int FillMetinDiurnalIrradiances(METIN *metin);
// int Allocate_MATL_SPECTRAL_TABLE_Arrays(BRDF_MODEL brdf_type, long nlambda, MATL_SPECTRAL_TABLE *mst);
// int UpdateEnvironment(double alt, METIN *metin)
// int ComputeSpectralReflectanceParameters(long matl_index, MATL_PROP_TABLE *mp_table, BRDF_MODEL brdf_type, SPECTRAL_DOMAIN spectrum, MATL_SPECTRAL_TABLE *mst) ;
//double UpdateMaterialSystemSpectralRadiometric(double* range, long matl_index, long nmatls, MATL_PROP_TABLE *mp_table, METIN *metin, SENSOR *sens, jrmbool hitflag);
//int UpdateAtObjectSpectralSignature(long matl_index, long nmatls, MATL_PROP_TABLE *mp_table, METIN *metin, SENSOR *sens, BRDF_MODEL brdf_model, SPECTRAL_DOMAIN spectrum, MATL_SPECTRAL_TABLE *mst);
//int UpdateAtApertureSpectralSignature(SENSOR *sens, long nlambda, double *lambda_um, MATL_SPECTRAL_TABLE *mst);
//VECTOR OrientationInMetSEU(EPHEMERIS fm, VECTOR orientNED, GEOCENTRIC_LOCATION C);
long GetMPIndex(MATL_PROP_TABLE mp_table, enum ReflectType RT, enum Polarization PL, double lambda);
int WriteMetinDiurnalIrradiances(METIN *metin, char *filename);
int ReadMetinDiurnalIrradiances(METIN *metin, char *filename);
//int AddSensor(SENSOR** sens, int newNumSensors);
//int RemoveSensor(SENSOR** sens, int numSensors, int sensorRemoveIndex);
//int MergeDomains(SPECTRAL_DOMAIN *output, SPECTRAL_DOMAIN input1, SPECTRAL_DOMAIN input2);
//int MergeSpectra(SPECTRAL_DOMAIN *outX, double **outY,  SPECTRAL_DOMAIN inX1, double *inY1, SPECTRAL_DOMAIN inX2, double *inY2, jrmbool ZeroFlag, jrmbool InterpolateFlag);
//int MultiplySpectra(SPECTRUM *base, SPECTRUM tomultiply, jrmbool ZeroFlag, jrmbool InterpolateFlag);
//int ShiftSpectralDomain(SPECTRAL_DOMAIN spectrum, jrmbool CenterFlag);
//int ShiftSpectrum(SPECTRAL_DOMAIN spectrum, double *Y, jrmbool CenterFlag);
//int Allocate_Double_Array(double **array, long nvals);
//int Free_Double_Array(double **array);
//int Read2ColumnFile(char *filename, double **xvalues, double **yvalues, long *nvalues); // BE SURE TO USE Free_Double_Array() on these to deallocate memory !
//int Write2ColumnFile(char *filename, double *xvalues, double *yvalues, long nvalues);
//int ReadASDSpectralFile(char *filename, double **xvalues, double **yvalues, long *nvalues);
//int ReadASDSpectralFileWithHeaders(char *filename, double **xvalues, double **yvalues, long *nvalues);
//int ReadDNPSpectralFile(char *filename, double **xvalues, double **yvalues, long *nvalues);
//int ReadUSGSSpectralFile(char *filename, double **xvalues, double **yvalues, long *nvalues);
//int SmoothSpectrum2(double MaxVar, double VarSpan, SPECTRAL_DOMAIN xin, double *yin, double *yout, double ax, double bx);
//SIGSIM49_API int FillSensorResponse(char *filename, SENSOR *sensor);
SIGSIM49_API void ArrayConvertWithFlags(SPECTRAL_DOMAIN baseX, double *convertedY, SPECTRAL_DOMAIN toconvertX, double *toconvertY, double Factor, jrmbool ZeroFlag, jrmbool InterpolateFlag);

// check the registration license, the preferred method
// if policiesMsg is sepcified as non-NULL, then upon success it receives a human-readable string with details regarding the acquired license (e.g. activation / expiration times, usage / maintenance periods, etc.)
SIGSIM49_API int SigSimRegistrationCheck(char *const policiesMsg, const size_t policiesMsgSize);
// check the registration license, the old method
SIGSIM49_API int reg_check(const char* iRegPath);
SIGSIM49_API const char *getSigSimVersion();
SIGSIM49_API int SigSimCheckExpirationDate(char *expirationDate);


#ifdef __cplusplus
}
#endif