Read values from Cassini ISS labels. More...

#include <CissLabels.h>

Collaboration diagram for Isis::CissLabels:

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.

Detailed Description

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.

Author: 2008-11-05 Jeannie Walldren

Constructor & Destructor Documentation

◆ CissLabels() [1/2]

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

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

Parameters

lab	Pvl Labels of Cassini ISS file

◆ CissLabels() [2/2]

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

Constructs a CissLabels object from a file name.

Parameters

file	Name of Cassini ISS file

◆ ~CissLabels()

Isis::CissLabels::~CissLabels ( )

inline

Destroys the CissLabels object.

Member Function Documentation

◆ AntibloomingOn()

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"

◆ BiasStripMean()

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

◆ CompressionRatio()

QString 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 QString so that values other than "NotCompressed" may be converted to double.

Returns: QString CompressionRatio

◆ CompressionType()

QString 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: QString CompressionType

◆ DataConversionType()

QString 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: QString DataConversionType

◆ DelayedReadoutFlag()

QString 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: QString DelayedReadoutFlag

◆ ExposureDuration()

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

◆ FilterIndex()

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.

Returns: vector <int> The filter indices.

◆ FilterName()

std::vector< QString > 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 <QString> The optical filter names.

◆ FlightSoftwareVersion()

QString 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 QString so that any value other than "Unknown" may be converted to double.

Returns: QString FlightSoftwareVersion

◆ FrontOpticsTemp()

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]

◆ GainModeId()

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()

◆ GainState()

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()

◆ ImageNumber()

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

◆ ImageTime()

QString Isis::CissLabels::ImageTime ( ) const

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.

Returns: QString TargetName

◆ InstrumentDataRate()

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

◆ InstrumentId()

QString 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: QString InstrumentId

◆ InstrumentModeId()

QString 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()

◆ NarrowAngle()

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

◆ ReadoutCycleIndex()

QString 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 QString so that any value not equal to "Unknown" may be converted to int.

Returns: QString ReadoutCycleIndex

◆ ReadoutOrder()

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

◆ ShutterModeId()

QString 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: QString ShutterModeId

◆ ShutterStateId()

QString Isis::CissLabels::ShutterStateId ( ) const

inline

Returns ShutterStateId from the Instrument group.

Indicates whether the shutter was enabled during image exposure. Valid values include "Disabled" and "Enabled".

Returns: QString ShutterStateId

◆ SummingMode()

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.

Returns: int SummingMode

See also: InstrumentModeId()

◆ TargetName()

QString Isis::CissLabels::TargetName ( ) const

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.

Returns: QString TargetName

◆ WideAngle()

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").

Returns: bool True if instrument ISSWA

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

/Users/chkim/repos/ISIS3/isis/src/cassini/objs/CissLabels/CissLabels.h
/Users/chkim/repos/ISIS3/isis/src/cassini/objs/CissLabels/CissLabels.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CissLabels() [1/2]

◆ CissLabels() [2/2]

◆ ~CissLabels()

Member Function Documentation

◆ AntibloomingOn()

◆ BiasStripMean()

◆ CompressionRatio()

◆ CompressionType()

◆ DataConversionType()

◆ DelayedReadoutFlag()

◆ ExposureDuration()

◆ FilterIndex()

◆ FilterName()

◆ FlightSoftwareVersion()

◆ FrontOpticsTemp()

◆ GainModeId()

◆ GainState()

◆ ImageNumber()

◆ ImageTime()

◆ InstrumentDataRate()

◆ InstrumentId()

◆ InstrumentModeId()

◆ NarrowAngle()

◆ ReadoutCycleIndex()

◆ ReadoutOrder()

◆ ShutterModeId()

◆ ShutterStateId()

◆ SummingMode()

◆ TargetName()

◆ WideAngle()