Isis Developer Reference
Module.h
Go to the documentation of this file.
1#ifndef Module_h
2#define Module_h
3
10/* SPDX-License-Identifier: CC0-1.0 */
11
12#include <iostream>
13#include <sstream>
14#include <string>
15#include <vector>
16#include <algorithm>
17
18#include "HiCalTypes.h"
19#include "HiCalUtil.h"
20#include "HiCalConf.h"
21#include "LoadCSV.h"
22#include "PvlKeyword.h"
23#include "PvlGroup.h"
24#include "IException.h"
25
26namespace Isis {
27
28 class PvlGroup;
29
39 class Module {
40 public:
41 friend std::ostream &operator<<(std::ostream &o, const Module &c) {
42 c.printOn(o);
43 return (o);
44 }
45
46 public:
47 // Constructors and Destructor
53 Module(const QString &name, const HiHistory &history) :
54 _name(name), _csvFile(""), _data(), _history(history),
63
64
66 virtual ~Module() { }
67
69 inline QString name() const { return (_name); }
71 inline QString getcsvFile() const { return (_csvFile); }
73 inline int size() const { return (_data.dim()); }
74
76 virtual void Process(const Module &c) {
77 Process(c.ref());
78 }
79
81 virtual void Process(const HiVector &v) {
82 _data = v;
83 return;
84 }
85
101 HiVector loadCsv(const QString &csvBase, const HiCalConf &conf,
102 const DbProfile &prof, const int &elements = 0) {
103 LoadCSV csv(csvBase, conf, prof);
104 _csvFile = csv.filename();
105 if (elements != 0) csv.validateSize(elements, true);
106 csv.History(_history);
107 return (csv.getVector());
108 }
109
111 const HiVector &ref() const { return (_data); }
113 inline double operator()(int index) const { return (_data[index]);}
114
116 const HiHistory &History() const { return (_history); }
117
119 virtual void record(PvlGroup &pvl,
120 const QString keyname = "ModuleHistory")
121 const {
122 pvl += _history.makekey(keyname);
123 return;
124 }
125
131 void Dump(const QString &fname) const {
132 FileName dumpc(fname);
133 QString dumpcFile = dumpc.expanded();
134 std::ofstream ofile(dumpcFile.toLatin1().data(), std::ios::out);
135 if (!ofile) {
136 QString mess = "Unable to open/create module dump file " +
137 dumpc.expanded();
139 }
140 ofile << *this;
141 ofile.close();
142 return;
143 }
144
145
146 protected:
148
149 QString _name;
150 QString _csvFile;
155
156
169 inline QString formatDbl(const double &value) const {
170 std::ostringstream ostr;
171 if (IsSpecial(value)) {
172 ostr << std::setw(_fmtWidth) << PixelToString(value);
173 return (QString(ostr.str().c_str()));
174 }
175 else {
176 // Its not special so format to callers specs
177 ostr << std::setw(_fmtWidth) << std::setprecision(_fmtPrecision) << value;
178 return (QString(ostr.str().c_str()));
179 }
180 }
181
183 virtual void printOn(std::ostream &o) const {
184 o << "# History = " << _history << std::endl;
185 o << "# Count = " << _data.dim() << std::endl;
186 for (int i = 0 ; i < _data.dim() ; i++) {
187 o << formatDbl(_data[i]) << std::endl;
188 }
189 return;
190 }
191
192 };
193
194} // namespace Isis
195#endif
#define _FILEINFO_
Macro for the filename and line number.
Definition IException.h:24
A DbProfile is a container for access parameters to a database.
Definition DbProfile.h:51
File name manipulation and expansion.
Definition FileName.h:100
Definition HiCalTypes.h:30
PvlKeyword makekey(const QString &name="History") const
Definition HiCalTypes.h:67
Isis exception class.
Definition IException.h:91
@ User
A type of error that could only have occurred due to a mistake on the user's part (e....
Definition IException.h:126
Provides generalized access to HiRISE calibration CSV files.
Definition LoadCSV.h:52
Module manages HiRISE calibration vectors from various sources.
Definition Module.h:39
HiVector _data
Data vector.
Definition Module.h:151
Module(const QString &name, const Module &c)
Definition Module.h:56
double operator()(int index) const
Return individual element of the data vector.
Definition Module.h:113
int _fmtPrecision
Default field with of double.
Definition Module.h:154
QString getcsvFile() const
Returns expanded name of last CSV file loaded by loadCsv.
Definition Module.h:71
HiHistory _history
Hierarchial component history.
Definition Module.h:152
virtual void Process(const HiVector &v)
Default processing behavior makes a reference copy of data array.
Definition Module.h:81
Module(const QString &name)
Definition Module.h:50
int size() const
Returns the size (number of elements) of data array.
Definition Module.h:73
QString _csvFile
Fully expanded name of CSV file if present.
Definition Module.h:150
virtual ~Module()
Destructor.
Definition Module.h:66
QString _name
Name of component.
Definition Module.h:149
Module(const Module &c)
Definition Module.h:59
virtual void printOn(std::ostream &o) const
Default printing of data in module.
Definition Module.h:183
const HiVector & ref() const
Return data via a const reference.
Definition Module.h:111
Module(const QString &name, const HiHistory &history)
Definition Module.h:53
QString name() const
Returns name of component.
Definition Module.h:69
@ DefaultWidth
Definition Module.h:147
@ DefaultPrecision
Definition Module.h:147
int _fmtWidth
Default field with of double.
Definition Module.h:153
virtual void record(PvlGroup &pvl, const QString keyname="ModuleHistory") const
Record history in Pvl group object.
Definition Module.h:119
void Dump(const QString &fname) const
Dumps the component to a specified file.
Definition Module.h:131
virtual void Process(const Module &c)
Invokes the process method on the Module vector.
Definition Module.h:76
const HiHistory & History() const
Return recorded history of events.
Definition Module.h:116
Module()
Definition Module.h:48
HiVector loadCsv(const QString &csvBase, const HiCalConf &conf, const DbProfile &prof, const int &elements=0)
Provide generic loading of CSV file for all modules.
Definition Module.h:101
friend std::ostream & operator<<(std::ostream &o, const Module &c)
Definition Module.h:41
QString formatDbl(const double &value) const
Properly format values that could be special pixels.
Definition Module.h:169
Contains multiple PvlContainers.
Definition PvlGroup.h:41
This is free and unencumbered software released into the public domain.
Definition Apollo.h:16
bool IsSpecial(const double d)
Returns if the input pixel is special.
Definition SpecialPixel.h:197
TNT::Array1D< double > HiVector
1-D Buffer
Definition HiCalTypes.h:27
QString PixelToString(double d, double precision=8)
Takes a double pixel value and returns the name of the pixel type as a string.
Definition SpecialPixel.h:371