ciOptics Class Reference

Public Types
enum	enumApertureShapeType { ELLIPTICAL, RECTANGULAR }

Public Member Functions
double	getAspectRatio ()
void	setAspectRatio (double aspectRatio)
double	getWidthDimension ()
void	setWidthDimension (double widthDimension)
int	getApertureShape ()
void	setApertureShape (int apertureShape)
double	getBlurSpotDiameter ()
void	setBlurSpotDiameter (double blurSpotDiameter)
double	getMtfMotionBlurSize ()
void	setMtfMotionBlurSize (double mtfMotionBlur)
double	getHorizFOV ()
void	setHorizFOV (double horizFOV)
double	getVertFOV ()
void	setVertFOV (double vertFOV)
void	setHaloThreshold (double threshold)
double	getHaloThreshold ()
void	setHaloRadius (double radius)
double	getHaloRadius ()
void	setHaloIntensity (double intensity)
double	getHaloIntensity ()
void	setPercentHaloIntensity (double percent)
double	getPercentHaloIntensity ()
void	setUserDefinedMTFenable (bool enable)
	Set the user defined MTF enable If set then the file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.
bool	getUserDefinedMTFenable ()
	Get the user defined MTF enable.
void	setUserDefinedMTFfilename (char *filename)
	Set the user defined MTF filename this file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.
char *	getUserDefinedMTFfilename ()
	get the user defined MTF filename
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.
ciOptics	operator= (ciOptics &obj)
	ciOptics ()
	ciOptics (ciOptics &obj)
virtual	~ciOptics ()

Protected Attributes
double	m_aspectRatio
double	m_widthDimension
int	m_apertureShape
double	m_blurSpotDiameter
double	m_horizFOV
double	m_vertFOV
double	m_mtfMotionBlur
double	m_haloThreshold
double	m_haloRadius
double	m_haloIntensity
double	m_percentHaloIntensity
bool	m_userDefinedMTFenable
	flag indicating the use of user defined MTF data
char	m_userDefinedMTFfilename [512]
	file name for user defined MTF data
int	m_sensorIndex
clXMLNode *	m_parentNode

Detailed Description

ciOptics class declaration

Member Enumeration Documentation

enum ciOptics::enumApertureShapeType

Description

Enumerates the aperture shapes elliptical and rectangular

Enumerator:

ELLIPTICAL	0
RECTANGULAR	1

Constructor & Destructor Documentation

ciOptics::ciOptics

(

)

Default constructor.

ciOptics::ciOptics

(

ciOptics &

obj

)

Copy constructor.

Parameters

obj	- ciOptics object to be copied.

virtual ciOptics::~ciOptics ( )

virtual

Member Function Documentation

double ciOptics::getAspectRatio ( )

inline

gets the aspect ratio of the aperture.

Returns

The aperture aspect ratio.

void ciOptics::setAspectRatio ( double  aspectRatio )

inline

sets the aperture aspect ratio.

Parameters

aspectRatio-

The ascpect ratio to be assigned.

Returns

void.

double ciOptics::getWidthDimension ( )

inline

gets the width dimension of the aperture.

Returns

The width dimension of the aperture.

void ciOptics::setWidthDimension ( double  widthDimension )

inline

sets the width dimension of the aperture.

Parameters

widthDimension

- The width dimension of the aperture.

Returns

void.

int ciOptics::getApertureShape ( )

inline

gets the aperture shape. This quantity is enumerated in enumApertureShapeType

Returns

The enumerated aperture shape.

void ciOptics::setApertureShape ( int  apertureShape )

inline

sets the aperture shape. This quantity is enumerated in enumApertureShapeType

Parameters

aperture

shape - The enumerated aperture shape to be assigned.

Returns

void.

double ciOptics::getBlurSpotDiameter ( )

inline

gets the blur spot diameter for the aperture [mrad].

Returns

the blur spot diameter for the aperture [mrad].

void ciOptics::setBlurSpotDiameter ( double  blurSpotDiameter )

inline

sets the blur spot diameter for the aperture [mrad].

Parameters

blurSpotDiameter

- The blur spot diameter [mrad] to be assigned.

Returns

void.

double ciOptics::getMtfMotionBlurSize ( )

inline

gets the motion blur spot standard deviation [uRad].

Returns

the motion blur spot standard deviation [uRad].

void ciOptics::setMtfMotionBlurSize ( double  mtfMotionBlur )

inline

sets the motion blur spot standard deviation [uRad].

Parameters

mtfMotionBlur

- The motion blur spot size [uRad] to be assigned.

Returns

void.

double ciOptics::getHorizFOV ( )

inline

gets the horizontal FOV [deg].

Returns

The horizontal FOV [deg].

void ciOptics::setHorizFOV ( double  horizFOV )

inline

sets the horizontal FOV [deg].

Parameters

horizontal

FOV - The horizontal FOV to be assigned [deg].

Returns

void.

double ciOptics::getVertFOV ( )

inline

gets the vertical FOV [deg].

Returns

The vertical FOV [deg].

void ciOptics::setVertFOV ( double  vertFOV )

inline

sets the vertical FOV [deg].

Parameters

vertical

FOV - The vertical FOV to be assigned [deg].

Returns

void.

void ciOptics::setHaloThreshold ( double  threshold )

inline

Parameters

double

threshold

double ciOptics::getHaloThreshold ( )

inline

Returns

double

void ciOptics::setHaloRadius ( double  radius )

inline

Parameters

double

radius

double ciOptics::getHaloRadius ( )

inline

Returns

double

void ciOptics::setHaloIntensity ( double  intensity )

inline

Parameters

double

intensity

double ciOptics::getHaloIntensity ( )

inline

Returns

double

void ciOptics::setPercentHaloIntensity ( double  percent )

inline

Parameters

double

percent

double ciOptics::getPercentHaloIntensity ( )

inline

Returns

double

void ciOptics::setUserDefinedMTFenable ( bool  enable )

inline

Set the user defined MTF enable If set then the file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.

bool ciOptics::getUserDefinedMTFenable ( )

inline

Get the user defined MTF enable.

void ciOptics::setUserDefinedMTFfilename

(

char *

filename

)

Set the user defined MTF filename this file's data replaces the MTF/filter data that is computed based on the Sensor's optical properties.

The file format is: number of samples (integer) maximum horizontal frequency maximum vertical frequency MTF x value and MTF y value for each frequency step from 0.0 to the maximum frequecy.

Parameters

filename

char* ciOptics::getUserDefinedMTFfilename ( )

inline

get the user defined MTF filename

Returns

char *

void ciOptics::setSensorIndex ( int  sensorIndex )

inline

Parameters

int	sensorIndex

int ciOptics::getSensorIndex ( )

inline

Returns

int

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

(

clXMLNode *

xmlParentNode

)

bool ciOptics::parseXML

(

clXML &

xmlDocument

)

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

Parameters

std::string	tag
char	*nodeString

Returns

bool

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

Parameters

std::string	tag
bool	*nodeBool

Returns

bool

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

Parameters

std::string	tag
int	*nodeInt

Returns

bool

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

Parameters

std::string	tag
long	*nodeLong

Returns

bool

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

Parameters

std::string	tag
double	*nodeDouble

Returns

bool

void ciOptics::saveXML

(

clXML *

xmlDocument

)

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

ciOptics ciOptics::operator=

(

ciOptics &

obj

)

Assignment operator.

Parameters

obj	- ciOptics object to be assigned.

Returns

The assigned ciOptics object.

Member Data Documentation

double ciOptics::m_aspectRatio

protected

Aspect ratio of the aperture

double ciOptics::m_widthDimension

protected

Horizontal width dimension of the aperture [mm].

int ciOptics::m_apertureShape

protected

Aperture shape Rectangular (1) or Elliptical(0).

double ciOptics::m_blurSpotDiameter

protected

Blur Spot Diameter [urad].

double ciOptics::m_horizFOV

protected

Horizontal FOV of the sensor [deg]

double ciOptics::m_vertFOV

protected

Vertical FOV of the sensor [deg]

double ciOptics::m_mtfMotionBlur

protected

Motion Blur Size [urad].

double ciOptics::m_haloThreshold

protected

double ciOptics::m_haloRadius

protected

double ciOptics::m_haloIntensity

protected

double ciOptics::m_percentHaloIntensity

protected

bool ciOptics::m_userDefinedMTFenable

protected

flag indicating the use of user defined MTF data

char ciOptics::m_userDefinedMTFfilename[512]

protected

file name for user defined MTF data

int ciOptics::m_sensorIndex

protected

clXMLNode* ciOptics::m_parentNode

protected

---

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

• ciOptics.h