USGS Astrogeology Isis API

This class is designed to be used with images imported from Cassini ISS using ciss2isis. It contains accessor methods for the values of Keywords in the Instrument Group of the cube's labels.

Definition at line 46 of file CissLabels.h.


Public Member Functions
	CissLabels (Pvl &lab)
	Constructs a CissLabels object from an Isis::Pvl object.
	CissLabels (const string &file)
	Constructs a CissLabels object from a file name.
	~CissLabels ()
	Empty Destructor.
bool	NarrowAngle () const
	Returns whether InstrumentId from the Instrument group is "ISSNA".
bool	WideAngle () const
	Returns whether InstrumentId from the Instrument group is "ISSWA".
double	BiasStripMean () const
	Returns BiasStripMean from the Intstrument group.
iString	CompressionRatio () const
	Returns CompressionRatio from the Instrument group.
iString	CompressionType () const
	Returns CompressionType from the Instrument group.
iString	DataConversionType () const
	Returns DataConversionType from the Instrument group.
iString	DelayedReadoutFlag () const
	Returns DelayedReadoutFlag from the Instrument group.
double	ExposureDuration () const
	Returns ExposureDuration from the Instrument group.
vector< iString >	FilterName () const
	Returns a two-element array of the optical filters found in the BandBin group.
vector< int >	FilterIndex () const
	Returns a two-element array of indices associated with optical filter names.
iString	FlightSoftwareVersion () const
	Returns FlightSoftwareVersion from the Instrument group.
double	FrontOpticsTemp () const
	Returns the first element of OpticsTemperature from the Instrument group.
int	GainModeId () const
	Returns GainModeId from the Instrument group.
int	GainState () const
	Returns GainState from the Instrument group.
double	ImageNumber () const
	Returns ImageNumber from the Archive group.
double	InstrumentDataRate () const
	Returns InstrumentDataRate from the Instrument group.
iString	InstrumentId () const
	Returns InstrumentId from the Instrument group.
iString	InstrumentModeId ()
	Returns the lower case form of InstrumentModeId from the Instrument group.
iString	ReadoutCycleIndex () const
	Returns ReadoutCycleIndex from the Instrument group.
int	ReadoutOrder () const
	Returns ReadoutOrder from the Instrument group.
iString	ShutterModeId () const
	Returns ShutterModeId from the Instrument group.
int	SummingMode () const
	Returns SummingMode from the Instrument group.
bool	AntibloomingOn () const
	Returns whether AntiBloomingFlag from the Instrument group is "On".
Private Member Functions
void	Init (Pvl &lab)
	General initializer.
void	ReadLabels (Pvl &lab)
	Reads the Pvl Labels.
void	ComputeImgProperties ()
	Computes values of non-keyword image properties.
Private Attributes
string	p_ABflag
	Value of the PDS keyword AntiBloomingFlag in the cube's labels.
bool	p_antiblooming
	Indicates whether anti-blooming state flag on.
double	p_biasStripMean
	Value of the PDS keyword BiasStripMean in the cube's labels.
bool	p_cissNA
	Indicates whether camera is narrow-angle.
iString	p_compressionRatio
	Value of the PDS keyword CompressionRatio in the cube's labels.
iString	p_compressionType
	Value of the PDS keyword CompressionType in the cube's labels.
iString	p_dataConversionType
	Value of the PDS keyword DataConversionType in the cube's labels.
iString	p_delayedReadoutFlag
	Value of the PDS keyword DelayedReadoutFlag in the cube's labels.
double	p_exposureDuration
	Value of the PDS keyword ExposureDuration in the cube's labels.
vector< iString >	p_filter
	Two-element array of optical filters used for this image.
vector< int >	p_filterIndex
	Two-element array of filter indices corresponding to optical filters.
iString	p_flightSoftwareVersion
	Value of the PDS keyword FlightSoftwareVersion in the cube's labels.
double	p_frontOpticsTemp
	Value of the PDS keyword OpticsTemperature[0] in the cube's labels.
int	p_gainModeId
	Value of the PDS keyword GainModeId in the cube's labels.
int	p_gainState
	Value of the PDS keyword GainState in the cube's labels.
double	p_imageNumber
	Value of the PDS keyword ImageNumber in the cube's labels.
double	p_instrumentDataRate
	Value of the PDS keyword ImageTime in the cube's labels.
iString	p_instrumentId
	Value of the PDS keyword InstrumentId in the cube's labels.
iString	p_instrumentModeId
	Value of the PDS keyword InstrumentModeId in the cube's labels.
iString	p_readoutCycleIndex
	Value of the PDS keyword ReadoutCycleIndex in the cube's labels.
int	p_readoutOrder
	Value of the PDS keyword ReadoutOrder in the cube's labels.
iString	p_shutterModeId
	Value of the PDS keyword ShutterModeId in the cube's labels.
int	p_summingMode
	Value of the PDS keyword SummingMode in the cube's labels.

Constructor & Destructor Documentation

Isis::CissLabels::CissLabels ( Pvl & lab )

Constructs a CissLabels object from an Isis::Pvl object.

Parameters:

lab

Pvl Labels of Cassini ISS file

Definition at line 16 of file CissLabels.cpp.

References Init().

Isis::CissLabels::CissLabels ( const string & file )

Constructs a CissLabels object from a file name.

Parameters:

file

Name of Cassini ISS file

Definition at line 25 of file CissLabels.cpp.

References Init().

Isis::CissLabels::~CissLabels ( ) [inline]

Empty Destructor.

Definition at line 51 of file CissLabels.h.

Member Function Documentation

bool Isis::CissLabels::AntibloomingOn ( ) const [inline]

Returns whether AntiBloomingFlag from the Instrument group is "On".

Indicates whether anti-blooming was used for the image. False implies the anti-blooming flag is "Off" or "Unknown".

Returns:: bool True if AntiBloomingStateFlag "On"

Definition at line 369 of file CissLabels.h.

References p_antiblooming.

double Isis::CissLabels::BiasStripMean ( ) const [inline]

Returns BiasStripMean from the Intstrument group.

Finds the mean of the overclocked pixels. If the image has DataConversionType of "Lossy", the bias strip mean is not valid unless the Flight Software Version is 1.4. Valid values include all real numbers.

Returns:: double BiasStripMean

Definition at line 90 of file CissLabels.h.

References p_biasStripMean.

iString Isis::CissLabels::CompressionRatio ( ) const [inline]

Returns CompressionRatio from the Instrument group.

Finds the ratio of the expected image size to the actual size. Valid values include any real number or "NotCompressed". This method returns an Isis::iString so that values other than "NotCompressed" may be converted to double.

Returns:: iString CompressionRatio

Definition at line 104 of file CissLabels.h.

References p_compressionRatio.

iString Isis::CissLabels::CompressionType ( ) const [inline]

Returns CompressionType from the Instrument group.

Finds the method of data compression used for the image. Valid values include "NotCompressed", "Lossless" (a.k.a Rice), or "Lossy" (a.k.a. Discrete Cosine Transform).

Returns:: iString CompressionType

Definition at line 117 of file CissLabels.h.

References p_compressionType.

void Isis::CissLabels::ComputeImgProperties ( ) [private]

Computes values of non-keyword image properties.

This method computes and sets the values of the image properties that are not keywords in the labels.

Definition at line 96 of file CissLabels.cpp.

References _FILEINFO_, Isis::iException::Message(), p_ABflag, p_antiblooming, p_cissNA, p_filter, p_filterIndex, and p_instrumentId.

Referenced by Init().

iString Isis::CissLabels::DataConversionType ( ) const [inline]

Returns DataConversionType from the Instrument group.

Finds the method used to convert the image from 12 to 8 bits. Valid values include "12Bit" (no conversion), "Table" (converted using look-up table), or "8LSB" (kept the 8 least significant bits only).

Returns:: iString DataConversionType

Definition at line 130 of file CissLabels.h.

References p_dataConversionType.

iString Isis::CissLabels::DelayedReadoutFlag ( ) const [inline]

Returns DelayedReadoutFlag from the Instrument group.

Indicates whether the image waited while the ther camera was performing a readout. Valid values include "Yes", "No", or "Unknown".

Returns:: iString DelayedReadoutFlag

Definition at line 142 of file CissLabels.h.

References p_delayedReadoutFlag.

double Isis::CissLabels::ExposureDuration ( ) const [inline]

Returns ExposureDuration from the Instrument group.

Finds the exposure duration in milliseconds for the image. There are 62 valid values between 0 and 1200000, or -999.0 (if data is unavailable).

Returns:: double ExposureDuration

Definition at line 154 of file CissLabels.h.

References p_exposureDuration.

vector<int> Isis::CissLabels::FilterIndex ( ) const [inline]

Returns a two-element array of indices associated with optical filter names.

Takes FilterName string from the BandBin group and assigns an index for each filter. Valid values are between 0 and 35. This method is not called for wide-angle cameras.

Returns:: vector <int> The filter indices.

Definition at line 196 of file CissLabels.h.

References p_filterIndex.

vector<iString> Isis::CissLabels::FilterName ( ) const [inline]

Returns a two-element array of the optical filters found in the BandBin group.

Takes FilterName string from the BandBin group and splits the combination into a vector of filter names.
Valid combinations include:

For narrow-angle cameras:
- Filter 1: "CL1", "RED", "BL1", "UV2", "UV1", "IRP0", "P120", "P60", "P0", "HAL", "IR4", "IR2"
- Filter 2: "CL2", "GRN", "UV3", "BL2", "MT2", "CB2", "MT3", "CB3", "MT1", "CB1", "IR3", "IR1"
For wide-angle cameras:
- Filter 1: "CL1", "IR3", "IR4", "IR5", "CB3", "MT3", "CB2", "MT2", "IR2"
- Filter 2: "CL2", "RED", "GRN", "BL1", "VIO", "HAL", "IRP90", "IRP0", "IR1"

Returns:: vector <iString> The optical filter names.

Definition at line 183 of file CissLabels.h.

References p_filter.

iString Isis::CissLabels::FlightSoftwareVersion ( ) const [inline]

Returns FlightSoftwareVersion from the Instrument group.

Retrieves the flight software version used for this image. Valid values include 1.2, 1.3, 1.4, or "Unknown". This method returns an Isis::iString so that any value other than "Unknown" may be converted to double.

Returns:: iString FlightSoftwareVersion

Definition at line 210 of file CissLabels.h.

References p_flightSoftwareVersion.

double Isis::CissLabels::FrontOpticsTemp ( ) const [inline]

Returns the first element of OpticsTemperature from the Instrument group.

Retrieves the first value of the two-element array containing front and rear optics temperatures. Valid values are greater than -999.0 degrees Celcius.

Returns:: double OpticsTemperature[0]

Definition at line 223 of file CissLabels.h.

References p_frontOpticsTemp.

int Isis::CissLabels::GainModeId ( ) const [inline]

Returns GainModeId from the Instrument group.

Finds the electronics gain setting in electrons per DN. Valid values include 12, 29, 95, or 215. These values correspond to GainState 3, 2, 1, and 0, respectively.

Returns:: int GainModeId

See also:: GainState()

Definition at line 236 of file CissLabels.h.

References p_gainModeId.

int Isis::CissLabels::GainState ( ) const [inline]

Returns GainState from the Instrument group.

Finds the gain state, which is dependent on the Gain Mode ID. Valid values include 0, 1, 2, or 3. These values correspond to GainModeId 215, 95, 29, and 12, respectively.

Returns:: int GainState

See also:: GainModeId()

Definition at line 249 of file CissLabels.h.

References p_gainState.

double Isis::CissLabels::ImageNumber ( ) const [inline]

Returns ImageNumber from the Archive group.

Finds the number of seconds on the clock at shutter close. Valid values include real numbers.

Returns:: double ImageNumber

Definition at line 260 of file CissLabels.h.

References p_imageNumber.

void Isis::CissLabels::Init ( Pvl & lab ) [private]

General initializer.

Reads labels of the file and computes values of image properties not already in the labels.

Parameters:

lab

Pvl Labels of Cassini ISS file

Exceptions:

iException::Pvl

Not valid Cassini ISS instrument

Definition at line 37 of file CissLabels.cpp.

References _FILEINFO_, ComputeImgProperties(), e, Isis::iException::Message(), and ReadLabels().

Referenced by CissLabels().

double Isis::CissLabels::InstrumentDataRate ( ) const [inline]

Returns InstrumentDataRate from the Instrument group.

Finds the rate at which data was transferred out, in kilobits per second. Valid values include 60.9, 121.9, 182.8, 243.7, 304.6, 365.6, or -999.0 (if data is unavailable).

Returns:: double InstrumentDataRate

Definition at line 273 of file CissLabels.h.

References p_instrumentDataRate.

iString Isis::CissLabels::InstrumentId ( ) const [inline]

Returns InstrumentId from the Instrument group.

Finds the type of camera used. Valid values include "ISSNA" (also called "NAC" or "narrow-angle") or "ISSWA" (also called "WAC" or "wide-angle").

Returns:: iString InstrumentId

Definition at line 285 of file CissLabels.h.

References p_instrumentId.

iString Isis::CissLabels::InstrumentModeId ( ) [inline]

Returns the lower case form of InstrumentModeId from the Instrument group.

Finds the summation mode used for this image. All images have 1 band and an equal number of lines and samples. Valid values include "full" (1024x1024), "sum2" (512x512), or "sum4" (256x256). These values correspond to SummingMode 1, 2, and 4, respectively.

Returns:: double lower-cased InstrumentModeId

See also:: SummingMode()

Definition at line 301 of file CissLabels.h.

References Isis::iString::DownCase(), and p_instrumentModeId.

bool Isis::CissLabels::NarrowAngle ( ) const [inline]

Returns whether InstrumentId from the Instrument group is "ISSNA".

Indicates whether the camera used a narrow-angle lens ("ISSNA"). False implies it used a wide-angle lens ("ISSWA").

Returns:: bool True if instrument ISSNA

Definition at line 64 of file CissLabels.h.

References p_cissNA.

void Isis::CissLabels::ReadLabels ( Pvl & lab ) [private]

Reads the Pvl Labels.

This method reads the required keywords from the labels and sets the values of the private variables.

Parameters:

lab

Pvl Labels of Cassini ISS file

Definition at line 57 of file CissLabels.cpp.

References filter(), Isis::PvlObject::FindGroup(), p_ABflag, p_biasStripMean, p_compressionRatio, p_compressionType, p_dataConversionType, p_delayedReadoutFlag, p_exposureDuration, p_filter, p_flightSoftwareVersion, p_frontOpticsTemp, p_gainModeId, p_gainState, p_imageNumber, p_instrumentDataRate, p_instrumentId, p_instrumentModeId, p_readoutCycleIndex, p_readoutOrder, p_shutterModeId, p_summingMode, and Isis::PvlObject::Traverse.

Referenced by Init().

iString Isis::CissLabels::ReadoutCycleIndex ( ) const [inline]

Returns ReadoutCycleIndex from the Instrument group.

Finds the index associated with the image in the Readout Cycle table. Valid values are "Unknown" or in the range 0-15. This method returns an Isis::iString so that any value not equal to "Unknown" may be converted to int.

Returns:: iString ReadoutCycleIndex

Definition at line 315 of file CissLabels.h.

References p_readoutCycleIndex.

int Isis::CissLabels::ReadoutOrder ( ) const [inline]

Returns ReadoutOrder from the Instrument group.

Finds the integer value representing the readout order of the image. Valid values are

0 : indicates narrow-angle was read out first
1 : indicates wide-angle was read out first

Returns:: int ReadoutOrder

Definition at line 330 of file CissLabels.h.

References p_readoutOrder.

iString Isis::CissLabels::ShutterModeId ( ) const [inline]

Returns ShutterModeId from the Instrument group.

Indicates whether the exposure was part of a joint observation with the other ISS camera. Valid values include "BothSim", "NacOnly", "WacOnly", or "Unknown".

Returns:: iString ShutterModeId

Definition at line 343 of file CissLabels.h.

References p_shutterModeId.

int Isis::CissLabels::SummingMode ( ) const [inline]

Returns SummingMode from the Instrument group.

Finds the summation mode, which is dependent on the Instrument Mode ID. Valid values include 1, 2, or 4. These values correspond to InstrumentModeId "Full", "Sum2", and "Sum4", respectively.