seElectronics Class Reference

class seElectronics More...

Public Types
enum	ColorMapType {   Undefined_ColorMap = -1, UserDefined_ColorMap = 0, LADAR_ColorMap = 1, NVG_ColorMap = 2,   RG16_ColorMap = 3, LogScale_ColorMap = 4, UserDefinedRG_ColorMap = 5 }
	ColorMapType. More...

Public Member Functions
	seElectronics ()
	constructor
	~seElectronics ()
	destructor
void	loadDefaults ()
	sets all the member data to default values.
void	setFrameRate (const double rate)
	sets the assumed frame rate of the sensor (Hz) used to determine the sampling rate of the noise.
double	getFrameRate ()
	gets the assumed frame rate of the sensor (Hz) used to determine the sampling rate of the noise.
void	setPostCutoffFreq (const double freq)
	sets the post cutoff frequency of the sensor (Hz) specifies the time between noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq
double	getPostCutoffFreq ()
	gets the post cutoff frequency of the sensor specifies the time between noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq
void	setPreCutonFreq (const double freq)
	sets the pre cuton frequency of the sensor specifies the total time of the noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq
double	getPreCutonFreq ()
	gets the post cutoff frequency of the sensor specifies the total time of the noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq
void	setManualGain (const double gain)
	sets the manual gain of the sensor
double	getManualGain ()
	gets the manual gain of the sensor
void	setManualLevel (const double level)
	sets the manual level of the sensor
double	getManualLevel ()
	gets the manual level of the sensor
void	setPreGain (const double gain)
	sets the pre-gain of the sensor - this gain is always used whethere gain/level is enabled or not
double	getPreGain ()
	gets the pre-gain of the sensor
void	setPreLevel (const double level)
	sets the pre-level of the sensor
double	getPreLevel ()
	gets the pre-level of the sensor
void	setAGCMaxGain (const double gain)
	sets the max gain to be used by AGC
double	getAGCMaxGain ()
	gets the max gain to be used by AGC
void	setAGCMinGain (const double gain)
	sets the min gain to be used by AGC
double	getAGCMinGain ()
	gets the min gain to be used by AGC
void	setMaxRadiance (const double maxRad)
	sets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data set to 1.0 if 32bit radiance is input image.
double	getMaxRadiance ()
	gets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data
void	setMinRadiance (const double minRad)
	sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data set to 0.0 if 32bit radiance is input image.
double	getMinRadiance ()
	sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data
void	setMaxLutRadiance (const double maxLutRad)
	sets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data (LUT) set to 1.0 if 32bit radiance is input image.
double	getMaxLutRadiance ()
	gets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data (LUT)
void	setMinLutRadiance (const double minLutRad)
	sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data (LUT) set to 0.0 if 32bit radiance is input image.
double	getMinLutRadiance ()
	sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data (LUT)
void	setLogScaleEnable (const bool flag)
	sets the log scale enable flag for final log scale to the display.
bool	isLogScaleEnable ()
	gets the log scale enable flag for final log scale to the display.
void	setBlackHotEnable (const bool flag)
	sets the Black Hot enable flag to show a black hot IR image.
bool	isBlackHotEnable ()
	gets the Black Hot enable flag to show a black hot IR image.
void	setGainEnable (const bool flag)
	sets the gain enable flag - this overrides the AC coupling and AGC enable flags.
bool	isGainEnable ()
	gets the gain enable flag.
void	setInternalGainEnable (const bool flag)
	sets the enable flag indicating whether the gain/level are applied internal to SenSimRt or is applied externally during the rendering.
bool	isInternalGainEnable ()
	gets the enable flag indicating whether the gain/level are applied internal to SenSimRt or is applied externally during the rendering.
void	setACcouplingEnable (const bool flag)
	sets the AC coupling enable flag
bool	isACcouplingEnable ()
	gets the AC coupling enable flag.
void	setAGCEnable (const bool flag)
	sets the automatic gain control (AGC) enable flag
bool	isAGCEnable ()
	gets the automatic gain control (AGC) enable flag
void	setGainAdjustment (double adjustment)
	sets the adjustment that is multiplied by the manual gain setting.
double	getGainAdjustment ()
	gets the adjustment that is multiplied by the manual gain setting.
void	setLevelAdjustment (double adjustment)
	sets the adjustment that is added to the manual level setting.
double	getLevelAdjustment ()
	gets the adjustment that is added to the manual level setting.
void	setNumDisplayPixels (const long width, const long height)
	sets the number of pixels of the final display window
void	getNumDisplayPixels (long &width, long &height)
	gets the number of pixels of the final display window
void	setDisplayOffset (const long offsetX, const long offsetY, bool clearBuffer=true)
	sets the number of pixels to offset the image on the screen For instance to display a 512x512 image in the center of a 1kx1k window set the number of display pixels to 512x512 and set the offsets to 256x256 If set to -1,-1, then the image is upsampled to fill the display window.
void	getDisplayOffset (long &offsetX, long &offsetY, bool &clearBuffer)
	gets the number of pixels to offset the image on the screen The clearBuffer parameter will cause the framebuffer to be cleared first.
void	getDisplayOffset (long &offsetX, long &offsetY)
	gets the number of pixels to offset the image on the screen (this function maintains backswards compatibilty for when clearBuffer flag wasn't available).
bool	isDirty ()
	Specifies whether the seElectronics has been changed.
void	setDirty ()
	Specify whether the seElectronics has been changed.
void	clrDirty ()
	Clear the flag that specifies whether the seElectronics has been changed.
void	setColorMapType (ColorMapType newColorMapType)
	sets the color map type.
ColorMapType	getColorMapType ()
	gets the color map type.
void	setColorMapEnable (const bool flag)
	sets the color map enable flag.
bool	isColorMapEnable ()
	gets the color map enable flag.
void	setFullColorOutputEnable (const bool flag)
	sets the full color output enable flag.
bool	isFullColorOutputEnable ()
	gets the full color output enable flag.
bool	loadUserDefinedRadianceLUT (char *filename)
	Reads a 2-column radiance-to-pixelvalue LUT into memory.
char *	getColorMapUserDefinedRadFile ()
	Get the data used for the user defined color map.
void	setColorMapUserDefinedRadFile (const char *filepath)
	set the file name for the file to be used for a user defined color map.
void	loadColorMap (unsigned int *textureId)
	Load the color map into the texture specified by the texture id.
void	loadHistogramEqualizationMap (unsigned int *textureId, float *mapData, int size)
	load color map data for histogram equalization AGC technique

Private Attributes
double	m_frameRate
	assumed frame rate of the sensor - used for noise sampling rate
double	m_postCutoffFreq
	highest frequency of the noise - specifies time between noise samples
double	m_preCutonFreq
	lowest frequency of the noise - specifies total time of the noise samples
double	m_manualGain
	gain setting from manually adjusted knob/slider
double	m_manualLevel
	level setting from manually adjusted knob/slider
double	m_preGain
	gain setting that is always applied
double	m_preLevel
	level setting that is always applied
double	m_AGCMaxGain
	maximum gain used by AGC
double	m_AGCMinGain
	minimum gain used by AGC
double	m_maxRadiance
	radiance value corresponding to 1.0 in the input data
double	m_minRadiance
	radiance value corresponding to 0.0 in the input data
double	m_maxLutRadiance
	radiance value corresponding to 1.0 in the input data
double	m_minLutRadiance
	radiance value corresponding to 0.0 in the input data
bool	m_logScaleEnable
	log scale enable flag
bool	m_enableBlackHot
	Black Hot enable flag.
bool	m_gainEnable
	gain functions enable flag
bool	m_internalGainEnable
	flag indicating to do gain/level internal to SenSim rather than in the rendering pass
bool	m_ACcouplingEnable
	AC coupling enable flag.
bool	m_AGCEnable
	Automatic Gain Control (AGC) enable flag.
double	m_gainAdjustment
	adjustment value multiplied by the gain
double	m_levelAdjustment
	adjustment value added to the level
long	m_displayWidth
	number pixels in the display's width
long	m_displayHeight
	number pixels in the display's height
long	m_displayOffsetX
	number pixels to offset the image from the lower left corner of the display in the X direction
long	m_displayOffsetY
	number pixels to offset the image from the lower left corner of the display in the Y direction
bool	m_clearBufferFlag
	flag to indicate whether to clear the back buffer before rendering the final image
bool	m_dirty
	indicates the electronics have been changed and initialization needs to occur
bool	m_colorMapEnable
	indicates that a color mapping will be used
ColorMapType	m_currentColorMapType
	indicates which type of color mapping will be used
char	m_colorMapUserDefinedRadFile [512]
	a 2-column radiance-to-pixelvalue LUT.
unsigned int	m_ColorMapSize
	size of color map
float *	m_ColorMapData
	array with color map data
bool	m_fullColorOutputEnable
	flag indicating full color output vs. monochrome remapping.
float *	m_userdefLUTScaledRad
	— User-defined radiance to pixelvalue LUT

Detailed Description

class seElectronics

Sensor Effects electronics class. Holds the data related to the electronics portion of a device.

Member Enumeration Documentation

enum seElectronics::ColorMapType

ColorMapType.

Specifies the type of color map output for the color mapping feature

Enumerator:

Undefined_ColorMap
UserDefined_ColorMap
LADAR_ColorMap
NVG_ColorMap
RG16_ColorMap
LogScale_ColorMap
UserDefinedRG_ColorMap

Constructor & Destructor Documentation

seElectronics::seElectronics

(

)

constructor

seElectronics::~seElectronics

(

)

destructor

Member Function Documentation

void seElectronics::loadDefaults

(

)

sets all the member data to default values.

void seElectronics::setFrameRate ( const double  rate )

inline

sets the assumed frame rate of the sensor (Hz) used to determine the sampling rate of the noise.

Parameters

rate

double seElectronics::getFrameRate ( )

inline

gets the assumed frame rate of the sensor (Hz) used to determine the sampling rate of the noise.

Returns

double

void seElectronics::setPostCutoffFreq ( const double  freq )

inline

sets the post cutoff frequency of the sensor (Hz) specifies the time between noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq

Parameters

freq

double seElectronics::getPostCutoffFreq ( )

inline

gets the post cutoff frequency of the sensor specifies the time between noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq

Returns

double

void seElectronics::setPreCutonFreq ( const double  freq )

inline

sets the pre cuton frequency of the sensor specifies the total time of the noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq

Parameters

freq

double seElectronics::getPreCutonFreq ( )

inline

gets the post cutoff frequency of the sensor specifies the total time of the noise samples and also is used to specify the number of noise samples to generate where number of samples = postCutoffFreq / preCutOnFreq

Returns

double

void seElectronics::setManualGain ( const double  gain )

inline

sets the manual gain of the sensor

Parameters

gain

double seElectronics::getManualGain ( )

inline

gets the manual gain of the sensor

Returns

double

void seElectronics::setManualLevel ( const double  level )

inline

sets the manual level of the sensor

Parameters

level

double seElectronics::getManualLevel ( )

inline

gets the manual level of the sensor

Returns

double

void seElectronics::setPreGain ( const double  gain )

inline

sets the pre-gain of the sensor - this gain is always used whethere gain/level is enabled or not

Parameters

gain

double seElectronics::getPreGain ( )

inline

gets the pre-gain of the sensor

Returns

double

void seElectronics::setPreLevel ( const double  level )

inline

sets the pre-level of the sensor

Parameters

level

double seElectronics::getPreLevel ( )

inline

gets the pre-level of the sensor

Returns

double

void seElectronics::setAGCMaxGain ( const double  gain )

inline

sets the max gain to be used by AGC

Parameters

gain

double seElectronics::getAGCMaxGain ( )

inline

gets the max gain to be used by AGC

Returns

double

void seElectronics::setAGCMinGain ( const double  gain )

inline

sets the min gain to be used by AGC

Parameters

gain

double seElectronics::getAGCMinGain ( )

inline

gets the min gain to be used by AGC

Returns

double

void seElectronics::setMaxRadiance ( const double  maxRad )

inline

sets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data set to 1.0 if 32bit radiance is input image.

Parameters

maxRad

double seElectronics::getMaxRadiance ( )

inline

gets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data

Returns

double

void seElectronics::setMinRadiance ( const double  minRad )

inline

sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data set to 0.0 if 32bit radiance is input image.

Parameters

minRad

double seElectronics::getMinRadiance ( )

inline

sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data

Returns

double

void seElectronics::setMaxLutRadiance ( const double  maxLutRad )

inline

sets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data (LUT) set to 1.0 if 32bit radiance is input image.

Parameters

maxLutRad

double seElectronics::getMaxLutRadiance ( )

inline

gets the maximum radiance of the device which is the Radiance level that corresponds with 1.0 in input data (LUT)

Returns

double

void seElectronics::setMinLutRadiance ( const double  minLutRad )

inline

sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data (LUT) set to 0.0 if 32bit radiance is input image.

Parameters

minLutRad

double seElectronics::getMinLutRadiance ( )

inline

sets the minimum radiance of the device which is the Radiance level that corresponds with 0.0 in input data (LUT)

Returns

double

void seElectronics::setLogScaleEnable ( const bool  flag )

inline

sets the log scale enable flag for final log scale to the display.

Parameters

flag

bool seElectronics::isLogScaleEnable ( )

inline

gets the log scale enable flag for final log scale to the display.

Returns

bool

void seElectronics::setBlackHotEnable ( const bool  flag )

inline

sets the Black Hot enable flag to show a black hot IR image.

Parameters

flag

bool seElectronics::isBlackHotEnable ( )

inline

gets the Black Hot enable flag to show a black hot IR image.

Returns

bool

void seElectronics::setGainEnable ( const bool  flag )

inline

sets the gain enable flag - this overrides the AC coupling and AGC enable flags.

Parameters

flag

bool seElectronics::isGainEnable ( )

inline

gets the gain enable flag.

Returns

bool

void seElectronics::setInternalGainEnable ( const bool  flag )

inline

sets the enable flag indicating whether the gain/level are applied internal to SenSimRt or is applied externally during the rendering.

Parameters

flag

bool seElectronics::isInternalGainEnable ( )

inline

gets the enable flag indicating whether the gain/level are applied internal to SenSimRt or is applied externally during the rendering.

Returns

bool

void seElectronics::setACcouplingEnable ( const bool  flag )

inline

sets the AC coupling enable flag

Parameters

flag

bool seElectronics::isACcouplingEnable ( )

inline

gets the AC coupling enable flag.

Returns

bool

void seElectronics::setAGCEnable ( const bool  flag )

inline

sets the automatic gain control (AGC) enable flag

Parameters

flag

bool seElectronics::isAGCEnable ( )

inline

gets the automatic gain control (AGC) enable flag

Returns

bool

void seElectronics::setGainAdjustment ( double  adjustment )

inline

sets the adjustment that is multiplied by the manual gain setting.

This can be used as an adjustment knob/slider.

Parameters

adjustment

- 0 to 1.0

double seElectronics::getGainAdjustment ( )

inline

gets the adjustment that is multiplied by the manual gain setting.

This can be used as an adjustment knob/slider.

Returns

double

void seElectronics::setLevelAdjustment ( double  adjustment )

inline

sets the adjustment that is added to the manual level setting.

This can be used as an adjustment knob/slider.

Parameters

adjustment

double seElectronics::getLevelAdjustment ( )

inline

gets the adjustment that is added to the manual level setting.

This can be used as an adjustment knob/slider.

Returns

double

void seElectronics::setNumDisplayPixels ( const long  width, const long  height  )

inline

sets the number of pixels of the final display window

Parameters

width
height

void seElectronics::getNumDisplayPixels ( long &  width, long &  height  )

inline

gets the number of pixels of the final display window

Parameters

width
height

void seElectronics::setDisplayOffset ( const long  offsetX, const long  offsetY, bool  clearBuffer = true  )

inline

sets the number of pixels to offset the image on the screen For instance to display a 512x512 image in the center of a 1kx1k window set the number of display pixels to 512x512 and set the offsets to 256x256 If set to -1,-1, then the image is upsampled to fill the display window.

Parameters

offsetX	- offset image in X direction from the lower left corner
offsetY	- offset image in Y direction from the lower left corner
clearBuffer	- when offsets are not -1,-1 this flag determines whether the back buffer should be cleared.

void seElectronics::getDisplayOffset ( long &  offsetX, long &  offsetY, bool &  clearBuffer  )

inline

gets the number of pixels to offset the image on the screen The clearBuffer parameter will cause the framebuffer to be cleared first.

Parameters

offsetX
offsetY
clearBuffer

void seElectronics::getDisplayOffset ( long &  offsetX, long &  offsetY  )

inline

gets the number of pixels to offset the image on the screen (this function maintains backswards compatibilty for when clearBuffer flag wasn't available).

Parameters

offsetX
offsetY

bool seElectronics::isDirty ( )

inline

Specifies whether the seElectronics has been changed.

Returns

bool

void seElectronics::setDirty ( )

inline

Specify whether the seElectronics has been changed.

void seElectronics::clrDirty ( )

inline

Clear the flag that specifies whether the seElectronics has been changed.

void seElectronics::setColorMapType ( ColorMapType  newColorMapType )

inline

sets the color map type.

Parameters

newColorMapType

ColorMapType seElectronics::getColorMapType ( )

inline

gets the color map type.

Returns

ColorMapType

void seElectronics::setColorMapEnable ( const bool  flag )

inline

sets the color map enable flag.

Parameters

flag

bool seElectronics::isColorMapEnable ( )

inline

gets the color map enable flag.

Returns

bool

void seElectronics::setFullColorOutputEnable ( const bool  flag )

inline

sets the full color output enable flag.

Parameters

flag

bool seElectronics::isFullColorOutputEnable ( )

inline

gets the full color output enable flag.

Returns

bool

bool seElectronics::loadUserDefinedRadianceLUT

(

char *

filename

)

Reads a 2-column radiance-to-pixelvalue LUT into memory.

char* seElectronics::getColorMapUserDefinedRadFile

(

)

Get the data used for the user defined color map.

void seElectronics::setColorMapUserDefinedRadFile

(

const char *

filepath

)

set the file name for the file to be used for a user defined color map.

void seElectronics::loadColorMap

(

unsigned int *

textureId

)

Load the color map into the texture specified by the texture id.

void seElectronics::loadHistogramEqualizationMap	(	unsigned int *	textureId,
		float *	mapData,
		int	size
	)

load color map data for histogram equalization AGC technique

Member Data Documentation

double seElectronics::m_frameRate

private

assumed frame rate of the sensor - used for noise sampling rate

double seElectronics::m_postCutoffFreq

private

highest frequency of the noise - specifies time between noise samples

double seElectronics::m_preCutonFreq

private

lowest frequency of the noise - specifies total time of the noise samples

double seElectronics::m_manualGain

private

gain setting from manually adjusted knob/slider

double seElectronics::m_manualLevel

private

level setting from manually adjusted knob/slider

double seElectronics::m_preGain

private

gain setting that is always applied

double seElectronics::m_preLevel

private

level setting that is always applied

double seElectronics::m_AGCMaxGain

private

maximum gain used by AGC

double seElectronics::m_AGCMinGain

private

minimum gain used by AGC

double seElectronics::m_maxRadiance

private

radiance value corresponding to 1.0 in the input data

double seElectronics::m_minRadiance

private

radiance value corresponding to 0.0 in the input data

double seElectronics::m_maxLutRadiance

private

radiance value corresponding to 1.0 in the input data

double seElectronics::m_minLutRadiance

private

radiance value corresponding to 0.0 in the input data

bool seElectronics::m_logScaleEnable

private

log scale enable flag

bool seElectronics::m_enableBlackHot

private

Black Hot enable flag.

bool seElectronics::m_gainEnable

private

gain functions enable flag

bool seElectronics::m_internalGainEnable

private

flag indicating to do gain/level internal to SenSim rather than in the rendering pass

bool seElectronics::m_ACcouplingEnable

private

AC coupling enable flag.

bool seElectronics::m_AGCEnable

private

Automatic Gain Control (AGC) enable flag.

double seElectronics::m_gainAdjustment

private

adjustment value multiplied by the gain

double seElectronics::m_levelAdjustment

private

adjustment value added to the level

long seElectronics::m_displayWidth

private

number pixels in the display's width

long seElectronics::m_displayHeight

private

number pixels in the display's height

long seElectronics::m_displayOffsetX

private

number pixels to offset the image from the lower left corner of the display in the X direction

long seElectronics::m_displayOffsetY

private

number pixels to offset the image from the lower left corner of the display in the Y direction

bool seElectronics::m_clearBufferFlag

private

flag to indicate whether to clear the back buffer before rendering the final image

bool seElectronics::m_dirty

private

indicates the electronics have been changed and initialization needs to occur

bool seElectronics::m_colorMapEnable

private

indicates that a color mapping will be used

ColorMapType seElectronics::m_currentColorMapType

private

indicates which type of color mapping will be used

char seElectronics::m_colorMapUserDefinedRadFile[512]

private

a 2-column radiance-to-pixelvalue LUT.

unsigned int seElectronics::m_ColorMapSize

private

size of color map

float* seElectronics::m_ColorMapData

private

array with color map data

bool seElectronics::m_fullColorOutputEnable

private

flag indicating full color output vs. monochrome remapping.

float* seElectronics::m_userdefLUTScaledRad

private

— User-defined radiance to pixelvalue LUT

---

The documentation for this class was generated from the following file:

• seElectronics.h