USGS

Isis 3.0 Application Source Code Reference

Home

ZeroReverse Class Reference

Processes Reverse Clock calibration data (ZeroReverse Module) More...

#include <ZeroReverse.h>

Public Member Functions

 ZeroReverse ()
 
 ZeroReverse (HiCalData &cal, const HiCalConf &conf)
 
virtual ~ZeroReverse ()
 Destructor. More...
 
const Statistics & Stats () const
 Return statistics for raw Reverse Clock buffer. More...
 
bool wasTriggered () const
 Specifies if the input trigger conditions were met. More...
 
 ZeroReverse ()
 
 ZeroReverse (HiCalData &cal, const HiCalConf &conf)
 
virtual ~ZeroReverse ()
 Destructor. More...
 
const Statistics & Stats () const
 Return statistics for raw Reverse Clock buffer. More...
 
bool wasTriggered () const
 Specifies if the input trigger conditions were met. More...
 
- Public Member Functions inherited from Module
 Module ()
 
 Module (const QString &name)
 
 Module (const QString &name, const HiHistory &history)
 
 Module (const QString &name, const Module &c)
 
 Module (const Module &c)
 
virtual ~Module ()
 Destructor. More...
 
QString name () const
 Returns name of component. More...
 
QString getcsvFile () const
 Returns expanded name of last CSV file loaded by loadCsv. More...
 
int size () const
 Returns the size (number of elements) of data array. More...
 
virtual void Process (const Module &c)
 Invokes the process method on the Module vector. More...
 
virtual void Process (const HiVector &v)
 Default processing behavior makes a reference copy of data array. More...
 
HiVector loadCsv (const QString &csvBase, const HiCalConf &conf, const DbProfile &prof, const int &elements=0)
 Provide generic loading of CSV file for all modules. More...
 
const HiVectorref () const
 Return data via a const reference. More...
 
double operator() (int index) const
 Return individual element of the data vector. More...
 
const HiHistoryHistory () const
 Return recorded history of events. More...
 
virtual void record (PvlGroup &pvl, const QString keyname="ModuleHistory") const
 Record history in Pvl group object. More...
 
void Dump (const QString &fname) const
 Dumps the component to a specified file. More...
 
 Module ()
 
 Module (const QString &name)
 
 Module (const QString &name, const HiHistory &history)
 
 Module (const QString &name, const Module &c)
 
 Module (const Module &c)
 
virtual ~Module ()
 Destructor. More...
 
QString name () const
 Returns name of component. More...
 
QString getcsvFile () const
 Returns expanded name of last CSV file loaded by loadCsv. More...
 
int size () const
 Returns the size (number of elements) of data array. More...
 
virtual void Process (const Module &c)
 Invokes the process method on the Module vector. More...
 
virtual void Process (const HiVector &v)
 Default processing behavior makes a reference copy of data array. More...
 
HiVector loadCsv (const QString &csvBase, const HiCalConf &conf, const DbProfile &prof, const int &elements=0)
 Provide generic loading of CSV file for all modules. More...
 
const HiVectorref () const
 Return data via a const reference. More...
 
double operator() (int index) const
 Return individual element of the data vector. More...
 
const HiHistoryHistory () const
 Return recorded history of events. More...
 
virtual void record (PvlGroup &pvl, const QString keyname="ModuleHistory") const
 Record history in Pvl group object. More...
 
void Dump (const QString &fname) const
 Dumps the component to a specified file. More...
 

Additional Inherited Members

- Protected Types inherited from Module
enum  { DefaultWidth = 10, DefaultPrecision = 6 }
 
enum  { DefaultWidth = 10, DefaultPrecision = 6 }
 
- Protected Member Functions inherited from Module
QString formatDbl (const double &value) const
 Properly format values that could be special pixels. More...
 
QString formatDbl (const double &value) const
 Properly format values that could be special pixels. More...
 
- Protected Attributes inherited from Module
QString _name
 Name of component. More...
 
QString _csvFile
 Fully expanded name of CSV file if present. More...
 
HiVector _data
 Data vector. More...
 
HiHistory _history
 Hierarchial component history. More...
 
int _fmtWidth
 Default field with of double. More...
 
int _fmtPrecision
 Default field with of double. More...
 

Detailed Description

Processes Reverse Clock calibration data (ZeroReverse Module)

This class loads and processes the Reverse Clock data from a HiRISE image for offset correction purposes. Additional processing may occur in subsequent modules.

Author
2008-06-13 Kris Becker

Definition at line 60 of file ZeroReverse.h.

Constructor & Destructor Documentation

ZeroReverse ( )
inline

Definition at line 64 of file ZeroReverse.h.

ZeroReverse ( HiCalData cal,
const HiCalConf &  conf 
)
inline

Definition at line 65 of file ZeroReverse.h.

virtual ~ZeroReverse ( )
inlinevirtual

Destructor.

Definition at line 71 of file ZeroReverse.h.

ZeroReverse ( )
inline

Definition at line 64 of file ZeroReverse.h.

ZeroReverse ( HiCalData cal,
const HiCalConf &  conf 
)
inline

Definition at line 65 of file ZeroReverse.h.

virtual ~ZeroReverse ( )
inlinevirtual

Destructor.

Definition at line 71 of file ZeroReverse.h.

Member Function Documentation

const Statistics& Stats ( ) const
inline

Return statistics for raw Reverse Clock buffer.

Returns
const Statistics& Statistics class with all stats

Definition at line 78 of file ZeroReverse.h.

bool wasTriggered ( ) const
inline

Specifies if the input trigger conditions were met.

If trigger conditions where met, the reverse clock correction becomes a constant as opposed to processed reverse clock pixels.

Returns
bool True if triggered, false otherwise

Definition at line 88 of file ZeroReverse.h.

const Statistics& Stats ( ) const
inline

Return statistics for raw Reverse Clock buffer.

Returns
const Statistics& Statistics class with all stats

Definition at line 78 of file ZeroReverse.h.

bool wasTriggered ( ) const
inline

Specifies if the input trigger conditions were met.

If trigger conditions where met, the reverse clock correction becomes a constant as opposed to processed reverse clock pixels.

Returns
bool True if triggered, false otherwise

Definition at line 88 of file ZeroReverse.h.


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