Planar.cpp

Go to the documentation of this file.

#include "Planar.h"

#include <cmath>
#include <cfloat>

#include "Constants.h"
#include "IException.h"
#include "Pvl.h"
#include "PvlGroup.h"
#include "PvlKeyword.h"
#include "RingPlaneProjection.h"

using namespace std;
namespace Isis {
  Planar::Planar(Pvl &label, bool allowDefaults) :
    RingPlaneProjection::RingPlaneProjection(label) {

    // latitude in ring plane is always zero
    m_ringRadius = 0.0;

    try {
      // Try to read the mapping group
      PvlGroup &mapGroup = label.findGroup("Mapping", Pvl::Traverse);

      // Compute and write the default center longitude if allowed and
      // necessary
      if ((allowDefaults) && (!mapGroup.hasKeyword("CenterRingLongitude"))) {
        double azimuth = (m_minimumRingLongitude + m_maximumRingLongitude) / 2.0;
        mapGroup += PvlKeyword("CenterRingLongitude", toString(azimuth));
      }

      // Compute and write the default center radius if allowed and
      // necessary
      if ((allowDefaults) && (!mapGroup.hasKeyword("CenterRingRadius"))) {
        double radius = (m_minimumRingRadius + m_maximumRingRadius) / 2.0;
        mapGroup += PvlKeyword("CenterRingRadius", toString(radius));
      }

      // Get the center longitude  & radius
      m_centerRingLongitude = mapGroup["CenterRingLongitude"];
      m_centerRingRadius = mapGroup["CenterRingRadius"];

      // convert to radians, adjust for azimuth direction
      m_centerRingLongitude *= DEG2RAD;
      if (m_ringLongitudeDirection == Clockwise) m_centerRingLongitude *= -1.0;
    }
    catch(IException &e) {
      string message = "Invalid label group [Mapping]";
      throw IException(e, IException::Io, message, _FILEINFO_);
    }
  }

  Planar::~Planar() {
  }

  bool Planar::operator== (const Projection &proj) {
    if (!RingPlaneProjection::operator==(proj)) return false;
    // dont do the below it is a recursive plunge
    //  if (Projection::operator!=(proj)) return false;
    Planar *planar = (Planar *) &proj;
    if ((planar->m_centerRingLongitude != m_centerRingLongitude) ||
        (planar->m_centerRingRadius != m_centerRingRadius)) return false;
    return true;
  }

   QString Planar::Name() const {
     return "Planar";
   }

  double Planar::TrueScaleRingRadius() const {
    return m_centerRingRadius;
    // return 60268000.0;
  }


  double Planar::CenterRingLongitude() const {
    double dir = 1.0;
    if (m_ringLongitudeDirection == Clockwise) dir = -1.0;
    return m_centerRingLongitude * RAD2DEG * dir;;
  }


  double Planar::CenterRingRadius() const {
    return m_centerRingRadius;
  }


   QString Planar::Version() const {
     return "1.0";
   }


  bool Planar::SetGround(const double ringRadius, const double ringLongitude) {

    // Convert azimuth to radians & adjust
    m_ringLongitude = ringLongitude;
    double azRadians = ringLongitude * DEG2RAD;
    if (m_ringLongitudeDirection == Clockwise) azRadians *= -1.0;

    // Check to make sure radius is valid
    if (ringRadius < 0) {
      m_good = false;
      // cout << "Unable to set radius. The given radius value ["
      //      << IString(ringRadius) << "] is invalid." << endl;
      // throw IException(IException::Unknown,
      //                  "Unable to set radius. The given radius value ["
      //                  + IString(ringRadius) + "] is invalid.",
      //                  _FILEINFO_);
      return m_good;
    }
    m_ringRadius = ringRadius;


    // Compute helper variables
    double deltaAz = (azRadians - m_centerRingLongitude);
//  double coslon = cos(deltaLon);

    // Lat/Lon cannot be projected
//    double g =  m_sinph0 * sinphi + m_cosph0 * cosphi * coslon;
//    if ((g <= 0.0) && (fabs(g) > 1.0e-10)) {
//      m_good = false;
//      return m_good;
//    }

    // Compute the coordinates
    double x = ringRadius * cos(deltaAz);
    double y = ringRadius * sin(deltaAz);

    SetComputedXY(x, y);
    m_good = true;
    return m_good;
  }

  bool Planar::SetCoordinate(const double x, const double y) {

    // Save the coordinate
    SetXY(x, y);

    // compute radius and azimuth in degrees
    m_ringRadius = sqrt(x*x + y*y);

    if (y == 0.0) 
      m_ringLongitude = m_ringLongitude;
    else
      m_ringLongitude = atan2(y,x)  + m_centerRingLongitude;

    m_ringLongitude *= RAD2DEG;

    // if ( m_ringLongitude < 0.0 )
    //   m_ringLongitude += 360.0;

    // Cleanup the azimuth
    if (m_ringLongitudeDirection == Clockwise) m_ringLongitude *= -1.0;

    // These need to be done for circular type projections
    m_ringLongitude = To360Domain(m_ringLongitude);

    if (m_ringLongitudeDomain == 180)
      m_ringLongitude = To180Domain(m_ringLongitude);

    m_good = true;
   return m_good;
  }

/*
  bool Planar::XYRange(double &minX, double &maxX,
                             double &minY, double &maxY) {
    double lat, lon;

    // Check the corners of the lat/lon range
    XYRangeCheck(m_minimumLatitude, m_minimumLongitude);
    XYRangeCheck(m_maximumLatitude, m_minimumLongitude);
    XYRangeCheck(m_minimumLatitude, m_maximumLongitude);
    XYRangeCheck(m_maximumLatitude, m_maximumLongitude);

//cout << " ************ WALK LATITUDE ******************\n";
//cout << "MIN LAT: " << m_minimumLatitude << " MAX LAT: " << m_maximumLatitude << "\n";
    // Walk top and bottom edges
    for (lat = m_minimumLatitude; lat <= m_maximumLatitude; lat += 0.01) {
//cout << "WALKED A STEP - lat: " << lat << "\n";
      lat = lat;
      lon = m_minimumLongitude;
      XYRangeCheck(lat, lon);

      lat = lat;
      lon = m_maximumLongitude;
      XYRangeCheck(lat, lon);
//cout << "MIN LAT: " << m_minimumLatitude << " MAX LAT: " << m_maximumLatitude << "\n";
    }

//cout << " ************ WALK LONGITUDE ******************\n";
    // Walk left and right edges
    for (lon = m_minimumLongitude; lon <= m_maximumLongitude; lon += 0.01) {
      lat = m_minimumLatitude;
      lon = lon;
      XYRangeCheck(lat, lon);

      lat = m_maximumLatitude;
      lon = lon;
      XYRangeCheck(lat, lon);
    }

    // Walk the limb
    for (double angle = 0.0; angle <= 360.0; angle += 0.01) {
      double x = m_equatorialRadius * cos(angle * PI / 180.0);
      double y = m_equatorialRadius * sin(angle * PI / 180.0);
      if (SetCoordinate(x, y) == 0) {
        if (m_latitude > m_maximumLatitude) {
          continue;
        }
        if (m_longitude > m_maximumLongitude) {
          continue;
        }
        if (m_latitude < m_minimumLatitude) {
          continue;
        }
        if (m_longitude < m_minimumLongitude) {
          continue;
        }

        if (m_minimumX > x) m_minimumX = x;
        if (m_maximumX < x) m_maximumX = x;
        if (m_minimumY > y) m_minimumY = y;
        if (m_maximumY < y) m_maximumY = y;
        XYRangeCheck(m_latitude, m_longitude);
      }
    }

    // Make sure everything is ordered
    if (m_minimumX >= m_maximumX) return false;
    if (m_minimumY >= m_maximumY) return false;

    // Return X/Y min/maxs
    minX = m_minimumX;
    maxX = m_maximumX;
    minY = m_minimumY;
    maxY = m_maximumY;
    return true;
  }
*/


  bool Planar::XYRange(double &minX, double &maxX,
                             double &minY, double &maxY) {
    
    double rad, az;

    // Check the corners of the rad/az range
    XYRangeCheck(m_minimumRingRadius, m_minimumRingLongitude);
    XYRangeCheck(m_maximumRingRadius, m_minimumRingLongitude);
    XYRangeCheck(m_minimumRingRadius, m_maximumRingLongitude);
    XYRangeCheck(m_maximumRingRadius, m_maximumRingLongitude);

//cout << " ************ WALK RADIUS ******************\n";
//cout << "MIN RAD: " << m_minimumRingRadius << " MAX LAT: " << m_maximumRingRadius << "\n";
    // Walk top and bottom edges in half pixel increments
    double radiusInc = 2. * (m_maximumRingRadius - m_minimumRingRadius) / PixelResolution();

    for (rad = m_minimumRingRadius; rad <= m_maximumRingRadius; rad += radiusInc) {
//cout << "WALKED A STEP - rad: " << rad << "\n";
      rad = rad;
      az = m_minimumRingLongitude;
      XYRangeCheck(rad, az);

      rad = rad;
      az = m_maximumRingLongitude;
      XYRangeCheck(rad, az);
//cout << "MIN RAD: " << m_minimumRingRadius << " MAX RAD: " << m_maximumRingRadius << "\n";
    }

//cout << " ************ WALK AZIMUTH ******************\n";
    // Walk left and right edges
    for (az = m_minimumRingLongitude; az <= m_maximumRingLongitude; az += 0.01) {
      rad = m_minimumRingRadius;
      az = az;
      XYRangeCheck(rad, az);

      rad = m_maximumRingRadius;
      az = az;
      XYRangeCheck(rad, az);
    }

    // Walk the limb 
/*
    for (double angle = 0.0; angle <= 360.0; angle += 0.01) {
      double x = m_equatorialRadius * cos(angle * PI / 180.0);
      double y = m_equatorialRadius * sin(angle * PI / 180.0);
      if (SetCoordinate(x, y) == 0) {
        if (m_latitude > m_maximumLatitude) {
          continue;
        }
        if (m_longitude > m_maximumRingLongitude) {
          continue;
        }
        if (m_latitude < m_minimumLatitude) {
          continue;
        }
        if (m_longitude < m_minimumRingLongitude) {
          continue;
        }

        if (m_minimumX > x) m_minimumX = x;
        if (m_maximumX < x) m_maximumX = x;
        if (m_minimumY > y) m_minimumY = y;
        if (m_maximumY < y) m_maximumY = y;
        XYRangeCheck(m_latitude, m_longitude);
      }
    } */

    // Make sure everything is ordered
    if (m_minimumX >= m_maximumX) return false;
    if (m_minimumY >= m_maximumY) return false;

    // Return X/Y min/maxs
    // m_maximumX = m_maximumRingRadius*cos(m_maximumRingLongitude);
    // m_minimumX = -m_maximumX;
    // m_maximumY = m_maximumRingRadius*sin(m_maximumRingLongitude);
    // m_minimumY = -m_maximumY;

    minX = m_minimumX;
    maxX = m_maximumX;
    minY = m_minimumY;
    maxY = m_maximumY;

    return true;
  }


  PvlGroup Planar::Mapping() {
    PvlGroup mapping = RingPlaneProjection::Mapping();

    mapping += PvlKeyword("CenterRingRadius", toString(m_centerRingRadius));
    double dir = 1.0;
    if (m_ringLongitudeDirection == Clockwise) dir = -1.0;
    double lonDegrees = m_centerRingLongitude*RAD2DEG*dir;
    mapping += PvlKeyword("CenterRingLongitude", toString(lonDegrees));

    return mapping;
  }

  PvlGroup Planar::MappingRingRadii() {
    PvlGroup mapping = RingPlaneProjection::MappingRingRadii();

    if (HasGroundRange()) 
      mapping += m_mappingGrp["CenterRingRadius"];

    return mapping;
  }


  PvlGroup Planar::MappingRingLongitudes() {
    PvlGroup mapping = RingPlaneProjection::MappingRingLongitudes();

    if (HasGroundRange()) 
      mapping += m_mappingGrp["CenterRingLongitude"];

    return mapping;
  }

} // end namespace isis

extern "C" Isis::Projection *PlanarPlugin(Isis::Pvl &lab,
    bool allowDefaults) {
  return new Isis::Planar(lab, allowDefaults);
}