ciDetector Class Reference

Public Member Functions
double	getDwellTime ()
void	setDwellTime (double dwellTime)
double	getNET ()
void	setNET (double NET)
double	getFixedPatternNoisePercent ()
void	setFixedPatternNoisePercent (double percentNoise)
double	getNER ()
void	setNER (double NER)
double	getNoiseFreqKnee ()
void	setNoiseFreqKnee (double noiseFreqKnee)
double	getNoiseFreqExp ()
void	setNoiseFreqExp (double noiseFreqExp)
double	getResolutionScale ()
void	setResolutionScale (double resolutionScale)
double	getPitchDetH ()
void	setPitchDetH (double pitchDetH)
double	getPitchDetV ()
void	setPitchDetV (double pitchDetV)
double	getBackTemp ()
void	setBackTemp (double backTemp)
double	getPercentPixelFill ()
void	setPercentPixelFill (double pixelFill)
double	getPercentDeadPixel ()
void	setPercentDeadPixel (double deadPixel)
long	getNumDetStaresH ()
	returns the number of detectors in the horizontal direction
void	setNumDetStaresH (long numDetStaresH)
	sets the number of detectors in the horizontal direction
long	getNumDetStaresV ()
void	setNumDetStaresV (long numDetStaresV)
double	getStartWavelength ()
void	setStartWavelength (double startWavelength)
double	getEndWavelength ()
void	setEndWavelength (double endWavelength)
void	setPoissonNoisePercent (double percent)
double	getPoissonNoisePercent ()
void	setFInverseNoisePercent (double percent)
double	getFInverseNoisePercent ()
void	setSensorIndex (int sensorIndex)
int	getSensorIndex ()
void	setScanMaskMinGain (float minGain)
float	getScanMaskMinGain ()
void	setScanMaskMaxGain (float maxGain)
float	getScanMaskMaxGain ()
void	setScanMaskMinLevel (float minLevel)
float	getScanMaskMinLevel ()
void	setScanMaskMaxLevel (float maxLevel)
float	getScanMaskMaxLevel ()
void	setScanMaskLineSpacing (int lineSpacing)
int	getScanMaskLineSpacing ()
void	setScanMaskEnable (bool enable)
bool	getScanMaskEnable ()
void	setScanMaskGainFilename (char *gainFilename)
char *	getScanMaskGainFilename ()
void	setScanMaskLevelFilename (char *levelFilename)
char *	getScanMaskLevelFilename ()
void	setScanMaskDirection (int direction)
int	getScanMaskDirection ()
void	setScanMaskUserDefined (bool userDefined)
bool	getScanMaskUserDefined ()
void	setFullColorEnable (bool enable)
bool	getFullColorEnable ()
bool	archive (std::ofstream &outf, int idx=0)
int	serialize (char *filepath, int idx)
bool	loadXML (clXMLNode *xmlParentNode)
bool	parseXML (clXML &xmlDocument)
bool	loadXMLNode (std::string tag, char *nodeString)
bool	loadXMLNode (std::string tag, bool *nodeBool)
bool	loadXMLNode (std::string tag, int *nodeInt)
bool	loadXMLNode (std::string tag, long *nodeLong)
bool	loadXMLNode (std::string tag, double *nodeDouble)
void	saveXML (clXML *xmlDocument)
int	serializeCheck (char *filepath)
	Checks the saved configuration file for whether it has more than one panel saved.
ciDetector	operator= (ciDetector &obj)
	ciDetector ()
	ciDetector (ciDetector &obj)
virtual	~ciDetector ()

Protected Attributes
double	m_startWavelength
double	m_endWavelength
double	m_dwellTime
double	m_NET
double	m_FixedNoisePercent
double	m_noiseFreqExp
double	m_noiseFreqKnee
long	m_numDetStaresH
long	m_numDetStaresV
double	m_pitchDetH
double	m_pitchDetV
double	m_backTemp
double	m_NER
double	m_percentPixelFill
double	m_percentDeadPixel
double	m_resolutionScale
double	m_percentPoisson
double	m_percentFInverse
bool	m_scanMaskEnable
char	m_scanMaskGainFilename [512]
char	m_scanMaskLevelFilename [512]
int	m_scanMaskDirection
float	m_scanMaskMinGain
float	m_scanMaskMaxGain
float	m_scanMaskMinLevel
float	m_scanMaskMaxLevel
int	m_scanMaskLineSpacing
bool	m_scanMaskUserDefined
bool	m_fullColorEnable
int	m_sensorIndex
clXMLNode *	m_parentNode

Detailed Description

ciDetector class declaration

Constructor & Destructor Documentation

ciDetector::ciDetector

(

)

Default constructor.

ciDetector::ciDetector

(

ciDetector &

obj

)

Copy constructor.

Parameters

obj	- ciDetector object to be copied.

virtual ciDetector::~ciDetector ( )

virtual

Member Function Documentation

double ciDetector::getDwellTime ( )

inline

gets the dwell time.

Returns

The dwell time.

void ciDetector::setDwellTime ( double  dwellTime )

inline

sets the dwell time.

Parameters

DwellTime

- The dwell time.

Returns

void.

double ciDetector::getNET ( )

inline

gets the NET (noise equivalent Temperature).

Returns

The NET (noise equivalent temperature).

void ciDetector::setNET ( double  NET )

inline

sets the NET (noise equivalent Temperature).

Parameters

NET	(noise equivalent Temperature).

Returns

void.

double ciDetector::getFixedPatternNoisePercent ( )

inline

gets the Percent of NEDT (noise equivalent delta temperature) fixed pattern noise.

Returns

The percent Fixed Pattern Noise NEDT.

void ciDetector::setFixedPatternNoisePercent ( double  percentNoise )

inline

sets the Percent of NEDT (noise equivalent delta temperature) fixed pattern noise.

Parameters

percentNEDT

(percent noise equivalent delta temperature).

Returns

void.

double ciDetector::getNER ( )

inline

gets the NER (noise equivalent radiance).

Returns

void.

void ciDetector::setNER ( double  NER )

inline

sets the NER (noise equivalent radiance).

Returns

void.

double ciDetector::getNoiseFreqKnee ( )

inline

gets the noise frequency knee.

Returns

the noise frequency knee.

void ciDetector::setNoiseFreqKnee ( double  noiseFreqKnee )

inline

sets the Noise Frequency Knee

Parameters

noiseFreqKnee

- The Noise Frequency Knee to be assigned.

Returns

void.

double ciDetector::getNoiseFreqExp ( )

inline

gets the noise frequency exponent.

Returns

the noise frequency exponent.

void ciDetector::setNoiseFreqExp ( double  noiseFreqExp )

inline

sets the noise frequency exponent

Parameters

noiseFreqExp

- The Noise Frequency exponent to be assigned.

Returns

void.

double ciDetector::getResolutionScale ( )

inline

gets the resolution scale.

Returns

The resolution scale.

void ciDetector::setResolutionScale ( double  resolutionScale )

inline

sets the resolutionscale.

Parameters

numDetStaresV

- The number of Detector stares vertical to be assigned.

Returns

void.

double ciDetector::getPitchDetH ( )

inline

gets the horizontal Detector pitch.

Returns

The horizontal detector pitch.

void ciDetector::setPitchDetH ( double  pitchDetH )

inline

sets the horizontal detector pitch.

Parameters

pitchDetH

- The horizontal detector pitch to be assigned.

Returns

void.

double ciDetector::getPitchDetV ( )

inline

gets the vertical Detector pitch.

Returns

The vertical detector pitch.

void ciDetector::setPitchDetV ( double  pitchDetV )

inline

sets the vertical detector pitch.

Parameters

pitchDetV

- The vertical detector pitch to be assigned.

Returns

void.

double ciDetector::getBackTemp ( )

inline

gets the background temperature [deg K].

Returns

The background temperature in degrees Kelvin.

void ciDetector::setBackTemp ( double  backTemp )

inline

sets the background temperature [deg K].

Parameters

backTemp

- The background temperature [deg K] to be assigned.

Returns

void.

double ciDetector::getPercentPixelFill ( )

inline

gets the percent pixel fill.

Returns

the percent pixel fill.

void ciDetector::setPercentPixelFill ( double  pixelFill )

inline

sets the percent pixel fill.

Parameters

pixelFill

- The percent pixel fill to be assigned.

Returns

void.

double ciDetector::getPercentDeadPixel ( )

inline

gets the percent dead pixel.

Returns

the percent dead pixel.

void ciDetector::setPercentDeadPixel ( double  deadPixel )

inline

sets the percent dead pixel.

Parameters

deadPixel

- The percent dead pixel to be assigned.

Returns

void.

long ciDetector::getNumDetStaresH ( )

inline

returns the number of detectors in the horizontal direction

Returns

long - The number of Detector stares horizontal

void ciDetector::setNumDetStaresH ( long  numDetStaresH )

inline

sets the number of detectors in the horizontal direction

Parameters

long	numDetStaresH - number of horizontal dectectors to be used

long ciDetector::getNumDetStaresV ( )

inline

gets the number of Detector stares vertical.

Returns

The number of Detector stares vertical.

void ciDetector::setNumDetStaresV ( long  numDetStaresV )

inline

sets the number of Detector stares vertical.

Parameters

numDetStaresV

- The number of Detector stares vertical to be assigned.

Returns

void.

double ciDetector::getStartWavelength ( )

inline

gets the starting wavelength.

Returns

The starting wavelength.

void ciDetector::setStartWavelength ( double  startWavelength )

inline

sets the starting wavelength.

Parameters

startWavelength

- The starting wavelength to be assigned.

Returns

void.

double ciDetector::getEndWavelength ( )

inline

gets the ending wavelength.

Returns

The ending wavelength.

void ciDetector::setEndWavelength ( double  endWavelength )

inline

sets the ending wavelength.

Parameters

endWavelength

- The ending wavelength to be assigned.

Returns

void.

void ciDetector::setPoissonNoisePercent ( double  percent )

inline

Parameters

double

percent

double ciDetector::getPoissonNoisePercent ( )

inline

Returns

double

void ciDetector::setFInverseNoisePercent ( double  percent )

inline

Parameters

double

percent

double ciDetector::getFInverseNoisePercent ( )

inline

Returns

double

void ciDetector::setSensorIndex ( int  sensorIndex )

inline

Parameters

int	sensorIndex

int ciDetector::getSensorIndex ( )

inline

Returns

int

void ciDetector::setScanMaskMinGain ( float  minGain )

inline

float ciDetector::getScanMaskMinGain ( )

inline

void ciDetector::setScanMaskMaxGain ( float  maxGain )

inline

float ciDetector::getScanMaskMaxGain ( )

inline

void ciDetector::setScanMaskMinLevel ( float  minLevel )

inline

float ciDetector::getScanMaskMinLevel ( )

inline

void ciDetector::setScanMaskMaxLevel ( float  maxLevel )

inline

float ciDetector::getScanMaskMaxLevel ( )

inline

void ciDetector::setScanMaskLineSpacing ( int  lineSpacing )

inline

int ciDetector::getScanMaskLineSpacing ( )

inline

void ciDetector::setScanMaskEnable ( bool  enable )

inline

bool ciDetector::getScanMaskEnable ( )

inline

void ciDetector::setScanMaskGainFilename

(

char *

gainFilename

)

char* ciDetector::getScanMaskGainFilename ( )

inline

void ciDetector::setScanMaskLevelFilename

(

char *

levelFilename

)

char* ciDetector::getScanMaskLevelFilename ( )

inline

void ciDetector::setScanMaskDirection ( int  direction )

inline

int ciDetector::getScanMaskDirection ( )

inline

void ciDetector::setScanMaskUserDefined ( bool  userDefined )

inline

bool ciDetector::getScanMaskUserDefined ( )

inline

void ciDetector::setFullColorEnable ( bool  enable )

inline

bool ciDetector::getFullColorEnable ( )

inline

bool ciDetector::archive	(	std::ofstream &	outf,
		int	idx = 0
	)

Description:

Saves the ciOptics object to file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

int ciDetector::serialize	(	char *	filepath,
		int	idx
	)

Description:

Loads the panel storage object from file.

Parameters

filepath

- complete path and filename to the file

Returns

int - the style of the saved panel(s) (0 = no panels saved)(1 = one panel saved)(2 = one or more panels saved)

bool ciDetector::loadXML

(

clXMLNode *

xmlParentNode

)

bool ciDetector::parseXML

(

clXML &

xmlDocument

)

bool ciDetector::loadXMLNode	(	std::string	tag,
		char *	nodeString
	)

Parameters

std::string	tag
char	*nodeString

Returns

bool

bool ciDetector::loadXMLNode	(	std::string	tag,
		bool *	nodeBool
	)

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

bool ciDetector::loadXMLNode	(	std::string	tag,
		int *	nodeInt
	)

Parameters

std::string	tag
int	*nodeInt

Returns

bool

bool ciDetector::loadXMLNode	(	std::string	tag,
		long *	nodeLong
	)

Parameters

std::string	tag
long	*nodeLong

Returns

bool

bool ciDetector::loadXMLNode	(	std::string	tag,
		double *	nodeDouble
	)

Parameters

std::string	tag
double	*nodeDouble

Returns

bool

void ciDetector::saveXML

(

clXML *

xmlDocument

)

int ciDetector::serializeCheck

(

char *

filepath

)

Checks the saved configuration file for whether it has more than one panel saved.

Parameters

char	*filepath - path of the configuration file that is being checked.

Returns

int - the style of the saved panel(s) (0 = no panels saved)(1 = one panel saved)(2 = one or more panels saved)

ciDetector ciDetector::operator=

(

ciDetector &

obj

)

Assignment operator.

Parameters

obj	- ciOptics object to be assigned.

Returns

The assigned ciOptics object.

Member Data Documentation

double ciDetector::m_startWavelength

protected

starting wavelength [microns]

double ciDetector::m_endWavelength

protected

ending wavelength [microns]

double ciDetector::m_dwellTime

protected

dwell time

double ciDetector::m_NET

protected

Noise Equivalent Temperature [deg K].

double ciDetector::m_FixedNoisePercent

protected

Percent Fixed Pattern Noise [NEDT]

double ciDetector::m_noiseFreqExp

protected

Noise Frequency Exponent

double ciDetector::m_noiseFreqKnee

protected

Noise Frequency Knee

long ciDetector::m_numDetStaresH

protected

Num Det Stares Horizontal

long ciDetector::m_numDetStaresV

protected

Num Det Stares Vertical

double ciDetector::m_pitchDetH

protected

Detector pitch Horizontal

double ciDetector::m_pitchDetV

protected

Detector pitch Vertical

double ciDetector::m_backTemp

protected

Background Temperature [deg K]

double ciDetector::m_NER

protected

Noise Equivalent Radiance

double ciDetector::m_percentPixelFill

protected

Percent Pixel Fill

double ciDetector::m_percentDeadPixel

protected

Percent dead Pixel

double ciDetector::m_resolutionScale

protected

double ciDetector::m_percentPoisson

protected

double ciDetector::m_percentFInverse

protected

bool ciDetector::m_scanMaskEnable

protected

char ciDetector::m_scanMaskGainFilename[512]

protected

char ciDetector::m_scanMaskLevelFilename[512]

protected

int ciDetector::m_scanMaskDirection

protected

float ciDetector::m_scanMaskMinGain

protected

float ciDetector::m_scanMaskMaxGain

protected

float ciDetector::m_scanMaskMinLevel

protected

float ciDetector::m_scanMaskMaxLevel

protected

int ciDetector::m_scanMaskLineSpacing

protected

bool ciDetector::m_scanMaskUserDefined

protected

bool ciDetector::m_fullColorEnable

protected

int ciDetector::m_sensorIndex

protected

clXMLNode* ciDetector::m_parentNode

protected

---

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

• ciDetector.h