File failed to load: https://isis.astrogeology.usgs.gov/6.0.0/Object/assets/jax/output/NativeMML/config.js
Isis 3 Programmer Reference
CissLabels.h
1 #ifndef CISSLABELS_H
2 #define CISSLABELS_H
3 
10 /* SPDX-License-Identifier: CC0-1.0 */
11 
12 #include <string>
13 #include <vector>
14 
15 #include <QString>
16 
17 namespace Isis {
18  class Pvl;
37  class CissLabels {
38  public:
39  CissLabels(Pvl &lab);
40  CissLabels(const QString &file);
43 
44 
55  inline bool NarrowAngle() const {
56  return p_cissNA;
57  };
58 
59 
70  inline bool WideAngle() const {
71  return !p_cissNA;
72  };
73 
74 
85  inline double BiasStripMean() const {
86  return p_biasStripMean;
87  };
88 
89 
101  inline QString CompressionRatio() const {
102  return p_compressionRatio;
103  };
104 
105 
116  inline QString CompressionType() const {
117  return p_compressionType;
118  };
119 
120 
131  inline QString DataConversionType() const {
132  return p_dataConversionType;
133  };
134 
135 
145  inline QString DelayedReadoutFlag() const {
146  return p_delayedReadoutFlag;
147  };
148 
149 
159  inline double ExposureDuration() const {
160  return p_exposureDuration;
161  };
162 
163 
190  std::vector <QString> FilterName() const {
191  return p_filter;
192  };
193 
194 
205  std::vector <int> FilterIndex() const {
206  return p_filterIndex;
207  };
208 
209 
221  inline QString FlightSoftwareVersion() const {
223  };
224 
225 
236  inline double FrontOpticsTemp() const {
237  return p_frontOpticsTemp;
238  };
239 
240 
251  inline int GainModeId() const {
252  return p_gainModeId;
253  };
254 
255 
266  inline int GainState() const {
267  return p_gainState;
268  };
269 
270 
279  inline double ImageNumber() const {
280  return p_imageNumber;
281  };
282 
283 
294  inline double InstrumentDataRate() const {
295  return p_instrumentDataRate;
296  };
297 
298 
308  inline QString InstrumentId() const {
309  return p_instrumentId;
310  };
311 
312 
326  inline QString InstrumentModeId() {
327  return p_instrumentModeId.toLower();
328  };
329 
330 
342  inline QString ReadoutCycleIndex() const {
343  return p_readoutCycleIndex;
344  };
345 
346 
359  inline int ReadoutOrder() const {
360  return p_readoutOrder;
361  };
362 
363 
374  inline QString ShutterModeId() const {
375  return p_shutterModeId;
376  };
377 
378 
387  inline QString ShutterStateId() const {
388  return p_shutterStateId;
389  };
390 
391 
403  inline int SummingMode() const {
404  return p_summingMode;
405  };
406 
407 
417  inline bool AntibloomingOn() const {
418  return p_antiblooming;
419  };
420 
421 
430  inline QString TargetName() const {
431  return p_targetName.toLower();
432  };
433 
434 
443  inline QString ImageTime() const {
444  return p_imageTime.toLower();
445  };
446 
447  private:
448  void Init(Pvl &lab);
449  void ReadLabels(Pvl &lab);
450  void ComputeImgProperties();
451 
452 
454  QString p_ABflag;
460  bool p_cissNA;
472  std::vector <QString> p_filter;
474  std::vector <int> p_filterIndex;
488  QString p_instrumentId;
502  QString p_targetName;
504  QString p_imageTime;
505  };
506 };
507 
508 #endif
Isis::CissLabels::p_compressionRatio
QString p_compressionRatio
Value of the PDS keyword CompressionRatio in the cube's labels.
Definition: CissLabels.h:462
Isis::CissLabels::ReadLabels
void ReadLabels(Pvl &lab)
Reads the Pvl Labels.
Definition: CissLabels.cpp:65
Isis::CissLabels::DelayedReadoutFlag
QString DelayedReadoutFlag() const
Returns DelayedReadoutFlag from the Instrument group.
Definition: CissLabels.h:145
Isis::CissLabels::p_cissNA
bool p_cissNA
Indicates whether camera is narrow-angle.
Definition: CissLabels.h:460
Isis::CissLabels::p_targetName
QString p_targetName
Value of the PDS keyword TargetName in the cube's labels.
Definition: CissLabels.h:502
Isis::CissLabels::p_imageNumber
double p_imageNumber
Value of the PDS keyword ImageNumber in the cube's labels.
Definition: CissLabels.h:484
Isis::CissLabels::CissLabels
CissLabels(Pvl &lab)
Constructs a CissLabels object from an Isis::Pvl object.
Definition: CissLabels.cpp:24
Isis::CissLabels::ImageTime
QString ImageTime() const
Returns the Time the photo was taken as a QString.
Definition: CissLabels.h:443
Isis::CissLabels::Init
void Init(Pvl &lab)
General initializer.
Definition: CissLabels.cpp:45
Isis::CissLabels::DataConversionType
QString DataConversionType() const
Returns DataConversionType from the Instrument group.
Definition: CissLabels.h:131
Isis::CissLabels::p_exposureDuration
double p_exposureDuration
Value of the PDS keyword ExposureDuration in the cube's labels.
Definition: CissLabels.h:470
Isis::CissLabels::TargetName
QString TargetName() const
Returns the TargetName label as a QString.
Definition: CissLabels.h:430
Isis::CissLabels::p_readoutCycleIndex
QString p_readoutCycleIndex
Value of the PDS keyword ReadoutCycleIndex in the cube's labels.
Definition: CissLabels.h:492
Isis::CissLabels::NarrowAngle
bool NarrowAngle() const
Returns whether InstrumentId from the Instrument group is "ISSNA".
Definition: CissLabels.h:55
Isis::CissLabels::GainModeId
int GainModeId() const
Returns GainModeId from the Instrument group.
Definition: CissLabels.h:251
Isis::CissLabels::FlightSoftwareVersion
QString FlightSoftwareVersion() const
Returns FlightSoftwareVersion from the Instrument group.
Definition: CissLabels.h:221
Isis::CissLabels::FilterName
std::vector< QString > FilterName() const
Returns a two-element array of the optical filters found in the BandBin group.
Definition: CissLabels.h:190
Isis::CissLabels::p_shutterStateId
QString p_shutterStateId
Value of the PDS keyword ShutterState in the cube's labels.
Definition: CissLabels.h:498
Isis::CissLabels::CompressionType
QString CompressionType() const
Returns CompressionType from the Instrument group.
Definition: CissLabels.h:116
Isis::CissLabels::p_instrumentModeId
QString p_instrumentModeId
Value of the PDS keyword InstrumentModeId in the cube's labels.
Definition: CissLabels.h:490
Isis::Pvl
Container for cube-like labels.
Definition: Pvl.h:119
Isis::CissLabels::p_compressionType
QString p_compressionType
Value of the PDS keyword CompressionType in the cube's labels.
Definition: CissLabels.h:464
Isis::CissLabels::CompressionRatio
QString CompressionRatio() const
Returns CompressionRatio from the Instrument group.
Definition: CissLabels.h:101
Isis::CissLabels::ShutterStateId
QString ShutterStateId() const
Returns ShutterStateId from the Instrument group.
Definition: CissLabels.h:387
Isis::CissLabels::ComputeImgProperties
void ComputeImgProperties()
Computes values of non-keyword image properties.
Definition: CissLabels.cpp:107
Isis::CissLabels::p_biasStripMean
double p_biasStripMean
Value of the PDS keyword BiasStripMean in the cube's labels.
Definition: CissLabels.h:458
Isis::CissLabels::~CissLabels
~CissLabels()
Destroys the CissLabels object.
Definition: CissLabels.h:42
Isis::CissLabels::p_ABflag
QString p_ABflag
Value of the PDS keyword AntiBloomingFlag in the cube's labels.
Definition: CissLabels.h:454
Isis::CissLabels::p_imageTime
QString p_imageTime
Value of the PDS Keyword ImageTime in the cube's labels.
Definition: CissLabels.h:504
Isis::CissLabels::p_gainModeId
int p_gainModeId
Value of the PDS keyword GainModeId in the cube's labels.
Definition: CissLabels.h:480
Isis::CissLabels::InstrumentModeId
QString InstrumentModeId()
Returns the lower case form of InstrumentModeId from the Instrument group.
Definition: CissLabels.h:326
Isis::CissLabels::SummingMode
int SummingMode() const
Returns SummingMode from the Instrument group.
Definition: CissLabels.h:403
Isis::CissLabels
Read values from Cassini ISS labels.
Definition: CissLabels.h:37
Isis::CissLabels::FrontOpticsTemp
double FrontOpticsTemp() const
Returns the first element of OpticsTemperature from the Instrument group.
Definition: CissLabels.h:236
Isis::CissLabels::p_shutterModeId
QString p_shutterModeId
Value of the PDS keyword ShutterModeId in the cube's labels.
Definition: CissLabels.h:496
Isis::CissLabels::p_filterIndex
std::vector< int > p_filterIndex
Two-element array of filter indices corresponding to optical filters.
Definition: CissLabels.h:474
Isis::CissLabels::p_frontOpticsTemp
double p_frontOpticsTemp
Value of the PDS keyword OpticsTemperature[0] in the cube's labels.
Definition: CissLabels.h:478
Isis::CissLabels::AntibloomingOn
bool AntibloomingOn() const
Returns whether AntiBloomingFlag from the Instrument group is "On".
Definition: CissLabels.h:417
Isis::CissLabels::InstrumentDataRate
double InstrumentDataRate() const
Returns InstrumentDataRate from the Instrument group.
Definition: CissLabels.h:294
Isis::CissLabels::FilterIndex
std::vector< int > FilterIndex() const
Returns a two-element array of indices associated with optical filter names.
Definition: CissLabels.h:205
Isis::CissLabels::ReadoutCycleIndex
QString ReadoutCycleIndex() const
Returns ReadoutCycleIndex from the Instrument group.
Definition: CissLabels.h:342
Isis::CissLabels::ReadoutOrder
int ReadoutOrder() const
Returns ReadoutOrder from the Instrument group.
Definition: CissLabels.h:359
Isis::CissLabels::p_instrumentDataRate
double p_instrumentDataRate
Value of the PDS keyword ImageTime in the cube's labels.
Definition: CissLabels.h:486
Isis::CissLabels::WideAngle
bool WideAngle() const
Returns whether InstrumentId from the Instrument group is "ISSWA".
Definition: CissLabels.h:70
Isis::CissLabels::p_filter
std::vector< QString > p_filter
Two-element array of optical filters used for this image.
Definition: CissLabels.h:472
Isis::CissLabels::p_gainState
int p_gainState
Value of the PDS keyword GainState in the cube's labels.
Definition: CissLabels.h:482
Isis::CissLabels::p_instrumentId
QString p_instrumentId
Value of the PDS keyword InstrumentId in the cube's labels.
Definition: CissLabels.h:488
Isis::CissLabels::ExposureDuration
double ExposureDuration() const
Returns ExposureDuration from the Instrument group.
Definition: CissLabels.h:159
Isis::CissLabels::ShutterModeId
QString ShutterModeId() const
Returns ShutterModeId from the Instrument group.
Definition: CissLabels.h:374
Isis::CissLabels::ImageNumber
double ImageNumber() const
Returns ImageNumber from the Archive group.
Definition: CissLabels.h:279
Isis::CissLabels::InstrumentId
QString InstrumentId() const
Returns InstrumentId from the Instrument group.
Definition: CissLabels.h:308
Isis::CissLabels::p_dataConversionType
QString p_dataConversionType
Value of the PDS keyword DataConversionType in the cube's labels.
Definition: CissLabels.h:466
Isis::CissLabels::p_antiblooming
bool p_antiblooming
Indicates whether anti-blooming state flag on.
Definition: CissLabels.h:456
Isis::CissLabels::GainState
int GainState() const
Returns GainState from the Instrument group.
Definition: CissLabels.h:266
Isis::CissLabels::p_readoutOrder
int p_readoutOrder
Value of the PDS keyword ReadoutOrder in the cube's labels.
Definition: CissLabels.h:494
Isis::CissLabels::p_delayedReadoutFlag
QString p_delayedReadoutFlag
Value of the PDS keyword DelayedReadoutFlag in the cube's labels.
Definition: CissLabels.h:468
Isis::CissLabels::p_flightSoftwareVersion
QString p_flightSoftwareVersion
Value of the PDS keyword FlightSoftwareVersion in the cube's labels.
Definition: CissLabels.h:476
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Isis::CissLabels::p_summingMode
int p_summingMode
Value of the PDS keyword SummingMode in the cube's labels.
Definition: CissLabels.h:500
Isis::CissLabels::BiasStripMean
double BiasStripMean() const
Returns BiasStripMean from the Intstrument group.
Definition: CissLabels.h:85

U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the USGS Astrogeology Discussion Board
To report a bug, or suggest a feature go to: ISIS Github
File Modified: 07/13/2023 15:16:15