RingPlaneProjection.h

Go to the documentation of this file.

#ifndef RingPlaneProjection_h
#define RingPlaneProjection_h

#include <string>
#include <vector>

#include "Projection.h"  
#include "PvlGroup.h" // protected data member object (m_mappingGrp) 

namespace Isis {
  class Displacement;
  class Pvl;
  class WorldMapper;
  class RingPlaneProjection : public Projection {
    public:
      // constructor
      RingPlaneProjection(Pvl &label);
      virtual ~RingPlaneProjection();
      virtual bool operator== (const Projection &proj);

      // These return properties of the target
      double LocalRadius() const; // requires SetGround or SetCoordinate

      // These return or change properties of the projection, independent of calculations
      virtual QString Name() const = 0;
      virtual QString Version() const = 0;
      virtual double TrueScaleRingRadius() const;

      enum RingLongitudeDirection { Clockwise, 
                                CounterClockwise  
                              };

      // Check ring longitude direction or get ring longitude direction as a string
      bool IsClockwise() const;
      bool IsCounterClockwise() const;
      std::string RingLongitudeDirectionString() const;

      // Check ring longitude domain or get ring longitude domain as a string  TODO** check implementation to see if this can go in Projection
      bool Has180Domain() const;
      bool Has360Domain() const;
      std::string RingLongitudeDomainString() const;

      // Get min/max ring rad/lon
      double MinimumRingRadius() const;
      double MaximumRingRadius() const;
      double MinimumRingLongitude() const;
      double MaximumRingLongitude() const;

      //  Calculations
      // Set ground position or x/y coordinate
      virtual bool SetGround(const double ringRadius, const double ringLongitude);
      virtual bool SetCoordinate(const double x, const double y);

      // Methods that depend on successful completion
      // of SetGround/SetCoordinate Get ring rad,ring
      // lon, x,y
      double RingRadius() const;
      double RingLongitude() const;

      // Set the universal ground coordinate (calls SetGround)
      bool SetUniversalGround(const double ringRadius, const double ringLongitude);

      // Return the universal ground coordinate after successful SetCoordinate
      double UniversalRingRadius();
      double UniversalRingLongitude();

      // convert from world coordinate to projected coordinate
      //      double ToProjectionX(const double worldX) const;
      //      double ToProjectionY(const double worldY) const;

      // get resolution and scale for mapping world coordinates
      double Scale() const;

      // Return the x/y range which covers the ring rad/lon range in the labels
      virtual bool XYRange(double &minX, double &maxX, 
                           double &minY, double &maxY);

      // get mapping information
      virtual PvlGroup Mapping();
      virtual PvlGroup MappingRingRadii();
      virtual PvlGroup MappingRingLongitudes();

      // change ring longitude direction
      static double ToClockwise(const double ringLongitude, const int domain);
      static double ToCounterClockwise(const double ringLongitude, const int domain);

      // change ring longitude domain 
      static double To180Domain(const double lon);
      static double To360Domain(const double lon);

    protected:
      void XYRangeCheck(const double ringRadius, const double ringLongitude);
      //      bool xyRangeOblique(double &minX, double &maxX, 
      //                          double &minY, double &maxY);

    private:
      // These methods are not currectly being used by the ring plane projections
      /*      void doSearch(double minBorder, double maxBorder, 
                    double &extremeVal, const double constBorder,
                    bool searchX, bool searchRingLongitude, bool findMin);
      void findExtreme(double &minBorder,  double &maxBorder, 
                       double &minBorderX, double &minBorderY, 
                       double &maxBorderX, double &maxBorderY, 
                       const double constBorder, bool searchX, 
                       bool searchRingLongitude, bool findMin);
      void setSearchGround(const double variableBorder, 
                           const double constBorder, bool variableIsRad);
      */
    protected:
      double m_ringRadius;   
      double m_ringLongitude;  
      RingLongitudeDirection m_ringLongitudeDirection; 
      // TODO** Can this be generalized for both longitude and ring longitude???
      int m_ringLongitudeDomain; 
      double m_minimumRingRadius;   
      double m_maximumRingRadius;   
      double m_minimumRingLongitude;  
      double m_maximumRingLongitude;  
    private:
  };
};
#endif