mmlsources.h

Go to the documentation of this file.

/* © 1998 JRM Technologies, Inc.*/



/***********************************
Copyright JRM Enterprises, Inc. 1998
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.
***********************************/

#ifndef _MMLS_H_
#define _MMLS_H_


#include <math.h>

//#include "windows.h"

#include "JRMDefines.h"
#include "JRMlibrary.h"
#include "SigSimDefines.h"
#include "SourceData.h"
#include "sigsimDLLstub.h"

#define LOW_LIMIT 1.0E-24

#ifdef __cplusplus
extern "C"
{
#endif


typedef enum
{
    UNKNOWN_PLANCK = 0, // Unknown light source types with Planckian Distributions
   TUNGSTEN,      // Tungsten Filament Light Sources with Planckian Distribution
   HALOGEN,    // Halogen
    MERCURY_CAP,  // Mercury Capillary Lamps
   MERCURY_VAP,   // Mercury Vapor Lamps
    MERCURY_PURE, // Pure Mercury Lamps
    SODIUM,       // Sodium Lamps
   HPSODIUM,      // High-Pressure Sodium Lamps
    XENON,        // Xenon Lamps
    STRONTIUM,    // Carbon Arc Strontium-3
    ENCLOSEDARC,  // Carbon Arc EnclosedArc
    POLYMETAL3,      // Carbon Arc Polymetallic-3
    POLYMETAL4,      // Carbon Arc Polymetallic-4
    RAREEARTH1,      // Carbon Arc RareEarth-1
    RAREEARTH1_5, // Carbon Arc RareEarth-1.5
    RAREEARTH1_9, // Carbon Arc RareEarth-1.9
    RAREEARTH2_85,   // Carbon Arc RareEarth-2.85
    RAREEARTH3,      // Carbon Arc RareEarth-3
    RAREEARTH4    // Carbon Arc RareEarth-4
}  MMLS_TYPE;

#define NUM_MMLS_TYPES 19



typedef struct
{
   // --- INPUTS ---
   char MS_ID[50];      // Arbitrary light source type name. Formerly needed to be one of the string values in the list incorporated in the MMLS_Type() function. 
                  // If source type is UNKNOWN_PLANCK, this string will be checked to see if it contains a path to an existing 2-column file on disk specifying a custom power density spectrum.
   MMLS_TYPE type;      // light source type code
   RGB filter;       // [1] Optional Vis-band color filter (default = 1.0 in each channel).
                  // For this purpose, wavebands are defined as follows:  B = {0.4-0.5 um}, G = {0.5-0.6 um}, R = {0.6-0.7 um}. 
   VECTOR pos;       // [m] Vector defining manmade light source position in the scene NED system. [Only used for predicting irradiance, not radiance]
   VECTOR dir;       // [Unitless cosines] Unit vector defining light source direction in the scene NED system.    [Only used for predicting irradiance, not radiance]
                  // Will be used for spotlights. If all three components are zeros, the source is not a spotlight
   double T;         // [degK] Effective black-body temperature of filament, read from input file, but overridden if not tungsten type.
   double Tbulb;     // [degK] Effective bulb temperature (calculated output!)
   double P;         // [W] source power, read from input file
   double etha;      // [unitless real (0-1)], field that gives a sense of source efficiency (i.e. fraction of input power P converted into EM light field. Read from input file
   double area;      // [cm2] Effective area of light source (bulb), read from input file. If <=0 then default value of 400cm2 is used.
   //double k;       // [W/m/degK] Thermal conductivity of glass or other material through which excess heat is conducted, read from input file.
   double thickness; // [cm] Thickness of glass or other material through which excess heat is conducted, read from input file.
   double mm_ls_cutoff;// [deg] Spotlight cutoff angle (<180deg for spotlights, =360deg otherwise)
   double curvature; // [1] = 1 for flat area lights, or JRM_PI for spherical bulbs.

   // --- OUTPUTS ---
   double* rad;      // [W/m2/sr/um] Output Spectral radiance array of size metin.nlambda.
   double Kc;        // [unitless] Constant term in denominator of OpenGL attenuation factor
   double Kl;        // [m-1] Coefficient of term linear in range in denominator of OpenGL attenuation factor
   double Kq;        // [m-2] Coefficient of term quadratic in range in denominator of OpenGL attenuation factor
}  MANMADE_LIGHTSOURCE_TABLE; 


   MMLS_TYPE MMLS_Type(char *s_type);
    int ComputeSingleSourceSpectralPower(MANMADE_LIGHTSOURCE_TABLE mm_lstable, SPECTRAL_DOMAIN spectrum, double *power);
    int GetLSConstructionMaterialSpectralEmissivity(SPECTRAL_DOMAIN spectrum, double *emissivity);
    int GetPlanckSpectralShape(double degK, SPECTRAL_DOMAIN spectrum, double *shape);
    int GetNonPlanckSpectralShape(MMLS_TYPE source_type, SPECTRAL_DOMAIN spectrum, double *shape);

   SIGSIM_API int ComputeSingleSourceIrradiance(MANMADE_LIGHTSOURCE_TABLE *mm_lstable, VECTOR SurfacePositionNED, VECTOR SurfaceNormalNED, SPECTRAL_DOMAIN spectrum, double *irradiance, double air_temperature);
   SIGSIM_API int AllocateManmadeLightSourceTables(int num_mm_ls, MANMADE_LIGHTSOURCE_TABLE **mm_lstable);
   SIGSIM_API int Free_ManmadeLightSourceTables(MANMADE_LIGHTSOURCE_TABLE **mmlstable);


#ifdef __cplusplus
}
#endif

#endif //_MMLS_H_