Isis 3 Programmer Reference
Planar.h
1 #ifndef Planar_h
2 #define Planar_h
3 
8 /* SPDX-License-Identifier: CC0-1.0 */
9 #include "RingPlaneProjection.h"
10 
11 namespace Isis {
12  class Pvl;
13  class PvlGroup;
40  class Planar : public RingPlaneProjection {
41  public:
42  Planar(Pvl &label, bool allowDefaults = false);
43  ~Planar();
44  bool operator== (const Projection &proj);
45 
46  QString Name() const;
47  QString Version() const;
48  double TrueScaleRingRadius() const;
49 
50  double CenterRingLongitude() const;
51  double CenterRingRadius() const;
52 
53  bool SetGround(const double ringRadius, const double ringLongitude);
54  bool SetCoordinate(const double x, const double y);
55  bool XYRange(double &minX, double &maxX, double &minY, double &maxY);
56 
57  PvlGroup Mapping();
60 
61  protected:
62 
63  private:
66  };
67 };
68 #endif
Isis::Planar::MappingRingRadii
PvlGroup MappingRingRadii()
This function returns the radius keywords that this projection uses.
Definition: Planar.cpp:451
Isis::Planar::Version
QString Version() const
Returns the version of the map projection.
Definition: Planar.cpp:155
Isis::Planar::Planar
Planar(Pvl &label, bool allowDefaults=false)
TODO: correct documentation in this file.
Definition: Planar.cpp:39
Isis::Planar::operator==
bool operator==(const Projection &proj)
Compares two Projection objects to see if they are equal.
Definition: Planar.cpp:89
Isis::Pvl
Container for cube-like labels.
Definition: Pvl.h:119
Isis::Planar::CenterRingLongitude
double CenterRingLongitude() const
Returns the center longitude, in degrees.
Definition: Planar.cpp:132
Isis::Planar
Planar Map Projection.
Definition: Planar.h:40
Isis::Planar::CenterRingRadius
double CenterRingRadius() const
Returns the center radius, in meters.
Definition: Planar.cpp:144
Isis::RingPlaneProjection
Base class for Map Projections of plane shapes.
Definition: RingPlaneProjection.h:147
Isis::PvlGroup
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
Isis::Planar::Name
QString Name() const
Returns the name of the map projection, "Planar".
Definition: Planar.cpp:104
Isis::Planar::MappingRingLongitudes
PvlGroup MappingRingLongitudes()
This function returns the azimuth keywords that this projection uses.
Definition: Planar.cpp:466
Isis::Planar::m_centerRingLongitude
double m_centerRingLongitude
The center longitude for the map projection.
Definition: Planar.h:64
Isis::Planar::m_centerRingRadius
double m_centerRingRadius
The center radius for the map projection.
Definition: Planar.h:65
Isis::Planar::~Planar
~Planar()
Destroys the Planar object.
Definition: Planar.cpp:78
Isis::Planar::SetGround
bool SetGround(const double ringRadius, const double ringLongitude)
This method is used to set the radius/azimuth (assumed to be of the correct RingLongitudeDirection,...
Definition: Planar.cpp:172
Isis::Planar::Mapping
PvlGroup Mapping()
This function returns the keywords that this projection uses.
Definition: Planar.cpp:434
Isis::Planar::TrueScaleRingRadius
double TrueScaleRingRadius() const
Returns the center radius, in meters.
Definition: Planar.cpp:121
Isis::Projection
Base class for Map Projections.
Definition: Projection.h:155
Isis::Planar::SetCoordinate
bool SetCoordinate(const double x, const double y)
This method is used to set the projection x/y.
Definition: Planar.cpp:226
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Isis::Planar::XYRange
bool XYRange(double &minX, double &maxX, double &minY, double &maxY)
This method is used to determine the x/y range which completely covers the area of interest specified...
Definition: Planar.cpp:379