Isis 3 Programmer Reference
|
Read values from Cassini ISS labels. More...
#include <CissLabels.h>
Public Member Functions | |
CissLabels (Pvl &lab) | |
Constructs a CissLabels object from an Isis::Pvl object. | |
CissLabels (const QString &file) | |
Constructs a CissLabels object from a file name. | |
~CissLabels () | |
Destroys the CissLabels object. | |
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. | |
QString | CompressionRatio () const |
Returns CompressionRatio from the Instrument group. | |
QString | CompressionType () const |
Returns CompressionType from the Instrument group. | |
QString | DataConversionType () const |
Returns DataConversionType from the Instrument group. | |
QString | DelayedReadoutFlag () const |
Returns DelayedReadoutFlag from the Instrument group. | |
double | ExposureDuration () const |
Returns ExposureDuration from the Instrument group. | |
std::vector< QString > | FilterName () const |
Returns a two-element array of the optical filters found in the BandBin group. | |
std::vector< int > | FilterIndex () const |
Returns a two-element array of indices associated with optical filter names. | |
QString | 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. | |
QString | InstrumentId () const |
Returns InstrumentId from the Instrument group. | |
QString | InstrumentModeId () |
Returns the lower case form of InstrumentModeId from the Instrument group. | |
QString | ReadoutCycleIndex () const |
Returns ReadoutCycleIndex from the Instrument group. | |
int | ReadoutOrder () const |
Returns ReadoutOrder from the Instrument group. | |
QString | ShutterModeId () const |
Returns ShutterModeId from the Instrument group. | |
QString | ShutterStateId () const |
Returns ShutterStateId 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". | |
QString | TargetName () const |
Returns the TargetName label as a QString. | |
QString | ImageTime () const |
Returns the Time the photo was taken as a QString. | |
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 | |
QString | 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. | |
QString | p_compressionRatio |
Value of the PDS keyword CompressionRatio in the cube's labels. | |
QString | p_compressionType |
Value of the PDS keyword CompressionType in the cube's labels. | |
QString | p_dataConversionType |
Value of the PDS keyword DataConversionType in the cube's labels. | |
QString | 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. | |
std::vector< QString > | p_filter |
Two-element array of optical filters used for this image. | |
std::vector< int > | p_filterIndex |
Two-element array of filter indices corresponding to optical filters. | |
QString | 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. | |
QString | p_instrumentId |
Value of the PDS keyword InstrumentId in the cube's labels. | |
QString | p_instrumentModeId |
Value of the PDS keyword InstrumentModeId in the cube's labels. | |
QString | 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. | |
QString | p_shutterModeId |
Value of the PDS keyword ShutterModeId in the cube's labels. | |
QString | p_shutterStateId |
Value of the PDS keyword ShutterState in the cube's labels. | |
int | p_summingMode |
Value of the PDS keyword SummingMode in the cube's labels. | |
QString | p_targetName |
Value of the PDS keyword TargetName in the cube's labels. | |
QString | p_imageTime |
Value of the PDS Keyword ImageTime in the cube's labels. | |
Read values from Cassini ISS labels.
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.
2008-11-05 Jeannie Walldren - Original Version
2008-11-07 Jeannie Walldren - Fixed documentation.
2011-05-03 Jeannie Walldren - Fixed documentation.
2017-08-22 Cole Neubauer - Added labels for latest Cisscal upgrade
2019-08-14 Kaitlyn Lee - Added ShutterStateId.
Definition at line 37 of file CissLabels.h.
Isis::CissLabels::CissLabels | ( | Pvl & | lab | ) |
Constructs a CissLabels object from an Isis::Pvl object.
lab | Pvl Labels of Cassini ISS file |
Definition at line 24 of file CissLabels.cpp.
References Init().
Isis::CissLabels::CissLabels | ( | const QString & | file | ) |
Constructs a CissLabels object from a file name.
file | Name of Cassini ISS file |
Definition at line 33 of file CissLabels.cpp.
References Init().
|
inline |
Destroys the CissLabels object.
Definition at line 42 of file CissLabels.h.
|
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".
Definition at line 417 of file CissLabels.h.
References p_antiblooming.
|
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.
Definition at line 85 of file CissLabels.h.
References p_biasStripMean.
|
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 QString so that values other than "NotCompressed" may be converted to double.
Definition at line 101 of file CissLabels.h.
References p_compressionRatio.
|
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).
Definition at line 116 of file CissLabels.h.
References p_compressionType.
|
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 107 of file CissLabels.cpp.
References p_ABflag, p_antiblooming, p_cissNA, p_filter, p_filterIndex, p_instrumentId, and Isis::IException::Unknown.
Referenced by Init().
|
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).
Definition at line 131 of file CissLabels.h.
References p_dataConversionType.
|
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".
Definition at line 145 of file CissLabels.h.
References p_delayedReadoutFlag.
|
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).
Definition at line 159 of file CissLabels.h.
References p_exposureDuration.
|
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.
Definition at line 205 of file CissLabels.h.
References p_filterIndex.
|
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:
Definition at line 190 of file CissLabels.h.
References p_filter.
|
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 QString so that any value other than "Unknown" may be converted to double.
Definition at line 221 of file CissLabels.h.
References p_flightSoftwareVersion.
|
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.
Definition at line 236 of file CissLabels.h.
References p_frontOpticsTemp.
|
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.
Definition at line 251 of file CissLabels.h.
References p_gainModeId.
|
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.
Definition at line 266 of file CissLabels.h.
References p_gainState.
|
inline |
Returns ImageNumber from the Archive group.
Finds the number of seconds on the clock at shutter close. Valid values include real numbers.
Definition at line 279 of file CissLabels.h.
References p_imageNumber.
|
inline |
Returns the Time the photo was taken as a QString.
Returns the ImageTime from the labels as a QString. The returned value is the lower case name of subject of the image.
Definition at line 443 of file CissLabels.h.
References p_imageTime.
|
private |
General initializer.
Reads labels of the file and computes values of image properties not already in the labels.
lab | Pvl Labels of Cassini ISS file |
IException::Pvl | Not valid Cassini ISS instrument |
Definition at line 45 of file CissLabels.cpp.
References ComputeImgProperties(), ReadLabels(), and Isis::IException::Unknown.
Referenced by CissLabels(), and CissLabels().
|
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).
Definition at line 294 of file CissLabels.h.
References p_instrumentDataRate.
|
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").
Definition at line 308 of file CissLabels.h.
References p_instrumentId.
|
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.
Definition at line 326 of file CissLabels.h.
References p_instrumentModeId.
|
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").
Definition at line 55 of file CissLabels.h.
References p_cissNA.
|
private |
Reads the Pvl Labels.
This method reads the required keywords from the labels and sets the values of the private variables.
lab | Pvl Labels of Cassini ISS file |
Definition at line 65 of file CissLabels.cpp.
References 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_imageTime, p_instrumentDataRate, p_instrumentId, p_instrumentModeId, p_readoutCycleIndex, p_readoutOrder, p_shutterModeId, p_shutterStateId, p_summingMode, p_targetName, Isis::toDouble(), Isis::IString::Token(), Isis::IString::ToQt(), and Isis::PvlObject::Traverse.
Referenced by Init().
|
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 QString so that any value not equal to "Unknown" may be converted to int.
Definition at line 342 of file CissLabels.h.
References p_readoutCycleIndex.
|
inline |
Returns ReadoutOrder from the Instrument group.
Finds the integer value representing the readout order of the image. Valid values are
Definition at line 359 of file CissLabels.h.
References p_readoutOrder.
|
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".
Definition at line 374 of file CissLabels.h.
References p_shutterModeId.
|
inline |
Returns ShutterStateId from the Instrument group.
Indicates whether the shutter was enabled during image exposure. Valid values include "Disabled" and "Enabled".
Definition at line 387 of file CissLabels.h.
References p_shutterStateId.
|
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.
Definition at line 403 of file CissLabels.h.
References p_summingMode.
|
inline |
Returns the TargetName label as a QString.
Returns the TargetName from the labels as a QString. The returned value is the lower case name of subject of the image.
Definition at line 430 of file CissLabels.h.
References p_targetName.
|
inline |
Returns whether InstrumentId from the Instrument group is "ISSWA".
Indicates whether the camera used a wide-angle lens ("ISSWA"). False implies it used a narrow-angle lens ("ISSNA").
Definition at line 70 of file CissLabels.h.
References p_cissNA.
|
private |
Value of the PDS keyword AntiBloomingFlag in the cube's labels.
Definition at line 454 of file CissLabels.h.
Referenced by ComputeImgProperties(), and ReadLabels().
|
private |
Indicates whether anti-blooming state flag on.
Definition at line 456 of file CissLabels.h.
Referenced by AntibloomingOn(), and ComputeImgProperties().
|
private |
Value of the PDS keyword BiasStripMean in the cube's labels.
Definition at line 458 of file CissLabels.h.
Referenced by BiasStripMean(), and ReadLabels().
|
private |
Indicates whether camera is narrow-angle.
Definition at line 460 of file CissLabels.h.
Referenced by ComputeImgProperties(), NarrowAngle(), and WideAngle().
|
private |
Value of the PDS keyword CompressionRatio in the cube's labels.
Definition at line 462 of file CissLabels.h.
Referenced by CompressionRatio(), and ReadLabels().
|
private |
Value of the PDS keyword CompressionType in the cube's labels.
Definition at line 464 of file CissLabels.h.
Referenced by CompressionType(), and ReadLabels().
|
private |
Value of the PDS keyword DataConversionType in the cube's labels.
Definition at line 466 of file CissLabels.h.
Referenced by DataConversionType(), and ReadLabels().
|
private |
Value of the PDS keyword DelayedReadoutFlag in the cube's labels.
Definition at line 468 of file CissLabels.h.
Referenced by DelayedReadoutFlag(), and ReadLabels().
|
private |
Value of the PDS keyword ExposureDuration in the cube's labels.
Definition at line 470 of file CissLabels.h.
Referenced by ExposureDuration(), and ReadLabels().
|
private |
Two-element array of optical filters used for this image.
Definition at line 472 of file CissLabels.h.
Referenced by ComputeImgProperties(), FilterName(), and ReadLabels().
|
private |
Two-element array of filter indices corresponding to optical filters.
Definition at line 474 of file CissLabels.h.
Referenced by ComputeImgProperties(), and FilterIndex().
|
private |
Value of the PDS keyword FlightSoftwareVersion in the cube's labels.
Definition at line 476 of file CissLabels.h.
Referenced by FlightSoftwareVersion(), and ReadLabels().
|
private |
Value of the PDS keyword OpticsTemperature[0] in the cube's labels.
Definition at line 478 of file CissLabels.h.
Referenced by FrontOpticsTemp(), and ReadLabels().
|
private |
Value of the PDS keyword GainModeId in the cube's labels.
Definition at line 480 of file CissLabels.h.
Referenced by GainModeId(), and ReadLabels().
|
private |
Value of the PDS keyword GainState in the cube's labels.
Definition at line 482 of file CissLabels.h.
Referenced by GainState(), and ReadLabels().
|
private |
Value of the PDS keyword ImageNumber in the cube's labels.
Definition at line 484 of file CissLabels.h.
Referenced by ImageNumber(), and ReadLabels().
|
private |
Value of the PDS Keyword ImageTime in the cube's labels.
Definition at line 504 of file CissLabels.h.
Referenced by ImageTime(), and ReadLabels().
|
private |
Value of the PDS keyword ImageTime in the cube's labels.
Definition at line 486 of file CissLabels.h.
Referenced by InstrumentDataRate(), and ReadLabels().
|
private |
Value of the PDS keyword InstrumentId in the cube's labels.
Definition at line 488 of file CissLabels.h.
Referenced by ComputeImgProperties(), InstrumentId(), and ReadLabels().
|
private |
Value of the PDS keyword InstrumentModeId in the cube's labels.
Definition at line 490 of file CissLabels.h.
Referenced by InstrumentModeId(), and ReadLabels().
|
private |
Value of the PDS keyword ReadoutCycleIndex in the cube's labels.
Definition at line 492 of file CissLabels.h.
Referenced by ReadLabels(), and ReadoutCycleIndex().
|
private |
Value of the PDS keyword ReadoutOrder in the cube's labels.
Definition at line 494 of file CissLabels.h.
Referenced by ReadLabels(), and ReadoutOrder().
|
private |
Value of the PDS keyword ShutterModeId in the cube's labels.
Definition at line 496 of file CissLabels.h.
Referenced by ReadLabels(), and ShutterModeId().
|
private |
Value of the PDS keyword ShutterState in the cube's labels.
Definition at line 498 of file CissLabels.h.
Referenced by ReadLabels(), and ShutterStateId().
|
private |
Value of the PDS keyword SummingMode in the cube's labels.
Definition at line 500 of file CissLabels.h.
Referenced by ReadLabels(), and SummingMode().
|
private |
Value of the PDS keyword TargetName in the cube's labels.
Definition at line 502 of file CissLabels.h.
Referenced by ReadLabels(), and TargetName().