Isis Developer Reference
CissLabels.h
Go to the documentation of this file.
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
17namespace 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 {
222 return p_flightSoftwareVersion;
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;
456 bool p_antiblooming;
458 double p_biasStripMean;
460 bool p_cissNA;
462 QString p_compressionRatio;
464 QString p_compressionType;
466 QString p_dataConversionType;
468 QString p_delayedReadoutFlag;
470 double p_exposureDuration;
472 std::vector <QString> p_filter;
474 std::vector <int> p_filterIndex;
476 QString p_flightSoftwareVersion;
478 double p_frontOpticsTemp;
480 int p_gainModeId;
482 int p_gainState;
484 double p_imageNumber;
486 double p_instrumentDataRate;
488 QString p_instrumentId;
490 QString p_instrumentModeId;
492 QString p_readoutCycleIndex;
494 int p_readoutOrder;
496 QString p_shutterModeId;
498 QString p_shutterStateId;
500 int p_summingMode;
502 QString p_targetName;
504 QString p_imageTime;
505 };
506};
507
508#endif
Read values from Cassini ISS labels.
Definition CissLabels.h:37
QString CompressionType() const
Returns CompressionType from the Instrument group.
Definition CissLabels.h:116
bool WideAngle() const
Returns whether InstrumentId from the Instrument group is "ISSWA".
Definition CissLabels.h:70
~CissLabels()
Destroys the CissLabels object.
Definition CissLabels.h:42
bool AntibloomingOn() const
Returns whether AntiBloomingFlag from the Instrument group is "On".
Definition CissLabels.h:417
QString ReadoutCycleIndex() const
Returns ReadoutCycleIndex from the Instrument group.
Definition CissLabels.h:342
QString FlightSoftwareVersion() const
Returns FlightSoftwareVersion from the Instrument group.
Definition CissLabels.h:221
QString ImageTime() const
Returns the Time the photo was taken as a QString.
Definition CissLabels.h:443
QString TargetName() const
Returns the TargetName label as a QString.
Definition CissLabels.h:430
QString InstrumentModeId()
Returns the lower case form of InstrumentModeId from the Instrument group.
Definition CissLabels.h:326
double BiasStripMean() const
Returns BiasStripMean from the Intstrument group.
Definition CissLabels.h:85
int GainState() const
Returns GainState from the Instrument group.
Definition CissLabels.h:266
QString DataConversionType() const
Returns DataConversionType from the Instrument group.
Definition CissLabels.h:131
double FrontOpticsTemp() const
Returns the first element of OpticsTemperature from the Instrument group.
Definition CissLabels.h:236
double ImageNumber() const
Returns ImageNumber from the Archive group.
Definition CissLabels.h:279
QString ShutterModeId() const
Returns ShutterModeId from the Instrument group.
Definition CissLabels.h:374
bool NarrowAngle() const
Returns whether InstrumentId from the Instrument group is "ISSNA".
Definition CissLabels.h:55
int ReadoutOrder() const
Returns ReadoutOrder from the Instrument group.
Definition CissLabels.h:359
QString CompressionRatio() const
Returns CompressionRatio from the Instrument group.
Definition CissLabels.h:101
std::vector< int > FilterIndex() const
Returns a two-element array of indices associated with optical filter names.
Definition CissLabels.h:205
std::vector< QString > FilterName() const
Returns a two-element array of the optical filters found in the BandBin group.
Definition CissLabels.h:190
double ExposureDuration() const
Returns ExposureDuration from the Instrument group.
Definition CissLabels.h:159
double InstrumentDataRate() const
Returns InstrumentDataRate from the Instrument group.
Definition CissLabels.h:294
int GainModeId() const
Returns GainModeId from the Instrument group.
Definition CissLabels.h:251
QString ShutterStateId() const
Returns ShutterStateId from the Instrument group.
Definition CissLabels.h:387
CissLabels(Pvl &lab)
Constructs a CissLabels object from an Isis::Pvl object.
Definition CissLabels.cpp:24
QString DelayedReadoutFlag() const
Returns DelayedReadoutFlag from the Instrument group.
Definition CissLabels.h:145
int SummingMode() const
Returns SummingMode from the Instrument group.
Definition CissLabels.h:403
QString InstrumentId() const
Returns InstrumentId from the Instrument group.
Definition CissLabels.h:308
Container for cube-like labels.
Definition Pvl.h:119
This is free and unencumbered software released into the public domain.
Definition Apollo.h:16