Isis 3 Programmer Reference
CissLabels.h
Go to the documentation of this file.
1 #ifndef CISSLABELS_H
2 #define CISSLABELS_H
3 
25 #include <string>
26 #include <vector>
27 
28 #include <QString>
29 
30 namespace Isis {
31  class Pvl;
50  class CissLabels {
51  public:
52  CissLabels(Pvl &lab);
53  CissLabels(const QString &file);
56 
57 
68  inline bool NarrowAngle() const {
69  return p_cissNA;
70  };
71 
72 
83  inline bool WideAngle() const {
84  return !p_cissNA;
85  };
86 
87 
98  inline double BiasStripMean() const {
99  return p_biasStripMean;
100  };
101 
102 
114  inline QString CompressionRatio() const {
115  return p_compressionRatio;
116  };
117 
118 
129  inline QString CompressionType() const {
130  return p_compressionType;
131  };
132 
133 
144  inline QString DataConversionType() const {
145  return p_dataConversionType;
146  };
147 
148 
158  inline QString DelayedReadoutFlag() const {
159  return p_delayedReadoutFlag;
160  };
161 
162 
172  inline double ExposureDuration() const {
173  return p_exposureDuration;
174  };
175 
176 
203  std::vector <QString> FilterName() const {
204  return p_filter;
205  };
206 
207 
218  std::vector <int> FilterIndex() const {
219  return p_filterIndex;
220  };
221 
222 
234  inline QString FlightSoftwareVersion() const {
236  };
237 
238 
249  inline double FrontOpticsTemp() const {
250  return p_frontOpticsTemp;
251  };
252 
253 
264  inline int GainModeId() const {
265  return p_gainModeId;
266  };
267 
268 
279  inline int GainState() const {
280  return p_gainState;
281  };
282 
283 
292  inline double ImageNumber() const {
293  return p_imageNumber;
294  };
295 
296 
307  inline double InstrumentDataRate() const {
308  return p_instrumentDataRate;
309  };
310 
311 
321  inline QString InstrumentId() const {
322  return p_instrumentId;
323  };
324 
325 
339  inline QString InstrumentModeId() {
340  return p_instrumentModeId.toLower();
341  };
342 
343 
355  inline QString ReadoutCycleIndex() const {
356  return p_readoutCycleIndex;
357  };
358 
359 
372  inline int ReadoutOrder() const {
373  return p_readoutOrder;
374  };
375 
376 
387  inline QString ShutterModeId() const {
388  return p_shutterModeId;
389  };
390 
391 
400  inline QString ShutterStateId() const {
401  return p_shutterStateId;
402  };
403 
404 
416  inline int SummingMode() const {
417  return p_summingMode;
418  };
419 
420 
430  inline bool AntibloomingOn() const {
431  return p_antiblooming;
432  };
433 
434 
443  inline QString TargetName() const {
444  return p_targetName.toLower();
445  };
446 
447 
456  inline QString ImageTime() const {
457  return p_imageTime.toLower();
458  };
459 
460  private:
461  void Init(Pvl &lab);
462  void ReadLabels(Pvl &lab);
463  void ComputeImgProperties();
464 
465 
467  QString p_ABflag;
473  bool p_cissNA;
485  std::vector <QString> p_filter;
487  std::vector <int> p_filterIndex;
501  QString p_instrumentId;
515  QString p_targetName;
517  QString p_imageTime;
518  };
519 };
520 
521 #endif
~CissLabels()
Destroys the CissLabels object.
Definition: CissLabels.h:55
int GainModeId() const
Returns GainModeId from the Instrument group.
Definition: CissLabels.h:264
bool WideAngle() const
Returns whether InstrumentId from the Instrument group is "ISSWA".
Definition: CissLabels.h:83
std::vector< QString > FilterName() const
Returns a two-element array of the optical filters found in the BandBin group.
Definition: CissLabels.h:203
double p_instrumentDataRate
Value of the PDS keyword ImageTime in the cube&#39;s labels.
Definition: CissLabels.h:499
std::vector< int > p_filterIndex
Two-element array of filter indices corresponding to optical filters.
Definition: CissLabels.h:487
void ReadLabels(Pvl &lab)
Reads the Pvl Labels.
Definition: CissLabels.cpp:57
QString p_compressionType
Value of the PDS keyword CompressionType in the cube&#39;s labels.
Definition: CissLabels.h:477
QString InstrumentId() const
Returns InstrumentId from the Instrument group.
Definition: CissLabels.h:321
QString p_instrumentModeId
Value of the PDS keyword InstrumentModeId in the cube&#39;s labels.
Definition: CissLabels.h:503
QString InstrumentModeId()
Returns the lower case form of InstrumentModeId from the Instrument group.
Definition: CissLabels.h:339
QString p_targetName
Value of the PDS keyword TargetName in the cube&#39;s labels.
Definition: CissLabels.h:515
int ReadoutOrder() const
Returns ReadoutOrder from the Instrument group.
Definition: CissLabels.h:372
QString p_shutterModeId
Value of the PDS keyword ShutterModeId in the cube&#39;s labels.
Definition: CissLabels.h:509
double p_frontOpticsTemp
Value of the PDS keyword OpticsTemperature[0] in the cube&#39;s labels.
Definition: CissLabels.h:491
bool p_antiblooming
Indicates whether anti-blooming state flag on.
Definition: CissLabels.h:469
double p_exposureDuration
Value of the PDS keyword ExposureDuration in the cube&#39;s labels.
Definition: CissLabels.h:483
QString TargetName() const
Returns the TargetName label as a QString.
Definition: CissLabels.h:443
QString p_flightSoftwareVersion
Value of the PDS keyword FlightSoftwareVersion in the cube&#39;s labels.
Definition: CissLabels.h:489
Read values from Cassini ISS labels.
Definition: CissLabels.h:50
int p_summingMode
Value of the PDS keyword SummingMode in the cube&#39;s labels.
Definition: CissLabels.h:513
double FrontOpticsTemp() const
Returns the first element of OpticsTemperature from the Instrument group.
Definition: CissLabels.h:249
int p_gainModeId
Value of the PDS keyword GainModeId in the cube&#39;s labels.
Definition: CissLabels.h:493
double ImageNumber() const
Returns ImageNumber from the Archive group.
Definition: CissLabels.h:292
QString FlightSoftwareVersion() const
Returns FlightSoftwareVersion from the Instrument group.
Definition: CissLabels.h:234
bool p_cissNA
Indicates whether camera is narrow-angle.
Definition: CissLabels.h:473
double p_imageNumber
Value of the PDS keyword ImageNumber in the cube&#39;s labels.
Definition: CissLabels.h:497
double p_biasStripMean
Value of the PDS keyword BiasStripMean in the cube&#39;s labels.
Definition: CissLabels.h:471
QString p_instrumentId
Value of the PDS keyword InstrumentId in the cube&#39;s labels.
Definition: CissLabels.h:501
QString ReadoutCycleIndex() const
Returns ReadoutCycleIndex from the Instrument group.
Definition: CissLabels.h:355
QString p_delayedReadoutFlag
Value of the PDS keyword DelayedReadoutFlag in the cube&#39;s labels.
Definition: CissLabels.h:481
QString ImageTime() const
Returns the Time the photo was taken as a QString.
Definition: CissLabels.h:456
int GainState() const
Returns GainState from the Instrument group.
Definition: CissLabels.h:279
QString CompressionRatio() const
Returns CompressionRatio from the Instrument group.
Definition: CissLabels.h:114
QString DataConversionType() const
Returns DataConversionType from the Instrument group.
Definition: CissLabels.h:144
int SummingMode() const
Returns SummingMode from the Instrument group.
Definition: CissLabels.h:416
QString ShutterModeId() const
Returns ShutterModeId from the Instrument group.
Definition: CissLabels.h:387
bool NarrowAngle() const
Returns whether InstrumentId from the Instrument group is "ISSNA".
Definition: CissLabels.h:68
void ComputeImgProperties()
Computes values of non-keyword image properties.
Definition: CissLabels.cpp:99
Container for cube-like labels.
Definition: Pvl.h:135
QString p_compressionRatio
Value of the PDS keyword CompressionRatio in the cube&#39;s labels.
Definition: CissLabels.h:475
QString ShutterStateId() const
Returns ShutterStateId from the Instrument group.
Definition: CissLabels.h:400
QString p_ABflag
Value of the PDS keyword AntiBloomingFlag in the cube&#39;s labels.
Definition: CissLabels.h:467
QString p_dataConversionType
Value of the PDS keyword DataConversionType in the cube&#39;s labels.
Definition: CissLabels.h:479
bool AntibloomingOn() const
Returns whether AntiBloomingFlag from the Instrument group is "On".
Definition: CissLabels.h:430
double ExposureDuration() const
Returns ExposureDuration from the Instrument group.
Definition: CissLabels.h:172
QString p_shutterStateId
Value of the PDS keyword ShutterState in the cube&#39;s labels.
Definition: CissLabels.h:511
void Init(Pvl &lab)
General initializer.
Definition: CissLabels.cpp:37
std::vector< int > FilterIndex() const
Returns a two-element array of indices associated with optical filter names.
Definition: CissLabels.h:218
Namespace for ISIS/Bullet specific routines.
Definition: Apollo.h:31
std::vector< QString > p_filter
Two-element array of optical filters used for this image.
Definition: CissLabels.h:485
int p_readoutOrder
Value of the PDS keyword ReadoutOrder in the cube&#39;s labels.
Definition: CissLabels.h:507
QString p_readoutCycleIndex
Value of the PDS keyword ReadoutCycleIndex in the cube&#39;s labels.
Definition: CissLabels.h:505
double BiasStripMean() const
Returns BiasStripMean from the Intstrument group.
Definition: CissLabels.h:98
QString CompressionType() const
Returns CompressionType from the Instrument group.
Definition: CissLabels.h:129
int p_gainState
Value of the PDS keyword GainState in the cube&#39;s labels.
Definition: CissLabels.h:495
CissLabels(Pvl &lab)
Constructs a CissLabels object from an Isis::Pvl object.
Definition: CissLabels.cpp:16
double InstrumentDataRate() const
Returns InstrumentDataRate from the Instrument group.
Definition: CissLabels.h:307
QString p_imageTime
Value of the PDS Keyword ImageTime in the cube&#39;s labels.
Definition: CissLabels.h:517
QString DelayedReadoutFlag() const
Returns DelayedReadoutFlag from the Instrument group.
Definition: CissLabels.h:158