class: seDetector More...

Public Types
enum	ScanDirectionType { InvalidScanDirection = -1, HorizontalScanDirection = 0, VerticalScanDirection = 1, FullImageScan = 2, NumScanDirection = 3 }
	ScanDirectionType. More...

Public Member Functions
	seDetector ()
	constructor
	~seDetector ()
	destructor
void	loadDefaults ()
	sets all the member data to default values.
void	setBandpass (const double ax, const double bx)
	sets the bandpass of the detector
void	getBandpass (double &ax, double &bx) const
	gets the bandpass of the detector
void	setNumDetectors (const long width, const long height)
	sets the number of detectors of the sensor
void	getNumDetectors (long &width, long &height) const
	gets the number of detectors of the sensor
void	setPitchDetectors (const double pitchHorz, const double pitchVert)
	sets the size of detectors of the sensor (mm)
void	getPitchDetectors (double &pitchHorz, double &pitchVert) const
	gets the size of detectors of the sensor (mm)
void	setDwellTime (const double dwellTime)
	sets the dwell time of the detectors (usec)
double	getDwellTime () const
	gets the dwell time of the detectors (usec)
void	setNoiseFrequencyKnee (const double freqKnee)
	sets the noise frequency knee 1/f point the detectors (hz)
void	setPoissonNoisePercent (double percent)
double	getPoissonNoisePercent () const
void	setFInverseNoisePercent (double percent)
double	getFInverseNoisePercent () const
double	getNoiseFrequencyKnee () const
	gets the noise frequency knee 1/f point the detectors (hz)
void	setNoiseFrequencyExp (const double freqExp)
	sets the noise frequency exponent 1/f point the detectors (hz)
double	getNoiseFrequencyExp () const
	gets the noise frequency exponent 1/f point the detectors (hz)
void	setNoiseEquivalentTemp (const double temp)
	sets the noise equivalent temperature of the detectors
double	getNoiseEquivalentTemp () const
	gets the noise equivalent temperature of the detectors (hz)
void	setBackgroundTemp (const double temp)
	sets the background temperature (degK)
double	getBackgroundTemp () const
	gets the aperture's horizontal to vertical aspect ratio
void	setFixedPatternNoisePercent (double temp)
	sets the percent of the overall noise that is fixed pattern noise(FPN)
double	getFixedPatternNoisePercent () const
	gets the percent of the overall noise that is fixed pattern noise(FPN)
void	setNoiseEquivalentRadiance (double temp)
	sets the noise equivalent temperature of the detectors (hz)
double	getNoiseEquivalentRadiance () const
	gets the noise equivalent radiance of the detectors (hz)for visual bands
void	setPercentPixelFill (double temp)
	sets the percent pixel fill - 100 to remove it's affect below 100% causes the image to be more blurry
double	getPercentPixelFill () const
	gets the percent pixel fill
void	setPercentDeadPixel (double temp)
	sets the percent of the overall pixels that are dead
double	getPercentDeadPixel () const
	gets the percent of the overall pixels that are dead
void	setNoiseEnable (const bool flag)
	sets the noise enable flag
bool	isFullColorEnable () const
	gets the Full Color Enable flag.
void	setFullColorEnable (const bool flag)
	sets the Full Color Enable flag
void	getChannelSelects (float &redSelect, float &greenSelect, float &blueSelect) const
	gets the channel select values for determining which input channels are used.
void	setChannelSelects (float redSelect, float greenSelect, float blueSelect)
	sets the channel select values for determining which input channels are used.
bool	isScanningSensorEnable () const
	gets the Scanning Sensor Enable flag.
void	setScanningSensorEnable (const bool flag)
	sets the Scanning Sensor Enable flag
void	setScanMaskFilename (char *scanMaskFileName)
	set the file name for the scan mask image - each pixel in image is a gain applied in the final pass
char *	getScanMaskFilename ()
	get the file name for the scan mask image
void	setScanMaskGainFilename (char *scanMaskFileName)
	set the file name for the scan mask image - each pixel in image is a gain applied in the final pass
char *	getScanMaskGainFilename ()
	get the file name for the scan mask image
void	setScanMaskLevelFilename (char *scanMaskFileName)
	set the file name for the scan mask image - each pixel in image is a level applied in the final pass
char *	getScanMaskLevelFilename ()
	get the file name for the scan mask image
void	setScanMask (float minGain, float maxGain, ScanDirectionType scanDirection, int lineSpacing=1, float minLevel=0.0, float maxLevel=0.0)
	setup Scan Mask with scan direction, scan line spacing, etc to fill the texture with the appropriate gain for each pixel on the screen
float	getScanMaskMaxGain () const
	gets the maximum gain desired for the scan mask for the scanning sensor
void	setScanMaskMaxGain (float val)
	sets the maximum gain desired for the scan mask for the scanning sensor
float	getScanMaskMinGain () const
	gets the minimum gain desired for the scan mask for the scanning sensor
void	setScanMaskMinGain (float val)
	sets the minimum gain desired for the scan mask for the scanning sensor
float	getScanMaskMaxLevel () const
	gets the maximum level desired for the scan mask for the scanning sensor
void	setScanMaskMaxLevel (float val)
	sets the maximum Level desired for the scan mask for the scanning sensor
float	getScanMaskMinLevel () const
	gets the minimum gain desired for the scan mask for the scanning sensor
void	setScanMaskMinLevel (float val)
	sets the minimum Level desired for the scan mask for the scanning sensor
ScanDirectionType	getScanMaskDirection () const
	gets the scan direction desired for the scan mask for the scanning sensor
void	setScanMaskDirection (ScanDirectionType val)
	sets the scan direction desired for the scan mask for the scanning sensor
int	getScanMaskLineSpacing () const
	gets the line spacing desired for the scan mask for the scanning sensor
void	setScanMaskLineSpacing (int val)
	sets the line spacing desired for the scan mask for the scanning sensor
void	setScanMaskLevelAdjustment (double adjustment)
	sets the adjustment that is multiplied by the scan mask level value.
double	getScanMaskLevelAdjustment () const
	gets the adjustment that is multiplied by the scan mask level value.
bool	getScanMaskUserDefined () const
	return whether user defined is set.
void	setScanMaskUserDefined (bool userDefined)
	Set the new user defined parameter.
bool	isNoiseEnable () const
	gets the noise enable flag.
void	setNoiseAdjustment (double adjustment)
	sets the adjustment that is multiplied by the calculated noise intensity.
double	getNoiseAdjustment () const
	getNoiseAdjustment
void	setMotionBlurEnable (const bool flag)
	sets the motion blur enable flag
bool	isMotionBlurEnable () const
	gets the motion blur enable flag.
void	setMotionBlurWeight (double weight)
	sets the weight of the blur.
double	getMotionBlurWeight () const
	gets the weight of the motion blur.
void	setWeightThreshold (double threshold)
	sets the threshold used to determine which weights are significant enough to use.
double	getWeightThreshold () const
	gets the threshold used to determine which weights are significant enough to use.
bool	isDirty () const
	Specifies whether the seDetector has been changed.
void	setDirty ()
	Specify whether the seDetector has been changed.
void	clrDirty ()
	Clear the flag indicating that seDetector has been changed.
bool	isScanMaskDirty () const
	Specifies whether the scan mask parameters have been changed.
void	setScanMaskDirty ()
	Specify whether the scan mask parameters have been changed.
void	clrScanMaskDirty ()
	Clear the flag indicating that the scan mask parameters have been changed.

Private Attributes
double	m_ax
	starting wavelength (um)
double	m_bx
	ending wavelength (um)
long	m_detectorWidth
	number of horizontal detectors
long	m_detectorHeight
	number of vertical detectors
double	m_horizontalPitch
	horizontal pitch of each detectors (mm)
double	m_verticalPitch
	horizontal pitch of each detectors (mm)
double	m_dwellTime
	dwell time of a detector (us)
double	m_noiseFrequencyKnee
	noise frequency knee 1/f point the detectors (hz)
double	m_noiseFrequencyExp
	noise frequency exponent 1/f point the detectors (hz)
double	m_noiseEquivalentTemp
	temperature delta of the noise (degK)
double	m_BackgroundTemp
	background temperature (degK)
double	m_percentFixedNoise
	percent of the overall noise that is fixed pattern noise
double	m_noiseEquivRadiance
	radiance delta of the noise (uW/cm2/sr)
double	m_precentPixelFill
	percent of the pixel that is covered by the detector
double	m_percentDeadPixel
	percent of the pixels that are broken and provide no output
double	m_percentPoisson
	percent of the overall noise that is Poisson noise
double	m_percentFInverse
	percent of the overall noise that is F-Inverse noise
bool	m_noiseEnable
	noise enable flag
double	m_noiseAdjustment
	adjustment multiplied by the noise gain
double	m_weightThreshold
	threshold used to determine which weights are significant enough to use
bool	m_motionBlurEnable
	motion blur enable flag
double	m_motionBlurWeight
	motion blur weight to adjust the amount of motion blur
bool	m_FullColorEnable
	set as full color input for 3 color EO sensors.
float	m_redSelect
	the red channel select value for determining how much of the red channel is used.
float	m_greenSelect
	the green channel select value for determining how much of the red channel is used.
float	m_blueSelect
	the blue channel select value for determining how much of the red channel is used.
bool	m_scanningSensorEnable
	set as scanning sensor and cause scanning streaks in image.
char	m_scanMaskGainFileName [255]
char	m_scanMaskLevelFileName [255]
	A single channel *.bmp for per channel level.
ScanDirectionType	m_scanMaskDirection
	the scan mask direction setting.
float	m_scanMaskMinGain
	the scan mask direction setting.
float	m_scanMaskMaxGain
	the scan mask direction setting.
float	m_scanMaskMinLevel
	the scan mask direction setting.
float	m_scanMaskMaxLevel
	the scan mask direction setting.
int	m_scanMaskLineSpacing
	the scan mask direction setting.
bool	m_scanMaskDirty
	dirty flag for scan mask
double	m_scanMaskLevelAdjustment
	controls the amount of the level mask to apply - 1.0 full effect, 0.0 no effect.
bool	m_scanMaskUserDefined
	New parameter to select a user defined scan mask, works same as before if set to false.
bool	m_dirty
	dirty flag for detector object

Detailed Description

class: seDetector

Sensor Effects detector class. Holds the data related to the device's detectors.

Member Enumeration Documentation

enum seDetector::ScanDirectionType

ScanDirectionType.

Specifies the type of scan direction for the scan mask feature

Enumerator:

InvalidScanDirection
HorizontalScanDirection
VerticalScanDirection
FullImageScan
NumScanDirection

Constructor & Destructor Documentation

seDetector::seDetector ( )

constructor

seDetector::~seDetector ( )

destructor

Member Function Documentation

void seDetector::loadDefaults ( )

sets all the member data to default values.

void seDetector::setBandpass	(	const double	ax,
		const double	bx
	)

inline

sets the bandpass of the detector

Parameters

ax	- start wavelength
bx	- end wavelength

void seDetector::getBandpass	(	double &	ax,
		double &	bx
	)		const

inline

gets the bandpass of the detector

Parameters

ax	- lower wavelength
bx	- upper wavelength

void seDetector::setNumDetectors	(	const long	width,
		const long	height
	)

inline

sets the number of detectors of the sensor

Parameters

width	- number of horizontal detectors
height	- number of vertical detectors

void seDetector::getNumDetectors	(	long &	width,
		long &	height
	)		const

inline

gets the number of detectors of the sensor

Parameters

width	- number of horizontal detectors
height	- number of vertical detectors

Referenced by seGpuProcessor::getResolutionRatio().

void seDetector::setPitchDetectors	(	const double	pitchHorz,
		const double	pitchVert
	)

inline

sets the size of detectors of the sensor (mm)

Parameters

pitchHorz	- horizontal pitch of detector
pitchVert	- vertical pitch of detector

void seDetector::getPitchDetectors	(	double &	pitchHorz,
		double &	pitchVert
	)		const

inline

gets the size of detectors of the sensor (mm)

Parameters

pitchHorz	- horizontal pitch of detector
pitchVert	- vertical pitch of detector

void seDetector::setDwellTime ( const double dwellTime )

inline

sets the dwell time of the detectors (usec)

Parameters

dwellTime

double seDetector::getDwellTime ( ) const

inline

gets the dwell time of the detectors (usec)

Returns: double

void seDetector::setNoiseFrequencyKnee ( const double freqKnee )

inline

sets the noise frequency knee 1/f point the detectors (hz)

Parameters

freqKnee

void seDetector::setPoissonNoisePercent ( double percent )

inline

Parameters

percent

double seDetector::getPoissonNoisePercent ( ) const

inline

Returns: double

void seDetector::setFInverseNoisePercent ( double percent )

inline

Parameters

percent

double seDetector::getFInverseNoisePercent ( ) const

inline

Returns: double

double seDetector::getNoiseFrequencyKnee ( ) const

inline

gets the noise frequency knee 1/f point the detectors (hz)

Returns: double

void seDetector::setNoiseFrequencyExp ( const double freqExp )

inline

sets the noise frequency exponent 1/f point the detectors (hz)

Parameters

freqExp

double seDetector::getNoiseFrequencyExp ( ) const

inline

gets the noise frequency exponent 1/f point the detectors (hz)

Returns: double

void seDetector::setNoiseEquivalentTemp ( const double temp )

inline

sets the noise equivalent temperature of the detectors

Parameters

temp

double seDetector::getNoiseEquivalentTemp ( ) const

inline

gets the noise equivalent temperature of the detectors (hz)

Returns: double

void seDetector::setBackgroundTemp ( const double temp )

inline

sets the background temperature (degK)

Parameters

temp

double seDetector::getBackgroundTemp ( ) const

inline

gets the aperture's horizontal to vertical aspect ratio

Returns: double

void seDetector::setFixedPatternNoisePercent ( double temp )

inline

sets the percent of the overall noise that is fixed pattern noise(FPN)

Parameters

temp

double seDetector::getFixedPatternNoisePercent ( ) const

inline

gets the percent of the overall noise that is fixed pattern noise(FPN)

Returns: double

void seDetector::setNoiseEquivalentRadiance ( double temp )

inline

sets the noise equivalent temperature of the detectors (hz)

Parameters

temp

double seDetector::getNoiseEquivalentRadiance ( ) const

inline

gets the noise equivalent radiance of the detectors (hz)for visual bands

Returns: double

void seDetector::setPercentPixelFill ( double temp )

inline

sets the percent pixel fill - 100 to remove it's affect below 100% causes the image to be more blurry

Parameters

temp

double seDetector::getPercentPixelFill ( ) const

inline

gets the percent pixel fill

Returns: double

void seDetector::setPercentDeadPixel ( double temp )

inline

sets the percent of the overall pixels that are dead

Parameters

temp

double seDetector::getPercentDeadPixel ( ) const

inline

gets the percent of the overall pixels that are dead

Returns: double

void seDetector::setNoiseEnable ( const bool flag )

inline

sets the noise enable flag

Parameters

flag

bool seDetector::isFullColorEnable ( ) const

inline

gets the Full Color Enable flag.

Returns: bool

void seDetector::setFullColorEnable ( const bool flag )

inline

sets the Full Color Enable flag

Parameters

flag

void seDetector::getChannelSelects	(	float &	redSelect,
		float &	greenSelect,
		float &	blueSelect
	)		const

inline

gets the channel select values for determining which input channels are used.

Each value is multiplied by the appropriate channel and the sum is passed thru the rest of the processing.

Parameters

redSelect	- select value for the red channel
greenSelect	- select value for the red channel
blueSelect	- select value for the red channel

void seDetector::setChannelSelects	(	float	redSelect,
		float	greenSelect,
		float	blueSelect
	)

inline

sets the channel select values for determining which input channels are used.

Each value is multiplied by the appropriate channel and the sum is passed thru the rest of the processing.

Parameters

redSelect	- select value for the red channel
greenSelect	- select value for the red channel
blueSelect	- select value for the red channel

bool seDetector::isScanningSensorEnable ( ) const

inline

gets the Scanning Sensor Enable flag.

Returns: bool

void seDetector::setScanningSensorEnable ( const bool flag )

inline

sets the Scanning Sensor Enable flag

Parameters

flag

void seDetector::setScanMaskFilename ( char * scanMaskFileName )

inline

set the file name for the scan mask image - each pixel in image is a gain applied in the final pass

Parameters

scanMaskFileName

char* seDetector::getScanMaskFilename ( )

inline

get the file name for the scan mask image

Returns: char *scanMaskFileName

void seDetector::setScanMaskGainFilename ( char * scanMaskFileName )

set the file name for the scan mask image - each pixel in image is a gain applied in the final pass

Parameters

scanMaskFileName

char* seDetector::getScanMaskGainFilename ( )

get the file name for the scan mask image

Returns: char *scanMaskFileName

void seDetector::setScanMaskLevelFilename ( char * scanMaskFileName )

set the file name for the scan mask image - each pixel in image is a level applied in the final pass

Parameters

scanMaskFileName

char* seDetector::getScanMaskLevelFilename ( )

get the file name for the scan mask image

Returns: char *scanMaskLevelFileName

void seDetector::setScanMask	(	float	minGain,
		float	maxGain,
		ScanDirectionType	scanDirection,
		int	lineSpacing = `1`,
		float	minLevel = `0.0`,
		float	maxLevel = `0.0`
	)

setup Scan Mask with scan direction, scan line spacing, etc to fill the texture with the appropriate gain for each pixel on the screen

Parameters

minGain
maxGain
scanDirection
lineSpacing
minLevel
maxLevel

float seDetector::getScanMaskMaxGain ( ) const

inline

gets the maximum gain desired for the scan mask for the scanning sensor

Returns: maxGain

void seDetector::setScanMaskMaxGain ( float val )

sets the maximum gain desired for the scan mask for the scanning sensor

Parameters

val

float seDetector::getScanMaskMinGain ( ) const

inline

gets the minimum gain desired for the scan mask for the scanning sensor

Returns: minGain

void seDetector::setScanMaskMinGain ( float val )

sets the minimum gain desired for the scan mask for the scanning sensor

Parameters

val

float seDetector::getScanMaskMaxLevel ( ) const

inline

gets the maximum level desired for the scan mask for the scanning sensor

Returns: maxLevel

void seDetector::setScanMaskMaxLevel ( float val )

sets the maximum Level desired for the scan mask for the scanning sensor

Parameters

val

float seDetector::getScanMaskMinLevel ( ) const

inline

gets the minimum gain desired for the scan mask for the scanning sensor

Returns: minLevel

void seDetector::setScanMaskMinLevel ( float val )

sets the minimum Level desired for the scan mask for the scanning sensor

Parameters

val

ScanDirectionType seDetector::getScanMaskDirection ( ) const

inline

gets the scan direction desired for the scan mask for the scanning sensor

Returns: ScanDirectionType scan direction

void seDetector::setScanMaskDirection ( ScanDirectionType val )

sets the scan direction desired for the scan mask for the scanning sensor

Parameters

val

int seDetector::getScanMaskLineSpacing ( ) const

inline

gets the line spacing desired for the scan mask for the scanning sensor

Returns: float line spacing

void seDetector::setScanMaskLineSpacing ( int val )

sets the line spacing desired for the scan mask for the scanning sensor

Parameters

val

void seDetector::setScanMaskLevelAdjustment ( double adjustment )

inline

sets the adjustment that is multiplied by the scan mask level value.

This can be used as an adjustment knob/slider for real-time control of the effect.

Parameters

adjustment - 0.0 to 1.0

double seDetector::getScanMaskLevelAdjustment ( ) const

inline

gets the adjustment that is multiplied by the scan mask level value.

This can be used as an adjustment knob/slider for real-time control of the effect.

Returns: adjustment from 0.0 to 1.0

bool seDetector::getScanMaskUserDefined ( ) const

return whether user defined is set.

New parameter. False means it works the same as before it was added.

void seDetector::setScanMaskUserDefined ( bool userDefined )

Set the new user defined parameter.

If not set, use the files if they exist, if they don't exist: use scanDirection.

bool seDetector::isNoiseEnable ( ) const

inline

gets the noise enable flag.

Returns: bool

void seDetector::setNoiseAdjustment ( double adjustment )

inline

sets the adjustment that is multiplied by the calculated noise intensity.

This can be used as an adjustment knob/slider.

Parameters

adjustment - 0.0 to 1.0

double seDetector::getNoiseAdjustment ( ) const

inline

getNoiseAdjustment

gets the adjustment that is multiplied by the calculated noise intensity. This can be used as an adjustment knob/slider.

Returns: adjustment from 0.0 to 1.0

void seDetector::setMotionBlurEnable ( const bool flag )

inline

sets the motion blur enable flag

Parameters

flag

bool seDetector::isMotionBlurEnable ( ) const

inline

gets the motion blur enable flag.

Returns: bool

void seDetector::setMotionBlurWeight ( double weight )

inline

sets the weight of the blur.

Parameters

weight - 0.0 to 1.0

double seDetector::getMotionBlurWeight ( ) const

inline

gets the weight of the motion blur.

Returns: weight from 0.0 to 1.0

void seDetector::setWeightThreshold ( double threshold )

inline

sets the threshold used to determine which weights are significant enough to use.

The lower this is set the more a hot/bright area will bloom, but performance will drop.

Parameters

threshold

double seDetector::getWeightThreshold ( ) const

inline

gets the threshold used to determine which weights are significant enough to use.

Returns: double

bool seDetector::isDirty ( ) const

inline

Specifies whether the seDetector has been changed.

Returns: bool

void seDetector::setDirty ( )

inline

Specify whether the seDetector has been changed.

void seDetector::clrDirty ( )

inline

Clear the flag indicating that seDetector has been changed.

bool seDetector::isScanMaskDirty ( ) const

inline

Specifies whether the scan mask parameters have been changed.

Returns: bool

void seDetector::setScanMaskDirty ( )

inline

Specify whether the scan mask parameters have been changed.

void seDetector::clrScanMaskDirty ( )

inline

Clear the flag indicating that the scan mask parameters have been changed.

Member Data Documentation

double seDetector::m_ax

private

starting wavelength (um)

double seDetector::m_bx

private

ending wavelength (um)

long seDetector::m_detectorWidth

private

number of horizontal detectors

long seDetector::m_detectorHeight

private

number of vertical detectors

double seDetector::m_horizontalPitch

private

horizontal pitch of each detectors (mm)

double seDetector::m_verticalPitch

private

horizontal pitch of each detectors (mm)

double seDetector::m_dwellTime

private

dwell time of a detector (us)

double seDetector::m_noiseFrequencyKnee

private

noise frequency knee 1/f point the detectors (hz)

double seDetector::m_noiseFrequencyExp

private

noise frequency exponent 1/f point the detectors (hz)

double seDetector::m_noiseEquivalentTemp

private

temperature delta of the noise (degK)

double seDetector::m_BackgroundTemp

private

background temperature (degK)

double seDetector::m_percentFixedNoise

private

percent of the overall noise that is fixed pattern noise

double seDetector::m_noiseEquivRadiance

private

radiance delta of the noise (uW/cm2/sr)

double seDetector::m_precentPixelFill

private

percent of the pixel that is covered by the detector

double seDetector::m_percentDeadPixel

private

percent of the pixels that are broken and provide no output

double seDetector::m_percentPoisson

private

percent of the overall noise that is Poisson noise

double seDetector::m_percentFInverse

private

percent of the overall noise that is F-Inverse noise

bool seDetector::m_noiseEnable

private

noise enable flag

double seDetector::m_noiseAdjustment

private

adjustment multiplied by the noise gain

double seDetector::m_weightThreshold

private

threshold used to determine which weights are significant enough to use

bool seDetector::m_motionBlurEnable

private

motion blur enable flag

double seDetector::m_motionBlurWeight

private

motion blur weight to adjust the amount of motion blur

bool seDetector::m_FullColorEnable

private

set as full color input for 3 color EO sensors.

float seDetector::m_redSelect

private

the red channel select value for determining how much of the red channel is used.

float seDetector::m_greenSelect

private

the green channel select value for determining how much of the red channel is used.

float seDetector::m_blueSelect

private

the blue channel select value for determining how much of the red channel is used.

bool seDetector::m_scanningSensorEnable

private

set as scanning sensor and cause scanning streaks in image.

char seDetector::m_scanMaskGainFileName[255]

private

char seDetector::m_scanMaskLevelFileName[255]

private

A single channel *.bmp for per channel level.

ScanDirectionType seDetector::m_scanMaskDirection

private