Isis 3 Programmer Reference
BundleTargetBody.h
Go to the documentation of this file.
1 #ifndef BundleTargetBody_h
2 #define BundleTargetBody_h
3 
25 #include <set>
26 
27 #include <QSharedPointer>
28 #include <QStringList>
29 
30 #include <boost/numeric/ublas/vector.hpp>
31 
32 #include "Angle.h"
33 #include "Distance.h"
34 #include "Latitude.h"
35 #include "LinearAlgebra.h"
36 #include "Longitude.h"
37 
38 namespace Isis {
39 
40  class BundleSettings;
41  class PvlObject;
42  class Target;
43 
66 
67  public:
68  // constructors
69  BundleTargetBody(); // default
70  BundleTargetBody(Target *target);
71  BundleTargetBody(const BundleTargetBody &src); // copy
72  virtual ~BundleTargetBody();
73 
75 
78  None = 0,
79  Mean = 1,
80  All = 2
81  };
82 
84  enum TargetSolveCodes { PoleRA = 0,
85  VelocityPoleRA = 1,
86  AccelerationPoleRA = 2,
87  PoleDec = 3,
88  VelocityPoleDec = 4,
89  AccelerationPoleDec = 5,
90  PM = 6,
91  VelocityPM = 7,
92  AccelerationPM = 8,
93  TriaxialRadiusA = 9,
94  TriaxialRadiusB = 10,
95  TriaxialRadiusC = 11,
96  MeanRadius = 12
97  };
98 
99  void setSolveSettings(std::set<int> targetParameterSolveCodes,
100  Angle aprioriPoleRA, Angle sigmaPoleRA, Angle aprioriVelocityPoleRA,
101  Angle sigmaVelocityPoleRA, Angle aprioriPoleDec, Angle sigmaPoleDec,
102  Angle aprioriVelocityPoleDec, Angle sigmaVelocityPoleDec,
103  Angle aprioriPM, Angle sigmaPM, Angle aprioriVelocityPM,
104  Angle sigmaVelocityPM, TargetRadiiSolveMethod solveRadiiMethod,
105  Distance aprioriRadiusA, Distance sigmaRadiusA, Distance aprioriRadiusB,
106  Distance sigmaRadiusB, Distance aprioriRadiusC, Distance sigmaRadiusC,
107  Distance aprioriMeanRadius, Distance sigmaMeanRadius);
108 
109  static TargetRadiiSolveMethod stringToTargetRadiiOption(QString option);
110  static QString targetRadiiOptionToString(TargetRadiiSolveMethod targetRadiiSolveMethod);
111 
112  bool readFromPvl(PvlObject &tbPvlObject);
113 
114  // mutators
115  //
116 
117  // accessors
123 
124  std::vector<Angle> poleRaCoefs();
125  std::vector<Angle> poleDecCoefs();
126  std::vector<Angle> pmCoefs();
127 
128  std::vector<Distance> radii();
130 
131  // string format methods
132  QString formatBundleOutputString(bool errorPropagation);
134  // TODO implement
135  QString formatValue(double value, int fieldWidth, int precision) const;
136  QString formatAprioriSigmaString(int type, int fieldWidth, int precision) const;
137  QString formatPolePositionAprioriSigmaString(int fieldWidth, int precision) const;
138  QString formatW0AprioriSigmaString(int fieldWidth, int precision) const;
139  QString formatWDotAprioriSigmaString(int fieldWidth, int precision) const;
140  QString formatRadiusAprioriSigmaString(int fieldWidth, int precision) const;
141  QString formatPolePositionAdjustedSigmaString(int fieldWidth, int precision) const;
142  QString formatW0AdjustedSigmaString(int fieldWidth, int precision) const;
143  QString formatWDotAdjustedSigmaString(int fieldWidth, int precision) const;
144  QString formatRadiusAdjustedSigmaString(int fieldWidth, int precision) const;
145 
146  virtual bool solvePoleRA();
147  virtual bool solvePoleRAVelocity();
148  virtual bool solvePoleRAAcceleration();
149  virtual bool solvePoleDec();
150  virtual bool solvePoleDecVelocity();
151  virtual bool solvePoleDecAcceleration();
152  virtual bool solvePM();
153  virtual bool solvePMVelocity();
154  virtual bool solvePMAcceleration();
155  virtual bool solveTriaxialRadii();
156  virtual bool solveMeanRadius();
157 
158 // int numberPoleParameters();
159 // int numberW0Parameters();
160 // int numberWDotParameters();
162  virtual int numberParameters();
163 
165 
166  double vtpv();
167 
168  Distance localRadius(const Latitude &lat, const Longitude &lon);
169 
170  private:
180 
181  std::vector<Distance> m_radii;
183 
184  std::vector<Angle> m_raPole;
185  std::vector<Angle> m_decPole;
186  std::vector<Angle> m_pm ;
187 
188  std::set<int> m_parameterSolveCodes;
191 
197  };
198 
201 }
202 
203 #endif // BundleTargetBody_h
This class is used to represent a target body in a bundle and how to solve for it.
virtual bool solvePoleRAVelocity()
If the pole right ascension velocity will be solved for with this target body.
LinearAlgebra::Vector & aprioriSigmas()
Returns the vector of apriori parameters sigmas.
Distance m_aprioriRadiusC
Apriori Radius C.
Distance m_sigmaRadiusA
Apriori Radius A Sigma.
std::vector< Angle > m_decPole
pole dec quadratic polynomial coefficients
static QString targetRadiiOptionToString(TargetRadiiSolveMethod targetRadiiSolveMethod)
Converts a TargetRadiiSolveMethod to a QString.
Distance m_sigmaRadiusB
Apriori Radius B Sigma.
TargetSolveCodes
Enumeration that defines what BundleTargetBody can solve for.
Distance m_aprioriRadiusB
Apriori Radius B.
Distance localRadius(const Latitude &lat, const Longitude &lon)
Gets the local radius for the given latitude/longitude coordinate.
QString formatBundleOutputString(bool errorPropagation)
Formats and returns the parameter values as a QString.
Distance m_aprioriMeanRadius
Apriori Mean Radius.
virtual bool solvePM()
If the prime meridian angle will be solved for with this target body.
Distance m_aprioriRadiusA
Apriori Radius A.
QSharedPointer< BundleTargetBody > BundleTargetBodyQsp
Definition for BundleTargetBodyQsp, a QSharedPointer to a BundleTargetBody.
QStringList parameterList()
Returns a list of all the parameters being solved for as QStrings.
This class is designed to encapsulate the concept of a Latitude.
Definition: Latitude.h:63
Distance meanRadius()
Returns the mean radius.
virtual bool solvePoleRA()
If the pole right ascension angle will be solved for with this target body.
static TargetRadiiSolveMethod stringToTargetRadiiOption(QString option)
Converts a QString to a TargetRadiiSolveMethod.
Distance m_meanRadius
Adjusted mean radius value.
LinearAlgebra::Vector m_adjustedSigmas
Adjusted parameter sigmas.
bool readFromPvl(PvlObject &tbPvlObject)
Set bundle solve parameters for target body from a pvl file.
Solve for all radii.
int numberRadiusParameters()
Returns the number of radius parameters being solved for.
LinearAlgebra::Vector m_corrections
Cumulative parameter corrections.
LinearAlgebra::Vector & parameterWeights()
Returns the vector of parameter weights.
virtual bool solvePoleDec()
If the pole declination angle will be solved for with this target body.
Unless noted otherwise, the portions of Isis written by the USGS are public domain.
Distance measurement, usually in meters.
Definition: Distance.h:47
std::vector< Angle > m_raPole
pole ra quadratic polynomial coefficients
LinearAlgebra::Vector & adjustedSigmas()
Returns the vector of adjusted parameters sigmas.
LinearAlgebra::Vector & parameterSolution()
Returns the vector of parameters solution.
Distance m_sigmaRadiusC
Apriori Radius C Sigma.
This class is designed to encapsulate the concept of a Longitude.
Definition: Longitude.h:52
void applyParameterCorrections(LinearAlgebra::Vector corrections)
Applies a vector of corrections to the parameters for the target body.
boost::numeric::ublas::vector< double > Vector
Definition for an Isis::LinearAlgebra::Vector of doubles.
std::vector< Distance > m_radii
Adjusted triaxial radii values.
std::vector< Angle > m_pm
pole pm quadratic polynomial coefficients
virtual bool solvePMVelocity()
If the prime meridian velocity will be solved for with this target body.
Distance m_sigmaMeanRadius
Apriori Mean Radius Sigma.
std::vector< Angle > pmCoefs()
Returns the coefficients of the prime meridian polynomial.
Solve for mean radius.
BundleTargetBody()
Creates an empty BundleTargetBody object.
TargetRadiiSolveMethod
Enumeration that defines how to solve for target radii.
LinearAlgebra::Vector m_solution
Parameter solution vector.
virtual bool solvePoleRAAcceleration()
If the pole right ascension acceleration will be solved for with this target body.
BundleTargetBody & operator=(const BundleTargetBody &src)
Assignment operator.
void setSolveSettings(std::set< int > targetParameterSolveCodes, Angle aprioriPoleRA, Angle sigmaPoleRA, Angle aprioriVelocityPoleRA, Angle sigmaVelocityPoleRA, Angle aprioriPoleDec, Angle sigmaPoleDec, Angle aprioriVelocityPoleDec, Angle sigmaVelocityPoleDec, Angle aprioriPM, Angle sigmaPM, Angle aprioriVelocityPM, Angle sigmaVelocityPM, TargetRadiiSolveMethod solveRadiiMethod, Distance aprioriRadiusA, Distance sigmaRadiusA, Distance aprioriRadiusB, Distance sigmaRadiusB, Distance aprioriRadiusC, Distance sigmaRadiusC, Distance aprioriMeanRadius, Distance sigmaMeanRadius)
Sets the solve settings for the target body.
double vtpv()
Calculates and returns the weighted sum of the squares of the corrections.
This class is used to create and store valid Isis3 targets.
Definition: Target.h:76
QStringList m_parameterNamesList
List of all target parameters.
Defines an angle and provides unit conversions.
Definition: Angle.h:62
Unless noted otherwise, the portions of Isis written by the USGS are public domain.
LinearAlgebra::Vector m_aprioriSigmas
A priori parameter sigmas.
virtual bool solvePMAcceleration()
If the prime meridian acceleration will be solved for with this target body.
TargetRadiiSolveMethod m_solveTargetBodyRadiusMethod
Which radii will be solved for.
std::set< int > m_parameterSolveCodes
Target parameter solve codes.
virtual bool solvePoleDecVelocity()
If the pole declination velocity will be solved for with this target body.
Namespace for ISIS/Bullet specific routines.
Definition: Apollo.h:31
virtual int numberParameters()
Returns the total number of parameters being solved for.
virtual bool solveMeanRadius()
If the mean radius will be solved for with this target body.
virtual bool solveTriaxialRadii()
If the triaxial radii will be solved for with this target body.
LinearAlgebra::Vector m_weights
Parameter weights.
virtual ~BundleTargetBody()
Destructor.
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:74
virtual bool solvePoleDecAcceleration()
If the pole declination acceleration will be solved for with this target body.
std::vector< Angle > poleRaCoefs()
Returns the coefficients of the right ascension polynomial.
LinearAlgebra::Vector & parameterCorrections()
Returns the vector of corrections applied to the parameters.
std::vector< Distance > radii()
Returns the radius values.
Unless noted otherwise, the portions of Isis written by the USGS are public domain.
std::vector< Angle > poleDecCoefs()
Returns the coefficients of the declination polynomial.