Isis::HiLab Class Reference

Process HiRise label. More...

#include <HiLab.h>

Collaboration diagram for Isis::HiLab:

Public Member Functions
	HiLab (Cube *cube)
	Constructs a HiLab Object.
int	getCpmmNumber ()
	Returns the value of the CpmmNumber keyword read from the instrument group in the labels of a hiris cube.
int	getChannel ()
	Returns the value of the ChannelNumber keyword read from the instrument group in the labels of a hirise cube.
int	getBin ()
	Returns the bin value, read as the value of the Summing keyword from the instrument group in the labels of a hirise cube.
int	getTdi ()
	Returns the value of the Tdi keyword read from the instrument group in the labels of a hirise cube.
int	getCcd ()
	Returns the value of the ccd from a lookup table based on the cpmm number.

Private Attributes
int	p_cpmmNumber
	Value of the CpmmNumber keyword from the cube's Instrument group.
int	p_channel
	Value of the ChannelNumber keyword from the cube's Instrument group.
int	p_bin
	Value of the Summing keyword from the cube's Instrument group, if it exists.
int	p_tdi
	Value of the Tdi keyword from the cube's Instrument group, if it exists.

Detailed Description

Process HiRise label.

This class retrieves label keyword values from an Isis HiRise cube file. This class receives a Cube object from an opened HiRise cube file and has methods to return HiRise specific keyword values from the label.

Author

2005-06-29 unknown

History

2005-06-29 unknown - Original Version

2006-08-17 Debbie A. Cook - Added members p_bin and p_tdi along with methods to retrieve them and the ccd

2008-05-12 Steven Lambright - Removed references to CubeInfo

2012-04-16 Jeannie Walldren - Wrapped class inside Isis namespace. Added documentation.

Definition at line 36 of file HiLab.h.

Constructor & Destructor Documentation

HiLab()

Isis::HiLab::HiLab

(

Cube *

cube

)

Constructs a HiLab Object.

Parameters

cube	The cube containing the HiRise labels to be processed.

Definition at line 19 of file HiLab.cpp.

References Isis::Cube::group(), Isis::PvlContainer::hasKeyword(), Isis::IException::Io, p_bin, p_channel, p_cpmmNumber, and p_tdi.

Member Function Documentation

getBin()

int Isis::HiLab::getBin ( )

inline

Returns the bin value, read as the value of the Summing keyword from the instrument group in the labels of a hirise cube.

Returns

int The bin value from the cube's labels

Definition at line 66 of file HiLab.h.

References p_bin.

getCcd()

int Isis::HiLab::getCcd

(

)

Returns the value of the ccd from a lookup table based on the cpmm number.

Returns

int The ccd value.

Definition at line 41 of file HiLab.cpp.

References p_cpmmNumber.

getChannel()

int Isis::HiLab::getChannel ( )

inline

Returns the value of the ChannelNumber keyword read from the instrument group in the labels of a hirise cube.

Returns

int The channel number from the cube's labels

Definition at line 56 of file HiLab.h.

References p_channel.

getCpmmNumber()

int Isis::HiLab::getCpmmNumber ( )

inline

Returns the value of the CpmmNumber keyword read from the instrument group in the labels of a hiris cube.

Returns

int The cpmm number from the cube's labels

Definition at line 46 of file HiLab.h.

References p_cpmmNumber.

getTdi()

int Isis::HiLab::getTdi ( )

inline

Returns the value of the Tdi keyword read from the instrument group in the labels of a hirise cube.

Returns

int The tdi from the cube's labels

Definition at line 76 of file HiLab.h.

References p_tdi.

Member Data Documentation

p_bin

int Isis::HiLab::p_bin

private

Value of the Summing keyword from the cube's Instrument group, if it exists.

Definition at line 94 of file HiLab.h.

Referenced by getBin(), and HiLab().

p_channel

int Isis::HiLab::p_channel

private

Value of the ChannelNumber keyword from the cube's Instrument group.

Definition at line 92 of file HiLab.h.

Referenced by getChannel(), and HiLab().

p_cpmmNumber

int Isis::HiLab::p_cpmmNumber

private

Value of the CpmmNumber keyword from the cube's Instrument group.

Definition at line 90 of file HiLab.h.

Referenced by getCcd(), getCpmmNumber(), and HiLab().

p_tdi

int Isis::HiLab::p_tdi

private

Value of the Tdi keyword from the cube's Instrument group, if it exists.

Definition at line 96 of file HiLab.h.

Referenced by getTdi(), and HiLab().

---

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

• src/mro/objs/HiLab/HiLab.h
• src/mro/objs/HiLab/HiLab.cpp