Isis 3 Programmer Reference
OverlapNormalization.h
Go to the documentation of this file.
1 #ifndef OverlapNormalization_h
2 #define OverlapNormalization_h
3 
25 #include "Statistics.h"
26 #include "LeastSquares.h"
27 
28 namespace Isis {
29  class BasisFunction;
30 
78  public:
79 
80  OverlapNormalization(std::vector<Statistics *> statsList);
81 
82  virtual ~OverlapNormalization();
83 
91  enum AddStatus {
92 
97 
102 
107  };
108 
109  AddStatus AddOverlap(const Statistics &area1, const unsigned index1,
110  const Statistics &area2, const unsigned index2,
111  double weight = 1.0);
112 
119  inline void AddHold(unsigned holdIndex) {
120  m_idHoldList.push_back(holdIndex);
121  };
122 
128 
133 
138 
143 
152  };
153 
154  void Solve(SolutionType type = Both,
156 
157  double Average(const unsigned index) const;
158  double Gain(const unsigned index) const;
159  double Offset(const unsigned index) const;
160 
161  double Evaluate(double dn, unsigned index) const;
162 
163  private:
164 
168  std::vector<Statistics *> m_statsList;
169 
174  std::vector<int> m_idHoldList;
175 
185  class Overlap {
186  public:
187 
192 
197 
202  int index1;
203 
208  int index2;
209  };
210 
214  std::vector<Overlap> m_overlapList;
215 
220  std::vector<double> m_deltas;
221 
225  std::vector<double> m_weights;
226 
227 
231  bool m_solved;
232 
238 
242  std::vector<double> m_gains;
243 
247  std::vector<double> m_offsets;
248 
249 
254 
259 
264 
269 
272 
275  };
276 };
277 
278 #endif
int index2
Index corresponding to m_statsList for the second overlapping data set.
AddStatus AddOverlap(const Statistics &area1, const unsigned index1, const Statistics &area2, const unsigned index2, double weight=1.0)
Attempts to add the given overlap data to a collection of valid overlaps, and returns the success or ...
void Solve(SolutionType type=Both, LeastSquares::SolveMethod method=LeastSquares::QRD)
Attempts to solve the least squares equation for all data sets.
QR Decomposition.
Definition: LeastSquares.h:129
std::vector< double > m_offsets
Vector of calculated offsets filled by the Solve method.
Store statistics pertaining to the overlapping areas and indices (corresponding to the statistics lis...
double Average(const unsigned index) const
Returns the calculated average DN value for the given data set.
double Evaluate(double dn, unsigned index) const
Returns a new DN from an old using the calculated gains and offsets of the data set the pixel belongs...
Statistics area2
Overlapping area for the second data set.
std::vector< Overlap > m_overlapList
Vector of valid overlaps collected.
SolutionType
Enumeration for whether user/programmer wants to calculate new gains, offsets, or both when solving...
LeastSquares * m_gainLsq
The least squares object that solves for the new gains.
One or both areas contain no valid average.
void AddHold(unsigned holdIndex)
Sets the list of files to be held during the solving process.
BasisFunction * m_gainFunction
The gain function to be solved.
OverlapNormalization(std::vector< Statistics *> statsList)
Constructs an OverlapNormalization object.
This class is used to accumulate statistics on double arrays.
Definition: Statistics.h:107
Calculate the bases and multipliers for normalizing overlapping "data sets" (e.g., cubes).
int index1
Index corresponding to m_statsList for the first overlapping data set.
std::vector< int > m_idHoldList
Vector of indices corresponding to the m_statsList vector representing data sets to be held in soluti...
virtual ~OverlapNormalization()
Destroys the OverlapNormalization object, frees up pointers.
OverlapNormalization & operator=(const OverlapNormalization &)
Cannot copy this object.
Overlap is valid and was added successfully.
Generic least square fitting class.
Definition: LeastSquares.h:115
AddStatus
The result of the attempt to add overlap data to the list of valid overlaps, where Success is a succe...
The equation being solved for Gains, Offsets, and Both is output = (input - average) * gain + offset ...
SolutionType m_solutionType
Whether the user of this class wants to solve for the offsets, the gains, or both.
bool m_solved
Whether or not the least squares solution has been solved.
double Gain(const unsigned index) const
Returns the calculated gain (multiplier) for the given data set.
BasisFunction * m_offsetFunction
The offset function to be solved.
Calculate both gains and offsets.
Generic linear equation class.
Definition: BasisFunction.h:64
std::vector< double > m_gains
Vector of calculated gains filled by the Solve method.
Statistics area1
Overlapping area for the first data set.
std::vector< double > m_weights
Vector of weights for every valid overlap.
Namespace for ISIS/Bullet specific routines.
Definition: Apollo.h:31
Data sets do not overlap one another.
double Offset(const unsigned index) const
Returns the calculated offset (base) for the given data set.
LeastSquares * m_offsetLsq
The least squares object that calculates offsets.
std::vector< Statistics * > m_statsList
Vector of Statistics objects for each data set.
std::vector< double > m_deltas
Vector of delta values (differences between the averages of two overlapping data sets) for every vali...