Isis Developer Reference
Isis::Module Class Reference

Module manages HiRISE calibration vectors from various sources. More...

#include <Module.h>

Inheritance diagram for Isis::Module:
Inheritance graph
Collaboration diagram for Isis::Module:
Collaboration graph

Public Member Functions

 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.
 
QString name () const
 Returns name of component.
 
QString getcsvFile () const
 Returns expanded name of last CSV file loaded by loadCsv.
 
int size () const
 Returns the size (number of elements) of data array.
 
virtual void Process (const Module &c)
 Invokes the process method on the Module vector.
 
virtual void Process (const HiVector &v)
 Default processing behavior makes a reference copy of data array.
 
HiVector loadCsv (const QString &csvBase, const HiCalConf &conf, const DbProfile &prof, const int &elements=0)
 Provide generic loading of CSV file for all modules.
 
const HiVectorref () const
 Return data via a const reference.
 
double operator() (int index) const
 Return individual element of the data vector.
 
const HiHistoryHistory () const
 Return recorded history of events.
 
virtual void record (PvlGroup &pvl, const QString keyname="ModuleHistory") const
 Record history in Pvl group object.
 
void Dump (const QString &fname) const
 Dumps the component to a specified file.
 

Protected Types

enum  { DefaultWidth = 10 , DefaultPrecision = 6 }
 

Protected Member Functions

QString formatDbl (const double &value) const
 Properly format values that could be special pixels.
 
virtual void printOn (std::ostream &o) const
 Default printing of data in module.
 

Protected Attributes

QString _name
 Name of component.
 
QString _csvFile
 Fully expanded name of CSV file if present.
 
HiVector _data
 Data vector.
 
HiHistory _history
 Hierarchial component history.
 
int _fmtWidth
 Default field with of double.
 
int _fmtPrecision
 Default field with of double.
 

Friends

std::ostream & operator<< (std::ostream &o, const Module &c)
 

Detailed Description

Module manages HiRISE calibration vectors from various sources.

Author
2007-10-05 Kris Becker

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
DefaultWidth 
DefaultPrecision 

Constructor & Destructor Documentation

◆ Module() [1/5]

Isis::Module::Module ( )
inline

◆ Module() [2/5]

Isis::Module::Module ( const QString & name)
inline

◆ Module() [3/5]

Isis::Module::Module ( const QString & name,
const HiHistory & history )
inline

◆ Module() [4/5]

Isis::Module::Module ( const QString & name,
const Module & c )
inline

◆ Module() [5/5]

Isis::Module::Module ( const Module & c)
inline

◆ ~Module()

virtual Isis::Module::~Module ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Dump()

void Isis::Module::Dump ( const QString & fname) const
inline

Dumps the component to a specified file.

Parameters
fnameName of file to dump contents to

References _FILEINFO_, and Isis::IException::User.

◆ formatDbl()

QString Isis::Module::formatDbl ( const double & value) const
inlineprotected

Properly format values that could be special pixels.

This method applies ISIS special pixel value conventions to properly print pixel values.

Parameters
[in](double)value Input value to test for specialness and print as requested by caller
[in](int)width Width of field in which to print the value
[in](int)prec Precision used to format the value
Returns
(string) Formatted double value

References _fmtPrecision, _fmtWidth, Isis::IsSpecial(), and Isis::PixelToString().

Referenced by printOn().

◆ getcsvFile()

QString Isis::Module::getcsvFile ( ) const
inline

Returns expanded name of last CSV file loaded by loadCsv.

References _csvFile.

◆ History()

const HiHistory & Isis::Module::History ( ) const
inline

Return recorded history of events.

References _history.

◆ loadCsv()

HiVector Isis::Module::loadCsv ( const QString & csvBase,
const HiCalConf & conf,
const DbProfile & prof,
const int & elements = 0 )
inline

Provide generic loading of CSV file for all modules.

This method provides generalized access to CSV files through the standardized format.

Author
Kris Becker - 4/16/2010
Parameters
cvsBaseName of base keyword for CSV file
confConfiguration parameters
profModule profile parameters
samplesNumber of expect elements to be read from CSV file
Returns
HiVector

References _csvFile, and _history.

◆ name()

QString Isis::Module::name ( ) const
inline

Returns name of component.

References _name.

◆ operator()()

double Isis::Module::operator() ( int index) const
inline

Return individual element of the data vector.

References _data.

◆ printOn()

virtual void Isis::Module::printOn ( std::ostream & o) const
inlineprotectedvirtual

Default printing of data in module.

References _data, _history, and formatDbl().

◆ Process() [1/2]

virtual void Isis::Module::Process ( const HiVector & v)
inlinevirtual

Default processing behavior makes a reference copy of data array.

Reimplemented in Isis::LowPassFilter, and Isis::SplineFill.

References _data.

◆ Process() [2/2]

virtual void Isis::Module::Process ( const Module & c)
inlinevirtual

Invokes the process method on the Module vector.

References Process().

Referenced by Process().

◆ record()

virtual void Isis::Module::record ( PvlGroup & pvl,
const QString keyname = "ModuleHistory" ) const
inlinevirtual

Record history in Pvl group object.

References _history, and Isis::HiHistory::makekey().

◆ ref()

const HiVector & Isis::Module::ref ( ) const
inline

Return data via a const reference.

References _data.

◆ size()

int Isis::Module::size ( ) const
inline

Returns the size (number of elements) of data array.

References _data.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & o,
const Module & c )
friend

Member Data Documentation

◆ _csvFile

QString Isis::Module::_csvFile
protected

Fully expanded name of CSV file if present.

Referenced by getcsvFile(), and loadCsv().

◆ _data

◆ _fmtPrecision

int Isis::Module::_fmtPrecision
protected

Default field with of double.

Referenced by formatDbl().

◆ _fmtWidth

int Isis::Module::_fmtWidth
protected

Default field with of double.

Referenced by formatDbl().

◆ _history

◆ _name

QString Isis::Module::_name
protected

Name of component.

Referenced by name().


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