Isis 3 Programmer Reference

Read values from MOC labels. More...

#include <MocLabels.h>

Collaboration diagram for Isis::MocLabels:
Collaboration graph

Classes

struct  WAGO
 

Public Member Functions

 MocLabels (Cube &cube)
 Construct MocLabels object using a Pvl object. More...
 
 MocLabels (const QString &file)
 Construct MocLabels object using the file name. More...
 
 ~MocLabels ()
 Empty destructor. More...
 
bool NarrowAngle () const
 Indicates whether the camera was narrow angle. More...
 
bool WideAngle () const
 Indicates whether the camera was wide angle. More...
 
bool WideAngleRed () const
 Indicates whether the camera was red wide angle. More...
 
bool WideAngleBlue () const
 Indicates whether the camera was blue wide angle. More...
 
int CrosstrackSumming () const
 Returns value for CrosstrackSumming from the instrument group. More...
 
int DowntrackSumming () const
 Returns value for DowntrackSumming from the instrument group. More...
 
int FirstLineSample () const
 Returns value for FirstLineSample from the instrument group. More...
 
double FocalPlaneTemperature () const
 Returns value for FocalPlaneTemperature from the instrument group. More...
 
double LineRate () const
 Returns the value for the true line rate. More...
 
double ExposureDuration () const
 Returns the value for LineExposureDuration from the instrument group. More...
 
QString StartTime () const
 Returns the value for StartTime from the instrument group. More...
 
int Detectors () const
 Returns 2048 if narrow angle and 3456 if wide angle. More...
 
int StartDetector (int sample) const
 Converts from sample to starting detector. More...
 
int EndDetector (int sample) const
 Converts from sample to ending detector. More...
 
double Sample (int detector) const
 Converts from detector to sample. More...
 
double EphemerisTime (double line) const
 Returns the ephemeris time at the given line. More...
 
double Gain (int line=1)
 Returns the true gain at a given line. More...
 
double Offset (int line=1)
 Returns the offset at the given line. More...
 

Private Member Functions

void Init (Cube &cube)
 General initializer. More...
 
void ReadLabels (Cube &cube)
 Reads required keywords from the labels. More...
 
void ValidateLabels ()
 Verifies that the labels are valid. More...
 
void Compute ()
 Computes some constants. More...
 
void InitGainMaps ()
 Creates a lookup of gain modes to gain values. More...
 
void InitDetectorMaps ()
 Creates lookup table from sample to detectors and vice versa. More...
 
void InitWago ()
 Reads the wide-angle gain/offset table and internalizes. More...
 

Private Attributes

int p_crosstrackSumming
 
int p_downtrackSumming
 
int p_startingSample
 
int p_orbitNumber
 
double p_exposureDuration
 
double p_trueLineRate
 
double p_focalPlaneTemp
 
bool p_mocNA
 
bool p_mocRedWA
 
bool p_mocBlueWA
 
QString p_instrumentId
 
QString p_filter
 
QString p_clockCount
 
QString p_gainModeId
 
int p_offsetModeId
 
QString p_startTime
 
QString p_dataQuality
 
double p_etStart
 
double p_etEnd
 
std::map< QString, double > p_gainMapNA
 
std::map< QString, double > p_gainMapWA
 
double p_gain
 
double p_offset
 
int p_nl
 
int p_ns
 
int p_startDetector [3456]
 
int p_endDetector [3456]
 
double p_sample [3456]
 
std::vector< WAGOp_wagos
 
FileName p_lsk
 
FileName p_sclk
 

Detailed Description

Read values from MOC labels.

Author
2007-01-30 Author Unknown
History:

2008-04-30 Steven Lambright corrected infinite loop

2008-05-29 Steven Lambright Fixed binary search indexing, bad calls to QString::_cstr() references

2008-06-18 Steven Koechle - Fixed Documentation Errors

2008-08-11 Steven Lambright - Fixed definition of WAGO, problem pointed out by "novas0x2a" (Support Board Member)

2008-11-05 Jeannie Walldren - Changed IsNarrowAngle(), IsWideAngle(), IsWideAngleBlue(), and IsWideAngleRed() to NarrowAngle(), WideAngle(), WideAngleBlue(), and WideAngleRed(), respectively. Added documentation.

2008-11-07 Jeannie Walldren - Fixed documentation

2010-01-05 Jeannie Walldren - Fixed bug in InitWago() method.

2011-05-03 Jeannie Walldren - Removed Mgs namespace wrap.

Definition at line 63 of file MocLabels.h.

Constructor & Destructor Documentation

◆ MocLabels() [1/2]

Isis::MocLabels::MocLabels ( Cube cube)

Construct MocLabels object using a Pvl object.

Definition at line 30 of file MocLabels.cpp.

◆ MocLabels() [2/2]

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

Construct MocLabels object using the file name.

Definition at line 22 of file MocLabels.cpp.

◆ ~MocLabels()

Isis::MocLabels::~MocLabels ( )
inline

Empty destructor.

Definition at line 68 of file MocLabels.h.

Member Function Documentation

◆ Compute()

void Isis::MocLabels::Compute ( )
private

Computes some constants.

Definition at line 152 of file MocLabels.cpp.

References _FILEINFO_.

◆ CrosstrackSumming()

int Isis::MocLabels::CrosstrackSumming ( ) const
inline

Returns value for CrosstrackSumming from the instrument group.

Returns
int Crosstrack summing

Definition at line 105 of file MocLabels.h.

Referenced by Isis::MocWideAngleCamera::MocWideAngleCamera().

◆ Detectors()

int Isis::MocLabels::Detectors ( ) const
inline

Returns 2048 if narrow angle and 3456 if wide angle.

Returns
int Value of detectors.

Definition at line 158 of file MocLabels.h.

◆ DowntrackSumming()

int Isis::MocLabels::DowntrackSumming ( ) const
inline

Returns value for DowntrackSumming from the instrument group.

Returns
int Downtrack summing

Definition at line 112 of file MocLabels.h.

Referenced by Isis::MocWideAngleCamera::MocWideAngleCamera().

◆ EndDetector()

int Isis::MocLabels::EndDetector ( int  sample) const

Converts from sample to ending detector.

Parameters
sampleSample to be converted
Returns
int Converted ending detector

Definition at line 295 of file MocLabels.cpp.

References _FILEINFO_.

◆ EphemerisTime()

double Isis::MocLabels::EphemerisTime ( double  line) const

Returns the ephemeris time at the given line.

Parameters
lineLine to evaluate
Returns
double Ephemeris time

Definition at line 366 of file MocLabels.cpp.

◆ ExposureDuration()

double Isis::MocLabels::ExposureDuration ( ) const
inline

Returns the value for LineExposureDuration from the instrument group.

Returns
double Line exposure duration

Definition at line 144 of file MocLabels.h.

◆ FirstLineSample()

int Isis::MocLabels::FirstLineSample ( ) const
inline

Returns value for FirstLineSample from the instrument group.

Returns
int First line sample

Definition at line 119 of file MocLabels.h.

Referenced by Isis::MocWideAngleCamera::MocWideAngleCamera().

◆ FocalPlaneTemperature()

double Isis::MocLabels::FocalPlaneTemperature ( ) const
inline

Returns value for FocalPlaneTemperature from the instrument group.

Returns
double Focal plane temperature

Definition at line 127 of file MocLabels.h.

◆ Gain()

double Isis::MocLabels::Gain ( int  line = 1)

Returns the true gain at a given line.

Parameters
lineLine to evaluate
Returns
double True gain

Definition at line 375 of file MocLabels.cpp.

◆ Init()

void Isis::MocLabels::Init ( Cube cube)
private

General initializer.

Parameters
labMOC label for the image

Definition at line 38 of file MocLabels.cpp.

References _FILEINFO_.

◆ InitDetectorMaps()

void Isis::MocLabels::InitDetectorMaps ( )
private

Creates lookup table from sample to detectors and vice versa.

Definition at line 317 of file MocLabels.cpp.

◆ InitGainMaps()

void Isis::MocLabels::InitGainMaps ( )
private

Creates a lookup of gain modes to gain values.

These come from the MSSS calibration report.

Definition at line 238 of file MocLabels.cpp.

◆ InitWago()

void Isis::MocLabels::InitWago ( )
private

Reads the wide-angle gain/offset table and internalizes.

History:
2010-01-05 Jeannie Walldren - Fixed bug that passed sclkKern filename into scs2e_c instead of the sclk string.

Definition at line 415 of file MocLabels.cpp.

References _FILEINFO_, Isis::IString::ConvertWhiteSpace(), Isis::IString::Remove(), Isis::IString::ToDouble(), Isis::IString::Token(), Isis::IString::ToQt(), and Isis::IString::Trim().

◆ LineRate()

double Isis::MocLabels::LineRate ( ) const
inline

Returns the value for the true line rate.

This is calculated by dividing the product of LineExposureDuration and the DowntrackSumming by 1000.

Returns
double Value for the true line rate

Definition at line 136 of file MocLabels.h.

Referenced by Isis::MocWideAngleCamera::MocWideAngleCamera().

◆ NarrowAngle()

bool Isis::MocLabels::NarrowAngle ( ) const
inline

Indicates whether the camera was narrow angle.

Returns
bool True if the instrument ID is MOC-NA.

Definition at line 74 of file MocLabels.h.

◆ Offset()

double Isis::MocLabels::Offset ( int  line = 1)

Returns the offset at the given line.

Parameters
lineLine to evaluate
Returns
double Offset

Definition at line 394 of file MocLabels.cpp.

◆ ReadLabels()

void Isis::MocLabels::ReadLabels ( Cube cube)
private

Reads required keywords from the labels.

Parameters
MOClabel for the image

Definition at line 56 of file MocLabels.cpp.

References Isis::AlphaCube::AlphaLines(), Isis::AlphaCube::AlphaSamples(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), and Isis::Cube::label().

◆ Sample()

double Isis::MocLabels::Sample ( int  detector) const

Converts from detector to sample.

Parameters
detectorDetector to be converted
Returns
double Converted sample

Definition at line 307 of file MocLabels.cpp.

References _FILEINFO_.

◆ StartDetector()

int Isis::MocLabels::StartDetector ( int  sample) const

Converts from sample to starting detector.

Parameters
sampleSample to be converted
Returns
int Converted start detector

Definition at line 283 of file MocLabels.cpp.

References _FILEINFO_.

◆ StartTime()

QString Isis::MocLabels::StartTime ( ) const
inline

Returns the value for StartTime from the instrument group.

Returns
QString Start time

Definition at line 151 of file MocLabels.h.

◆ ValidateLabels()

void Isis::MocLabels::ValidateLabels ( )
private

Verifies that the labels are valid.

Definition at line 101 of file MocLabels.cpp.

References _FILEINFO_.

◆ WideAngle()

bool Isis::MocLabels::WideAngle ( ) const
inline

Indicates whether the camera was wide angle.

Returns
bool True if the instrument ID is MOC-WA.

Definition at line 81 of file MocLabels.h.

◆ WideAngleBlue()

bool Isis::MocLabels::WideAngleBlue ( ) const
inline

Indicates whether the camera was blue wide angle.

Returns
bool True if the instrument ID is MOC-WA and filter name is BLUE.

Definition at line 97 of file MocLabels.h.

◆ WideAngleRed()

bool Isis::MocLabels::WideAngleRed ( ) const
inline

Indicates whether the camera was red wide angle.

Returns
bool True if the instrument ID is MOC-WA and filter name is RED.

Definition at line 89 of file MocLabels.h.

Referenced by Isis::MocWideAngleCamera::MocWideAngleCamera().


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