|
Isis 3.0 Developer's Reference (API) |
Home |
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 std::string &file) | |
| ~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. | |
| 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. | |
| std::vector< iString > | 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. | |
| 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". | |
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.
| Isis::CissLabels::CissLabels | ( | Pvl & | lab | ) |
Constructs a CissLabels object from an Isis::Pvl object.
| lab | Pvl Labels of Cassini ISS file |
| Isis::CissLabels::CissLabels | ( | const std::string & | file | ) |
| Isis::CissLabels::~CissLabels | ( | ) | [inline] |
Destroys the CissLabels object.
| 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".
| 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.
| 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.
| iString Isis::CissLabels::CompressionType | ( | ) | const [inline] |
| 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).
| 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".
| 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).
| std::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.
| std::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:
| 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.
| 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.
| 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.
| 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.
| 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.
| 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).
| 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").
| 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.
References Isis::iString::DownCase().
| 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").
| 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.
| 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
| 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".
| 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.
| bool Isis::CissLabels::WideAngle | ( | ) | const [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").