Object/Programmer/_bundle_settings_8h_source.html

 #ifndef BundleSettings_h

 #define BundleSettings_h


 // Qt library

 #include <QList>

 #include <QPair>

 #include <QSharedPointer>

 #include <QString>


 // hdf5 library

 #include <H5Cpp.h>

 #include <hdf5_hl.h>

 #include <hdf5.h>


 // ISIS library

 #include "BundleTargetBody.h"

 #include "BundleObservationSolveSettings.h"

 #include "MaximumLikelihoodWFunctions.h"

 #include "SpecialPixel.h"

 #include "XmlStackedHandler.h"


 class QDataStream;

 class QUuid;

 class QXmlStreamWriter;


 using namespace H5;

 using namespace Isis;


 namespace Isis {

   class FileName;

   class Project;

   class PvlObject;

   class XmlStackedHandlerReader;


   class BundleSettings {

     public:


       //=====================================================================//

       //================ constructors, destructor, operators ================//

       //=====================================================================//

       BundleSettings();

       BundleSettings(const BundleSettings &other);

       BundleSettings(Project *project,

                      XmlStackedHandlerReader *xmlReader);

 #if 0

       BundleSettings(FileName xmlFile,

                      Project *project,

                      XmlStackedHandlerReader *xmlReader,

                      QObject *parent = NULL);

       BundleSettings(XmlStackedHandlerReader *xmlReader,

                      QObject *parent = NULL);

 #endif

       ~BundleSettings();

       BundleSettings &operator=(const BundleSettings &other);


       void setValidateNetwork(bool validate);

       bool validateNetwork() const;


       //=====================================================================//

       //============================ Solve options ==========================//

       //=====================================================================//


       // mutators

       void setSolveOptions(bool solveObservationMode = false,

                            bool updateCubeLabel = false,

                            bool errorPropagation = false,

                            bool solveRadius = false,

                            double globalLatitudeAprioriSigma = Isis::Null,

                            double globalLongitudeAprioriSigma = Isis::Null,

                            double globalRadiusAprioriSigma = Isis::Null);

       void setOutlierRejection(bool outlierRejection,

                                double multiplier = 1.0);

       void setObservationSolveOptions(QList<BundleObservationSolveSettings> obsSolveSettingsList);

       void setCreateInverseMatrix(bool createMatrix);


       // accessors

       bool createInverseMatrix() const;

       bool solveObservationMode() const;

       bool solveRadius() const;

       bool updateCubeLabel() const;

       bool errorPropagation() const;

       bool outlierRejection() const;

       double outlierRejectionMultiplier() const;

       double globalLatitudeAprioriSigma() const;

       double globalLongitudeAprioriSigma() const;

       double globalRadiusAprioriSigma() const;


       int numberSolveSettings() const;

       BundleObservationSolveSettings observationSolveSettings(QString instrumentId) const;

       BundleObservationSolveSettings observationSolveSettings(int n) const;


       //=====================================================================//

       //======================- Convergence Criteria ========================//

       //=====================================================================//


       enum ConvergenceCriteria {

         Sigma0,

         ParameterCorrections

       };


       static ConvergenceCriteria stringToConvergenceCriteria(QString criteria);

       static QString convergenceCriteriaToString(ConvergenceCriteria criteria);

       void setConvergenceCriteria(ConvergenceCriteria criteria,

                                   double threshold,

                                   int maximumIterations);

       ConvergenceCriteria convergenceCriteria() const;

       double convergenceCriteriaThreshold() const;

       int convergenceCriteriaMaximumIterations() const;


       //=====================================================================//

       //================ Parameter Uncertainties (Weighting) ================//

       //=====================================================================//

       // mutators

 //      void setGlobalLatitudeAprioriSigma(double sigma);

 //      void setGlobalLongitudeAprioriSigma(double sigma);

 //      void setGlobalRadiiAprioriSigma(double sigma);


       //=====================================================================//

       //=============== Maximum Likelihood Estimation Options ===============//

       //=====================================================================//


       enum MaximumLikelihoodModel {

         NoMaximumLikelihoodEstimator,

         Huber,

         ModifiedHuber,

         Welsch,

         Chen

       };


       void addMaximumLikelihoodEstimatorModel(MaximumLikelihoodWFunctions::Model model,

                                               double cQuantile);

       QList< QPair< MaximumLikelihoodWFunctions::Model, double > >

           maximumLikelihoodEstimatorModels() const;


       //=====================================================================//

       //========================= Self Calibration ==========================//

       //=====================================================================//


       //=====================================================================//

       //============================== Target Body ==========================//

       //=====================================================================//

       void setBundleTargetBody(BundleTargetBodyQsp bundleTargetBody);

       BundleTargetBodyQsp bundleTargetBody() const;

 //      bool solveTargetBodyPolePosition() const;

 //      static TargetRadiiSolveMethod stringToTargetRadiiOption(QString option);

 //      static QString targetRadiiOptionToString(TargetRadiiSolveMethod targetRadiiSolveMethod);

       int numberTargetBodyParameters() const;

       bool solveTargetBody() const;

       bool solvePoleRA() const;

       bool solvePoleRAVelocity() const;

       bool solvePoleDec() const;

       bool solvePoleDecVelocity() const;

       bool solvePM() const;

       bool solvePMVelocity() const;

       bool solvePMAcceleration() const;

       bool solveTriaxialRadii() const;

       bool solveMeanRadius() const;

 //  void BundleSettings::setTargetBodySolveOptions(bool solveTargetBodyPolePosition,


       //=====================================================================//

       //================== Output Options ??? (from Jigsaw only)=============//

       //=====================================================================//

       void setOutputFilePrefix(QString outputFilePrefix);

       void setSCPVLFilename(QString SCParamFilename);

       QString outputFilePrefix() const;

       QString SCPVLFilename() const;


       PvlObject pvlObject(QString name = "BundleSettings") const;


       void save(QXmlStreamWriter &stream, const Project *project) const;


       QDataStream &write(QDataStream &stream) const;

       QDataStream &read(QDataStream &stream);


       void createH5Group(hid_t locationId,

                          QString locationName) const; //delete

       void parseH5Group(hid_t locationId,

                         QString locationName);        //delete


       void createH5Group(H5::CommonFG &locationObject,

                          QString locationName) const;

       H5::Group createH5Group2(H5::Group locationGroup,

                                QString locationName);

       void openH5Group(H5::CommonFG &locationObject,

                        QString locationName);

       BundleSettings(H5::CommonFG &locationObject,

                      QString locationName);


     private:


       //=====================================================================//

       //============= Saving/Restoring a BundleSettings object ==============//

       //=====================================================================//


       class XmlHandler : public XmlStackedHandler {

         public:

           XmlHandler(BundleSettings *bundleSettings,

                      Project *project);

           XmlHandler(BundleSettings *bundleSettings);

           ~XmlHandler();


           virtual bool startElement(const QString &namespaceURI,

                                     const QString &localName,

                                     const QString &qName,

                                     const QXmlAttributes &atts);

           virtual bool characters(const QString &ch);

           virtual bool endElement(const QString &namespaceURI,

                                   const QString &localName,

                                   const QString &qName);

           bool fatalError(const QXmlParseException &exception);


         private:

           Q_DISABLE_COPY(XmlHandler);


           BundleSettings *m_xmlHandlerBundleSettings ;

           Project *m_xmlHandlerProject; // TODO: does xml stuff need project???

           QString m_xmlHandlerCharacters;

           QList<BundleObservationSolveSettings *> m_xmlHandlerObservationSettings;

       };


       struct MaximumLikelihoodModelTableRecord {

           unsigned int indexFieldValue;

           QString nameFieldValue;

           double quantileFieldValue;

       };


       QUuid *m_id;

       bool m_validateNetwork;

       bool m_solveObservationMode;

       bool m_solveRadius;

       bool m_updateCubeLabel;

       bool m_errorPropagation;

       bool m_createInverseMatrix;

       bool m_outlierRejection;

       double m_outlierRejectionMultiplier;

       // Parameter Uncertainties (Weighting)

       double m_globalLatitudeAprioriSigma;

       double m_globalLongitudeAprioriSigma;

       double m_globalRadiusAprioriSigma;


       // QList of observation solve settings

       QList<BundleObservationSolveSettings> m_observationSolveSettings;


       // Convergence Criteria

       ConvergenceCriteria m_convergenceCriteria;

       double m_convergenceCriteriaThreshold;

       int m_convergenceCriteriaMaximumIterations;

       // Maximum Likelihood Estimation Options

       QList< QPair< MaximumLikelihoodWFunctions::Model, double > > m_maximumLikelihood;


       // Self Calibration


       // Target Body

       bool m_solveTargetBody;

       BundleTargetBodyQsp m_bundleTargetBody;

       // Output Options

       QString m_outputFilePrefix;

  };

   // typedefs

   typedef QSharedPointer<BundleSettings> BundleSettingsQsp;


   // operators to read/write BundleResults to/from binary data

   QDataStream &operator<<(QDataStream &stream, const BundleSettings &settings);

   QDataStream &operator>>(QDataStream &stream, BundleSettings &settings);

 };


 Q_DECLARE_METATYPE(Isis::BundleSettingsQsp);


 #endif


Isis::BundleSettings::MaximumLikelihoodModelTableRecord::indexFieldValue
unsigned int indexFieldValue
The index of the TableRecord.???
Definition: BundleSettings.h:344

BundleTargetBody.h

Isis::BundleSettings::m_globalLongitudeAprioriSigma
double m_globalLongitudeAprioriSigma
The global a priori sigma for longitude.
Definition: BundleSettings.h:364

Isis::BundleSettings::m_createInverseMatrix
bool m_createInverseMatrix
Indicates whether to create the inverse matrix file.
Definition: BundleSettings.h:356

Isis::BundleSettings::m_bundleTargetBody
BundleTargetBodyQsp m_bundleTargetBody
A pointer to the target body settings and information.
Definition: BundleSettings.h:394

Isis::Null
const double Null
Value for an Isis Null pixel.
Definition: SpecialPixel.h:109

Isis::BundleSettingsQsp
QSharedPointer< BundleSettings > BundleSettingsQsp
Definition for a BundleSettingsQsp, a shared pointer to a BundleSettings object.
Definition: BundleSettings.h:404

Isis::Project
The main project for cnetsuite.
Definition: Project.h:105

Isis::FileName
File name manipulation and expansion.
Definition: FileName.h:111

Isis::BundleSettings::m_solveObservationMode
bool m_solveObservationMode
Indicates whether to solve for observation mode.
Definition: BundleSettings.h:352

SpecialPixel.h

Isis::BundleSettings::m_convergenceCriteria
ConvergenceCriteria m_convergenceCriteria
Enumeration used to indicate what criteria to use to determine bundle adjustment convergence.
Definition: BundleSettings.h:371

Isis::BundleTargetBodyQsp
QSharedPointer< BundleTargetBody > BundleTargetBodyQsp
Definition for BundleTargetBodyQsp, a QSharedPointer to a BundleTargetBody.
Definition: BundleTargetBody.h:198

Isis::BundleSettings::m_outlierRejectionMultiplier
double m_outlierRejectionMultiplier
The multiplier value for outlier rejection.
Definition: BundleSettings.h:359

Q_DECLARE_METATYPE
Q_DECLARE_METATYPE(Isis::Cube *)
This allows Cube *&#39;s to be stored in a QVariant.

Isis::BundleSettings::m_outputFilePrefix
QString m_outputFilePrefix
The prefix for all output files.
Definition: BundleSettings.h:398

Isis::MaximumLikelihoodWFunctions::Model
Model
The supported maximum likelihood estimation models.
Definition: MaximumLikelihoodWFunctions.h:69

Isis::BundleSettings::m_validateNetwork
bool m_validateNetwork
Indicates whether the network should be validated.
Definition: BundleSettings.h:351

BundleObservationSolveSettings.h

operator<<
QDebug operator<<(QDebug dbg, const Isis::Angle &angleToPrint)
Display an Angle for a debugging statement.
Definition: Angle.cpp:379

Isis::BundleSettings::NoMaximumLikelihoodEstimator
Do not use a maximum likelihood model.
Definition: BundleSettings.h:219

Isis::BundleSettings::m_updateCubeLabel
bool m_updateCubeLabel
Indicates whether to update cubes.
Definition: BundleSettings.h:354

Isis::BundleSettings::m_maximumLikelihood
QList< QPair< MaximumLikelihoodWFunctions::Model, double > > m_maximumLikelihood
Model and C-Quantile for each of the three maximum likelihood estimations.
Definition: BundleSettings.h:388

Isis::operator>>
std::istream & operator>>(std::istream &is, CSVReader &csv)
Input read operator for input stream sources.
Definition: CSVReader.cpp:463

Isis::BundleSettings
Container class for BundleAdjustment settings.
Definition: BundleSettings.h:119

Isis::XmlStackedHandler
XML Handler that parses XMLs in a stack-oriented way.
Definition: XmlStackedHandler.h:47

Isis::BundleSettings::XmlHandler
This class is needed to read/write BundleSettings from/to an XML formateed file.
Definition: BundleSettings.h:311

Isis::BundleSettings::m_convergenceCriteriaThreshold
double m_convergenceCriteriaThreshold
Tolerance value corresponding to the selected convergence criteria.
Definition: BundleSettings.h:374

MaximumLikelihoodWFunctions.h

Isis::BundleObservationSolveSettings
This class is used to modify and manage solve settings for 1 to many BundleObservations.
Definition: BundleObservationSolveSettings.h:84

Isis::validate
bool validate(const NaifVertex &v)
Verifies that the given NaifVector or NaifVertex is 3 dimensional.
Definition: NaifDskApi.cpp:54

Isis::BundleSettings::m_globalLatitudeAprioriSigma
double m_globalLatitudeAprioriSigma
The global a priori sigma for latitude.
Definition: BundleSettings.h:363

Isis::BundleSettings::MaximumLikelihoodModel
MaximumLikelihoodModel
This enum defines the options for maximum likelihood estimation.
Definition: BundleSettings.h:218

Isis::BundleSettings::m_outlierRejection
bool m_outlierRejection
Indicates whether to perform automatic outlier detection/rejection.
Definition: BundleSettings.h:357

Isis::BundleSettings::m_solveRadius
bool m_solveRadius
Indicates whether to solve for point radii.
Definition: BundleSettings.h:353

Isis::BundleSettings::m_convergenceCriteriaMaximumIterations
int m_convergenceCriteriaMaximumIterations
Maximum number of iterations before quitting the bundle adjustment if it has not yet converged to the...
Definition: BundleSettings.h:376

Isis::BundleSettings::MaximumLikelihoodModelTableRecord::nameFieldValue
QString nameFieldValue
The model name of the TableRecord.???
Definition: BundleSettings.h:345

QList
Definition: BoxcarCachingAlgorithm.h:29

Isis::BundleSettings::MaximumLikelihoodModelTableRecord::quantileFieldValue
double quantileFieldValue
The quantile of the TableRecord.???
Definition: BundleSettings.h:346

QObject

Isis::BundleSettings::m_globalRadiusAprioriSigma
double m_globalRadiusAprioriSigma
The global a priori sigma for radius.
Definition: BundleSettings.h:365

Isis::BundleSettings::MaximumLikelihoodModelTableRecord
This struct is needed to write the m_maximumLikelihood variable as an HDF5 table. ...
Definition: BundleSettings.h:343

Isis::BundleSettings::m_solveTargetBody
bool m_solveTargetBody
Indicates whether to solve for target body.
Definition: BundleSettings.h:393

Isis::PvlObject
Contains Pvl Groups and Pvl Objects.
Definition: PvlObject.h:74

Isis::BundleSettings::m_errorPropagation
bool m_errorPropagation
Indicates whether to perform error propagation.
Definition: BundleSettings.h:355

Isis::XmlStackedHandlerReader
his enables stack-based XML parsing of XML files.
Definition: XmlStackedHandlerReader.h:26

Isis::BundleSettings::m_id
QUuid * m_id
A unique ID for this BundleSettings object.
Definition: BundleSettings.h:349

Isis::BundleSettings::ConvergenceCriteria
ConvergenceCriteria
This enum defines the options for the bundle adjustment&#39;s convergence.
Definition: BundleSettings.h:185