ciImager Class Reference

Public Types
enum	ImagerModes {   UNDEFINED = -1, NO_CHANGE = 0, VISUAL = 1, MATERIAL_ID = 2,   MIXTURE = 3, RANGE = 4, NORMAL = 5, PASSBAND = 6,   SPECTRAL = 7, PASSBAND_RGB = 8, SPECTRAL_RGB = 9, OBJECT_ID = 10,   GRAZING_ANGLE = 11 }

Public Member Functions
	ciImager (void)
	ciImager (ciImager &obj)
virtual	~ciImager (void)
ciImager	operator= (ciImager &obj)
void	setUseSensorPosition (bool useSensorPosition)
bool	getUseSensorPosition ()
void	setEnableHUD (bool enableHUD)
bool	getEnableHUD ()
void	setImagerMode (int imagerMode)
int	getImagerMode ()
void	setSnapImageFilepath (char *snapImageFilepath)
char *	getSnapImageFilepath ()
bool	archive (std::ofstream &outf)
bool	serialize (char *filepath)

Private Attributes
bool	m_useSensorPosition
bool	m_enableHUD
int	m_imagerMode
char	m_snapImageFilepath [512]

Member Enumeration Documentation

enum ciImager::ImagerModes

Description

Enumerates the image modes.

Enumerator:

UNDEFINED	-1
NO_CHANGE	0
VISUAL	1
MATERIAL_ID	2
MIXTURE	3
RANGE	4
NORMAL	5
PASSBAND	6
SPECTRAL	7
PASSBAND_RGB	8
SPECTRAL_RGB	9
OBJECT_ID	10
GRAZING_ANGLE	11

Constructor & Destructor Documentation

ciImager::ciImager

(

void

)

Description:

Default constructor.

ciImager::ciImager

(

ciImager &

obj

)

Description:

Copy constructor.

Parameters

obj	- ciImager object to be copied.

virtual ciImager::~ciImager ( void  )

virtual

Description:

Destructor.

Member Function Documentation

ciImager ciImager::operator=

(

ciImager &

obj

)

Description:

Assignement operator.

Parameters

obj	- ciImager object to be assigned.

Returns

the assigned ciImager object.

void ciImager::setUseSensorPosition

(

bool

useSensorPosition

)

Description:

Sets the state flag that determines if sensor position is derived from trackfile or other positional data, or if it is determined by mouse input.

Parameters

useSensorPosition

- the new state for the use sensor position flag.

Returns

void.

bool ciImager::getUseSensorPosition

(

)

Description:

Gets the state flag that determines if sensor position is derived from trackfile or other positional data, or if it is determined by mouse input.

Returns

The current state of the use sensor position flag.

void ciImager::setEnableHUD

(

bool

enableHUD

)

Description:

Sets the state flag that determines if the HUD is displayed.

Parameters

enableHUD

- the new state for the enable HUD flag.

Returns

void.

bool ciImager::getEnableHUD

(

)

Description:

Gets the state flag that determines if the HUD is displayed.

Returns

The current state of the enable HUD flag.

void ciImager::setImagerMode

(

int

imagerMode

)

Description:

Sets the imager display mode.

Parameters

imagerMode

- the new display mode.

Returns

void.

int ciImager::getImagerMode

(

)

Description:

Gets the imager display mode.

Returns

the current display mode.

void ciImager::setSnapImageFilepath

(

char *

snapImageFilepath

)

Description:

Sets the snap image filepath.

Parameters

snapImageFilepath

- the full path and filename to which a snapped image will be saved.

Returns

void.

char* ciImager::getSnapImageFilepath

(

)

Description:

Gets the snap image filepath.

Returns

The full path and filename to which a snapped image will be saved.

bool ciImager::archive

(

std::ofstream &

outf

)

Description:

Saves the ciImager object to file.

Parameters

filepath	- complete path and filename to the file
flags	- file io flags to be set.

Returns

true if sucessful

bool ciImager::serialize

(

char *

filepath

)

Description:

Loads the ciImager object from file.

Parameters

filepath

- complete path and filename to the file

Returns

true if sucessful

Member Data Documentation

bool ciImager::m_useSensorPosition

private

if true, uses the sensor's trackfile or static position, else uses mouse inputs

bool ciImager::m_enableHUD

private

if true, enables HUD

int ciImager::m_imagerMode

private

enumerated image mode

char ciImager::m_snapImageFilepath[512]

private

full path and filename to which a snapped image will be saved

---

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

• ciImager.h