|
Isis 3.0 Application Source Code Reference |
Home |
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. | |
| 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 } |
| 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. | |
| 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) |
| std::ostream & | operator<< (std::ostream &o, const Module &c) |
Module manages HiRISE calibration vectors from various sources.
Definition at line 54 of file Module.h.
anonymous enum [protected] |
anonymous enum [protected] |
| QString getcsvFile | ( | ) | const [inline] |
| int size | ( | ) | const [inline] |
Returns the size (number of elements) of data array.
Reimplemented in ZeroBufferFit, and ZeroBufferFit.
| virtual void Process | ( | const Module & | c | ) | [inline, virtual] |
| virtual void Process | ( | const HiVector & | v | ) | [inline, virtual] |
Default processing behavior makes a reference copy of data array.
Reimplemented in LowPassFilter, SplineFill, LowPassFilter, and SplineFill.
| HiVector 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.
| 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 |
| const HiVector& ref | ( | ) | const [inline] |
| double operator() | ( | int | index | ) | const [inline] |
| const HiHistory& History | ( | ) | const [inline] |
| virtual void record | ( | PvlGroup & | pvl, | |
| const QString | keyname = "ModuleHistory" | |||
| ) | const [inline, virtual] |
| void Dump | ( | const QString & | fname | ) | const [inline] |
| QString formatDbl | ( | const double & | value | ) | const [inline, protected] |
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 |
| virtual void printOn | ( | std::ostream & | o | ) | const [inline, protected, virtual] |
| QString getcsvFile | ( | ) | const [inline] |
| int size | ( | ) | const [inline] |
Returns the size (number of elements) of data array.
Reimplemented in ZeroBufferFit, and ZeroBufferFit.
| virtual void Process | ( | const Module & | c | ) | [inline, virtual] |
| virtual void Process | ( | const HiVector & | v | ) | [inline, virtual] |
Default processing behavior makes a reference copy of data array.
Reimplemented in LowPassFilter, SplineFill, LowPassFilter, and SplineFill.
| HiVector 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.
| 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 |
| const HiVector& ref | ( | ) | const [inline] |
| double operator() | ( | int | index | ) | const [inline] |
| const HiHistory& History | ( | ) | const [inline] |
| virtual void record | ( | PvlGroup & | pvl, | |
| const QString | keyname = "ModuleHistory" | |||
| ) | const [inline, virtual] |
| void Dump | ( | const QString & | fname | ) | const [inline] |
| QString formatDbl | ( | const double & | value | ) | const [inline, protected] |
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 |
| virtual void printOn | ( | std::ostream & | o | ) | const [inline, protected, virtual] |
| std::ostream& operator<< | ( | std::ostream & | o, | |
| const Module & | c | |||
| ) | [friend] |
| std::ostream& operator<< | ( | std::ostream & | o, | |
| const Module & | c | |||
| ) | [friend] |
QString _csvFile [protected] |
int _fmtPrecision [protected] |