BundleSettings.h

#ifndef BundleSettings_h
#define BundleSettings_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
// Qt library
#include <QList>
#include <QPair>
#include <QSharedPointer>
#include <QString>
 
 
 
// ISIS library
#include "BundleTargetBody.h"
#include "BundleObservationSolveSettings.h"
#include "MaximumLikelihoodWFunctions.h"
#include "SpecialPixel.h"
#include "SurfacePoint.h"
#include "XmlStackedHandler.h"
 
class QDataStream;
class QUuid;
class QXmlStreamWriter;
 
 
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,
                           SurfacePoint::CoordinateType coordTypeBundle = SurfacePoint::Latitudinal,
                           SurfacePoint::CoordinateType coordTypeReports = SurfacePoint::Latitudinal,
                           double globalPointCoord1AprioriSigma = Isis::Null,
                           double globalPointCoord2AprioriSigma = Isis::Null,
                           double globalPointCoord3AprioriSigma = Isis::Null);
      void setOutlierRejection(bool outlierRejection,
                               double multiplier = 1.0);
      void setObservationSolveOptions(QList<BundleObservationSolveSettings> obsSolveSettingsList);
      void setCreateInverseMatrix(bool createMatrix);
 
      // accessors
      SurfacePoint::CoordinateType controlPointCoordTypeReports() const;
      SurfacePoint::CoordinateType controlPointCoordTypeBundle() const;
      bool createInverseMatrix() const;
      bool solveObservationMode() const;
      bool solveRadius() const;
      bool updateCubeLabel() const;
      bool errorPropagation() const;
      bool outlierRejection() const;
      double outlierRejectionMultiplier() const;
// These sigmas are either for planetocentric lat/lon/radius or body-fixed x/y/z
      double globalPointCoord1AprioriSigma() const;
      double globalPointCoord2AprioriSigma() const;
      double globalPointCoord3AprioriSigma() const;
 
      int numberSolveSettings() const;
      BundleObservationSolveSettings observationSolveSettings(QString instrumentId) const;
      BundleObservationSolveSettings observationSolveSettings(int n) const;
      QList<BundleObservationSolveSettings> observationSolveSettings() 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 ==========================//
      //=====================================================================//
      // Note targeBody information is not currently serialized.
      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;
      void setCubeList(QString fileName);
      QString cubeList() const;
      QString SCPVLFilename() const;
 
      void save(QXmlStreamWriter &stream, const Project *project) const;
 
    private:
      void init();
 
      //=====================================================================//
      //============= 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; 
      };
 
      bool m_validateNetwork; 
      QString m_cubeList;
      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_globalPointCoord1AprioriSigma;   
      double m_globalPointCoord2AprioriSigma;   
      double m_globalPointCoord3AprioriSigma;   
 
      // 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; 
      // Control Points
      SurfacePoint::CoordinateType m_cpCoordTypeReports;  
      SurfacePoint::CoordinateType m_cpCoordTypeBundle;     
      // Output Options
      QString m_outputFilePrefix;    
 };
  // typedefs
  typedef QSharedPointer<BundleSettings> BundleSettingsQsp;
 
 
};
 
Q_DECLARE_METATYPE(Isis::BundleSettingsQsp);
 
#endif