ControlPoint.h

Go to the documentation of this file.

#ifndef ControlPoint_h
#define ControlPoint_h

#include <bitset>

#include <QObject>
#include <QString>

#include "SurfacePoint.h"

template< typename A, typename B > class QHash;

class QStringList;

namespace Isis {
  class ControlMeasure;
  class ControlNet;
  class ControlPointFileEntryV0002;
  class Latitude;
  class Longitude;
  class PBControlNet_PBControlPoint;
  class PBControlNetLogData_Point;
  class PvlObject;
  class Statistics;

  class ControlPoint : public QObject {

      Q_OBJECT

      friend class ControlNet;
    public:
      enum PointType {
        Fixed = 0,
        Constrained = 1,
        Free = 2
      };
      static const int PointTypeCount = 3;

      enum Status {
        Failure,
        Success,
        PointLocked
      };

      enum ConstraintStatus {
        LatitudeConstrained = 0,
        LongitudeConstrained = 1,
        RadiusConstrained = 2,
//      XConstrained = 3,
//      YConstrained = 4,
//      ZConstrained = 5;
      };

      // This stuff input to jigsaw
      // How did apriori source get computed??
      struct SurfacePointSource {
        enum Source {
          None,
          User,
          AverageOfMeasures,
          Reference,
          Basemap,
          BundleSolution
        };
      };

      struct RadiusSource {
        enum Source {
          None,
          User,
          AverageOfMeasures,
          Ellipsoid,
          DEM,
          BundleSolution
        };
      };

      ControlPoint();
      ControlPoint(const ControlPoint &);
      ControlPoint(const QString &id);
      ControlPoint(const ControlPointFileEntryV0002 &fileEntry,
          const Distance &majorRad, const Distance &minorRad,
          const Distance &polarRad);
      ~ControlPoint();

      ControlNet *Parent() { return parentNetwork; }

      void Load(PvlObject &p);

      void Add(ControlMeasure *measure);
      int Delete(ControlMeasure *measure);
      int Delete(QString serialNumber);
      int Delete(int index);
      Status ResetApriori();

      const ControlMeasure *GetMeasure(QString serialNumber) const;
      ControlMeasure *GetMeasure(QString serialNumber);

      const ControlMeasure *GetMeasure(int index) const;
      ControlMeasure *GetMeasure(int index);

      const ControlMeasure *GetRefMeasure() const;
      ControlMeasure *GetRefMeasure();

      Status SetChooserName(QString name);
      Status SetDateTime(QString newDateTime);
      Status SetEditLock(bool editLock);
      Status SetId(QString id);
      Status SetRefMeasure(ControlMeasure *cm);
      Status SetRefMeasure(int index);
      Status SetRefMeasure(QString sn);
      Status SetRejected(bool rejected);
      Status SetIgnored(bool newIgnoreStatus);
      Status SetAdjustedSurfacePoint(SurfacePoint newSurfacePoint);
      Status SetType(PointType newType);

      Status SetAprioriRadiusSource(RadiusSource::Source source);
      Status SetAprioriRadiusSourceFile(QString sourceFile);
      Status SetAprioriSurfacePoint(SurfacePoint aprioriSP);
      Status SetAprioriSurfacePointSource(SurfacePointSource::Source source);
      Status SetAprioriSurfacePointSourceFile(QString sourceFile);

//    Status UpdateSphericalPointCoordinates(const Latitude &lat, const Longitude &lon,
//                                      const Distance &radius);

      Status ComputeApriori();
      Status ComputeResiduals();
      Status ComputeResiduals_Millimeters();

      SurfacePoint GetAdjustedSurfacePoint() const;
      SurfacePoint GetBestSurfacePoint() const;
      QString GetChooserName() const;
      QString GetDateTime() const;
      bool IsEditLocked() const;
      bool IsRejected() const;
      QString GetId() const;
      bool IsIgnored() const;
      bool IsValid() const;
      bool IsInvalid() const;
      bool IsFixed() const;

      bool HasAprioriCoordinates();
      bool IsConstrained();
      bool IsLatitudeConstrained();
      bool IsLongitudeConstrained();
      bool IsRadiusConstrained();
      int NumberOfConstrainedCoordinates();

      static QString PointTypeToString(PointType type);
      static PointType StringToPointType(QString pointTypeString);

      QString GetPointTypeString() const;
      PointType GetType() const;

      static QString RadiusSourceToString(RadiusSource::Source source);
      static RadiusSource::Source StringToRadiusSource(QString str);
      QString GetRadiusSourceString() const;
      static QString SurfacePointSourceToString(SurfacePointSource::Source source);
      static SurfacePointSource::Source StringToSurfacePointSource(QString str);
      QString GetSurfacePointSourceString() const;

      SurfacePoint GetAprioriSurfacePoint() const;
      RadiusSource::Source GetAprioriRadiusSource() const;
      QString GetAprioriRadiusSourceFile() const;
      SurfacePointSource::Source GetAprioriSurfacePointSource() const;
      QString GetAprioriSurfacePointSourceFile() const;

      int GetNumMeasures() const;
      int GetNumValidMeasures() const;
      int GetNumLockedMeasures() const;
      bool HasSerialNumber(QString serialNumber) const;
      int IndexOf(ControlMeasure *, bool throws = true) const;
      int IndexOf(QString sn, bool throws = true) const;
      int IndexOfRefMeasure() const;
      bool IsReferenceExplicit() const;
      QString GetReferenceSN() const;

      Statistics GetStatistic(double(ControlMeasure::*statFunc)() const) const;
      Statistics GetStatistic(long dataType) const;

      QList< ControlMeasure * > getMeasures(bool excludeIgnored = false) const;
      QList< QString > getCubeSerialNumbers() const;

      const ControlMeasure *operator[](QString serialNumber) const;
      ControlMeasure *operator[](QString serialNumber);

      const ControlMeasure *operator[](int index) const;
      ControlMeasure *operator[](int index);

      bool operator!=(const ControlPoint &pPoint) const;
      bool operator==(const ControlPoint &pPoint) const;
      const ControlPoint &operator=(const ControlPoint &pPoint);

      // The next 7 methods are specifically to support BundleAdjust
      void ZeroNumberOfRejectedMeasures();
      void SetNumberOfRejectedMeasures(int numRejected);
      int GetNumberOfRejectedMeasures() const;
      double GetSampleResidualRms() const;
      double GetLineResidualRms() const;
      double GetResidualRms() const;
      void ClearJigsawRejected();

      ControlPointFileEntryV0002 ToFileEntry() const;

    private:
      void SetExplicitReference(ControlMeasure *measure);
      void ValidateMeasure(QString serialNumber) const;
      void AddMeasure(ControlMeasure *measure);
      void PointModified();


    private:
      ControlNet *parentNetwork;

      QHash< QString, ControlMeasure * > * measures;

      QStringList *cubeSerials;

      ControlMeasure *referenceMeasure;

      QString id;

      QString chooserName;

      QString dateTime;

      PointType type;

      bool invalid;

      bool editLock;

      bool jigsawRejected;

      std::bitset<6> constraintStatus;

      bool referenceExplicitlySet;

      bool ignore;

      SurfacePointSource::Source aprioriSurfacePointSource;

      QString aprioriSurfacePointSourceFile;

      RadiusSource::Source aprioriRadiusSource;

      QString aprioriRadiusSourceFile;

      SurfacePoint aprioriSurfacePoint;

      SurfacePoint adjustedSurfacePoint;

      int numberOfRejectedMeasures;
  };
}

#endif