Isis Developer Reference
|
Module manages HiRISE calibration vectors from various sources. More...
#include <Module.h>
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 HiVector & | ref () const |
Return data via a const reference. | |
double | operator() (int index) const |
Return individual element of the data vector. | |
const HiHistory & | History () 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) |
Module manages HiRISE calibration vectors from various sources.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inlinevirtual |
Destructor.
|
inline |
Dumps the component to a specified file.
fname | Name of file to dump contents to |
References _FILEINFO_, and Isis::IException::User.
|
inlineprotected |
Properly format values that could be special pixels.
This method applies ISIS special pixel value conventions to properly print pixel values.
[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 |
References _fmtPrecision, _fmtWidth, Isis::IsSpecial(), and Isis::PixelToString().
Referenced by printOn().
|
inline |
Returns expanded name of last CSV file loaded by loadCsv.
References _csvFile.
|
inline |
Return recorded history of events.
References _history.
|
inline |
Provide generic loading of CSV file for all modules.
This method provides generalized access to CSV files through the standardized format.
cvsBase | Name of base keyword for CSV file |
conf | Configuration parameters |
prof | Module profile parameters |
samples | Number of expect elements to be read from CSV file |
|
inline |
Returns name of component.
References _name.
|
inline |
Return individual element of the data vector.
References _data.
|
inlineprotectedvirtual |
Default printing of data in module.
References _data, _history, and formatDbl().
|
inlinevirtual |
Default processing behavior makes a reference copy of data array.
Reimplemented in Isis::LowPassFilter, and Isis::SplineFill.
References _data.
|
inlinevirtual |
|
inlinevirtual |
Record history in Pvl group object.
References _history, and Isis::HiHistory::makekey().
|
inline |
Return data via a const reference.
References _data.
|
inline |
Returns the size (number of elements) of data array.
References _data.
|
friend |
|
protected |
Fully expanded name of CSV file if present.
Referenced by getcsvFile(), and loadCsv().
|
protected |
Data vector.
Referenced by Isis::LowPassFilter::LowPassFilter(), Isis::LowPassFilter::LowPassFilter(), operator()(), printOn(), Isis::LowPassFilter::Process(), Process(), ref(), and size().
|
protected |
Default field with of double.
Referenced by formatDbl().
|
protected |
Default field with of double.
Referenced by formatDbl().
|
protected |
Hierarchial component history.
Referenced by Isis::ZeroBufferFit::guess(), History(), loadCsv(), Isis::LowPassFilter::LowPassFilter(), Isis::LowPassFilter::LowPassFilter(), Isis::ZeroBufferFit::Normalize(), printOn(), Isis::LowPassFilter::Process(), Isis::SplineFill::Process(), record(), Isis::ZeroBufferFit::Solve(), Isis::SplineFill::SplineFill(), Isis::SplineFill::SplineFill(), Isis::SplineFill::SplineFill(), and Isis::ZeroBufferFit::ZeroBufferFit().
|
protected |
Name of component.
Referenced by name().