ciElectronics Class Reference

Public Member Functions
double	getFrameRate ()
void	setFrameRate (double frameRate)
double	getPreCutonFreq ()
void	setPreCutonFreq (double preCutonFreq)
double	getPostCutoffFreq ()
void	setPostCutoffFreq (double postCutoffFreq)
double	getGain ()
void	setGain (double gain)
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	setAGCGainThreshold (const double threshold)
	sets the gain threshold to be used by AGC
double	getAGCGainThreshold ()
	gets the gain threshold used by AGC
void	setAGCMode (const int mode)
	sets the AGC mode
int	getAGCMode ()
	gets the AGC mode
void	setPercentGain (double percent)
double	getPercentGain ()
void	setPercentLevel (double percent)
double	getPercentLevel ()
double	getLevel ()
void	setLevel (double level)
int	getColorMapType ()
void	setColorMapType (int type)
char *	getColorMapUserDefinedRadFile ()
void	setColorMapUserDefinedRadFile (const char *filepath)
int	getColorMapEnable ()
void	setColorMapEnable (int enable)
void	setBitDepthOutput (bool enable, float bitDepth)
	sets the desired bit depth output buffer.
void	getBitDepthOutput (bool &enable, float &bitDepth) const
	Returns the desired bit depth output and the state on whether it is enabled or not.
void	setSensorIndex (int sensorIndex)
int	getSensorIndex ()
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.
ciElectronics	operator= (ciElectronics &obj)
	ciElectronics ()
	ciElectronics (ciElectronics &obj)
virtual	~ciElectronics ()
	Deconstructor.

Protected Attributes
double	m_frameRate
double	m_preCutonFreq
double	m_postCutoffFreq
double	m_gain
double	m_level
double	m_AGCMaxGain
double	m_AGCMinGain
double	m_AGCGainThreshold
int	m_AGCMode
double	m_percentGain
double	m_percentLevel
int	m_sensorIndex
int	m_colorMapType
char	m_colorMapUserDefinedRadFile [512]
int	m_colorMapEnable
float	m_bitDepthOutput
bool	m_enableBitDepthOutput
clXMLNode *	m_parentNode

Detailed Description

ciElectronics class declaration

Constructor & Destructor Documentation

ciElectronics::ciElectronics

(

)

Default constructor.

ciElectronics::ciElectronics

(

ciElectronics &

obj

)

Copy constructor.

Parameters

obj	- ciElectronics object to be copied.

virtual ciElectronics::~ciElectronics ( )

virtual

Deconstructor.

Member Function Documentation

double ciElectronics::getFrameRate ( )

inline

gets the frame rate in hz.

Returns

The frame rate [hz].

void ciElectronics::setFrameRate ( double  frameRate )

inline

sets the frame rate in hz.

Parameters

frameRate

- The frameRate to be assigned in hz.

Returns

void.

double ciElectronics::getPreCutonFreq ( )

inline

gets the pre-cuton Frequency [hz].

Returns

The pre-cuton frequency in hz.

void ciElectronics::setPreCutonFreq ( double  preCutonFreq )

inline

sets the pre-cuton Frequency [hz]

Parameters

preCutonFreq

- The value of the pre-cuton frequency parameter to be assigned .

Returns

void.

double ciElectronics::getPostCutoffFreq ( )

inline

gets the post-cutoff Frequency [hz].

Returns

The post-cutoff frequency in hz.

void ciElectronics::setPostCutoffFreq ( double  postCutoffFreq )

inline

sets the post-cutoff Frequency [hz]

Parameters

postCutoffFreq

- The value of the post-cutoff frequency parameter to be assigned .

Returns

void.

double ciElectronics::getGain ( )

inline

gets the gain.

Returns

The gain.

void ciElectronics::setGain ( double  gain )

inline

sets the gain.

Parameters

gain	- The gain to be assigned.

Returns

void.

void ciElectronics::setAGCMaxGain ( const double  gain )

inline

sets the max gain to be used by AGC

Parameters

double

gain

double ciElectronics::getAGCMaxGain ( )

inline

gets the max gain to be used by AGC

Returns

double

void ciElectronics::setAGCMinGain ( const double  gain )

inline

sets the min gain to be used by AGC

Parameters

double

level

double ciElectronics::getAGCMinGain ( )

inline

gets the min gain to be used by AGC

Returns

double

void ciElectronics::setAGCGainThreshold ( const double  threshold )

inline

sets the gain threshold to be used by AGC

Parameters

double

level

double ciElectronics::getAGCGainThreshold ( )

inline

gets the gain threshold used by AGC

Returns

double

void ciElectronics::setAGCMode ( const int  mode )

inline

sets the AGC mode

Parameters

int	mode : 0 = Max, 1 = Clipped, 2 = Histogram Equalization, 3 = Histogram Projection

int ciElectronics::getAGCMode ( )

inline

gets the AGC mode

Returns

int mode : 0 = Max, 1 = Clipped, 2 = Histogram Equalization, 3 = Histogram Projection

void ciElectronics::setPercentGain ( double  percent )

inline

Parameters

double

percent

double ciElectronics::getPercentGain ( )

inline

Returns

double

void ciElectronics::setPercentLevel ( double  percent )

inline

Parameters

double

percent

double ciElectronics::getPercentLevel ( )

inline

Returns

double

double ciElectronics::getLevel ( )

inline

gets the level parameter.

Returns

The level parameter.

void ciElectronics::setLevel ( double  level )

inline

sets the level parameter.

Parameters

level

- The value of the level parameter to be assigned .

Returns

void.

int ciElectronics::getColorMapType ( )

inline

void ciElectronics::setColorMapType ( int  type )

inline

char* ciElectronics::getColorMapUserDefinedRadFile ( )

inline

void ciElectronics::setColorMapUserDefinedRadFile

(

const char *

filepath

)

int ciElectronics::getColorMapEnable ( )

inline

void ciElectronics::setColorMapEnable ( int  enable )

inline

void ciElectronics::setBitDepthOutput ( bool  enable, float  bitDepth  )

inline

sets the desired bit depth output buffer.

Set to -1 for full floating point

void ciElectronics::getBitDepthOutput ( bool &  enable, float &  bitDepth  ) const

inline

Returns the desired bit depth output and the state on whether it is enabled or not.

A return of -1 is full floating point

Returns

float

void ciElectronics::setSensorIndex ( int  sensorIndex )

inline

Parameters

int	sensorIndex

int ciElectronics::getSensorIndex ( )

inline

Returns

int

bool ciElectronics::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 ciElectronics::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 ciElectronics::loadXML

(

clXMLNode *

xmlParentNode

)

bool ciElectronics::parseXML

(

clXML &

xmlDocument

)

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

Parameters

std::string	tag
char	*nodeString

Returns

bool

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

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

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

Parameters

std::string	tag
int	*nodeInt

Returns

bool

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

Parameters

std::string	tag
long	*nodeLong

Returns

bool

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

Parameters

std::string	tag
double	*nodeDouble

Returns

bool

void ciElectronics::saveXML

(

clXML *

xmlDocument

)

int ciElectronics::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)

ciElectronics ciElectronics::operator=

(

ciElectronics &

obj

)

Assignment operator.

Parameters

obj	- ciElectronics object to be assigned.

Returns

The assigned ciElectronics object.

Member Data Documentation

double ciElectronics::m_frameRate

protected

double ciElectronics::m_preCutonFreq

protected

double ciElectronics::m_postCutoffFreq

protected

double ciElectronics::m_gain

protected

double ciElectronics::m_level

protected

double ciElectronics::m_AGCMaxGain

protected

double ciElectronics::m_AGCMinGain

protected

double ciElectronics::m_AGCGainThreshold

protected

int ciElectronics::m_AGCMode

protected

double ciElectronics::m_percentGain

protected

double ciElectronics::m_percentLevel

protected

int ciElectronics::m_sensorIndex

protected

int ciElectronics::m_colorMapType

protected

char ciElectronics::m_colorMapUserDefinedRadFile[512]

protected

int ciElectronics::m_colorMapEnable

protected

float ciElectronics::m_bitDepthOutput

protected

bool ciElectronics::m_enableBitDepthOutput

protected

clXMLNode* ciElectronics::m_parentNode

protected

---

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

• ciElectronics.h