USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::Sinusoidal Class Reference
[Map Projection]

Sinusoidal Map Projection. More...

#include <Sinusoidal.h>

Inherits Isis::Projection.

List of all members.

Public Types

enum  LatitudeType { Planetographic, Planetocentric }
enum  LongitudeDirection { PositiveEast, PositiveWest }

Public Member Functions

 Sinusoidal (Isis::Pvl &label, bool allowDefaults=false)
 Constructs a Sinusoidal object.
 ~Sinusoidal ()
 Destroys the Sinusoidal object.
bool SetGround (const double lat, const double lon)
 This method is used to set the latitude/longitude (assumed to be of the correct LatitudeType, LongitudeDirection, and LongitudeDomain.
bool SetCoordinate (const double x, const double y)
 This method is used to set the projection x/y.
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 by the lat/lon range.
PvlGroup Mapping ()
 This function returns the keywords that this projection uses.
PvlGroup MappingLatitudes ()
 This function returns the latitude keywords that this projection uses.
PvlGroup MappingLongitudes ()
 This function returns the longitude keywords that this projection uses.
std::string Name () const
 Returns the name of the map projection.
std::string Version () const
 Returns the version of the map projection.
bool operator== (const Isis::Projection &proj)
 Compares two Projection objects to see if they are equal.
void SetWorldMapper (Isis::WorldMapper *mapper)
 If desired the programmer can use this method to set a world mapper to be used in the SetWorld, WorldX, and WorldY methods.
bool SetWorld (const double x, const double y)
 This method is used to set a world coordinate.
void SetUpperLeftCorner (const Displacement &x, const Displacement &y)
 This method sets the UpperLeftCornerX and UpperLeftCornerY keywords in the projection mapping group.
bool IsGood () const
 This indicates if the last invocation of SetGround, SetCoordinate, or SetUniversalGround was with successful or not.
double WorldX () const
 This returns the world X coordinate provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.
double WorldY () const
 This returns the world Y coordinate provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.
double Longitude () const
 This returns a longitude with correct longitude direction and domain as specified in the label object.
double Latitude () const
 This returns a latitude with correct latitude type as specified in the label object.
double XCoord () const
 This returns the projection X provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.
double YCoord () const
 This returns the projection Y provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.
double EquatorialRadius () const
 This returns the equatorial radius of the target.
double PolarRadius () const
 This returns the polar radius of the target.
double Eccentricity () const
 This returns the eccentricity of the target.
bool IsPlanetographic () const
 This indicates if the latitude type is planetographic (as opposed to planetocentric).
bool IsPlanetocentric () const
 This indicates if the latitude type is planetocentric (as opposed to planetographic).
std::string LatitudeTypeString () const
 This method returns the latitude type as a string.
std::string LongitudeDirectionString () const
 This method returns the longitude direction as a string.
std::string LongitudeDomainString () const
 This method returns the longitude domain as a string.
bool IsPositiveWest () const
 This indicates if the longitude direction type is positive east (as opposed to postive west).
bool IsPositiveEast () const
 This indicates if the longitude direction type is positive west (as opposed to postive east).
bool Has360Domain () const
 This indicates if the longitude domain is 0 to 360 (as opposed to -180 to 180).
bool Has180Domain () const
 This indicates if the longitude domain is -180 to 180 (as opposed to 0 to 360).
bool HasGroundRange () const
 This indicates that the labels contained minimum and maximum latitudes and longitudes (e.g., a ground range coverage).
double MinimumLatitude () const
 This returns the minimum latitude of the area of interest.
double MaximumLatitude () const
 This returns the maximum latitude of the area of interest.
double MinimumLongitude () const
 This returns the minimum longitude of the area of interest.
double MaximumLongitude () const
 This returns the maximum longitude of the area of interest.
double Rotation () const
 Return the rotation of the map.
double UniversalLatitude ()
 This returns a universal latitude (planetocentric).
double UniversalLongitude ()
 This returns a universal longitude (positive east in 0 to 360 domain).
bool SetUniversalGround (const double lat, const double lon)
 This method is used to set the latitude/longitude which must be Planetocentric (latitude) and PositiveEast/Domain360 (longitude).
double ToPlanetocentric (const double lat) const
 This method converts a planetographic latitude to a planetocentric latitude.
double ToPlanetographic (const double lat) const
 This method converts a planetocentric latitude to a planetographic latitude.
double ToWorldX (const double projectionX) const
 This method converts a projection x value to a world x value.
double ToWorldY (const double projectionY) const
 This method converts a projection y value to a world y value.
double ToProjectionX (const double worldX) const
 This method converts a world x value to a projection x value.
double ToProjectionY (const double worldY) const
 This method converts a world y value to a projection y value.
double Resolution () const
 This method returns the resolution for mapping world coordinates into projection coordinates.
double Scale () const
 This method returns the scale for mapping world coordinates into projection coordinates.
virtual double TrueScaleLatitude () const
 This method returns the latitude of true scale.
bool operator!= (const Projection &proj)
 This method returns if two map projection objects are not equal.
virtual bool IsEquatorialCylindrical ()
 This method returns true if the projection is equatorial cylindrical.
double LocalRadius () const
 This method returns the local radius in meters at the current latitude position.
double LocalRadius (double lat) const
 This method returns the local radius in meters at the specified latitude position.
bool IsSky () const
 Returns true if projection is sky and false if it is land.

Static Public Member Functions

static double ToPlanetocentric (double lat, double eRadius, double pRadius)
 This method converts a planetographic latitude to a planetocentric latitude.
static double ToPlanetographic (double lat, double eRadius, double pRadius)
 This method converts a planetocentric latitude to a planetographic latitude.
static double To360Domain (const double lon)
 This method converts a longitude into the 0 to 360 domain.
static double To180Domain (const double lon)
 This method converts a longitude into the -180 to 180 domain.
static double ToPositiveEast (const double lon, const int domain)
 This method converts a longitude into the positive east direction.
static double ToPositiveWest (const double lon, const int domain)
 This method converts a longitude into the positive west direction.
static double ToHours (double angle)
 Converts angle(in degrees) to hours.
static std::string ToDMS (double angle)
 Converts angle(in degrees) to degrees, minutes, seconds.
static std::string ToHMS (double angle)
 Converts angle(in degrees) to hours, minutes, seconds.
static PvlGroup TargetRadii (std::string target)
 Creates a Pvl Group with keywords TargetName, EquitorialRadius, and PolarRadius.
static PvlGroup TargetRadii (Pvl &cubeLab, PvlGroup &mapGroup)
 Convenience method See method above for more details.

Protected Member Functions

void XYRangeCheck (const double latitude, const double longitude)
 This convience function is established to assist in the development of the XYRange virtual method.
double mCompute (const double sinphi, const double cosphi) const
 A convience method to compute m = cosphi/sqrt(1-(ecc*sinphi)**2).
double e4Compute () const
 A convience method to compute e4 = sqrt(1+ecc)**(1+ecc)*(1-ecc)**(1-ecc)).
double tCompute (const double phi, const double sinphi) const
 A convience method to compute: t = tan(.5*(.5PI-phi)/((1-ecc*sinphi)/(1+ecc*sinphi))**(.5*ecc).
double phi2Compute (const double t) const
 A convience method to compute latitude angle phi2 given small t.
void SetXY (double x, double y)
 This protected method is a helper for derived classes.
void SetComputedXY (double x, double y)
 This protected method is a helper for derived classes.
double GetX () const
 Return the unrotated form of p_x.
double GetY () const
 Returh the unrotated form of p_y.

Protected Attributes

Isis::WorldMapperp_mapper
 This points to a mapper passed into the SetWorldMapper method.
double p_latitude
 This contain a latitude value.
double p_longitude
 This contain a longitude value.
bool p_good
 Indicates if the contents of p_x, p_y, p_latitude, and p_longitude are valid.
LatitudeType p_latitudeType
 An enumerated type indicating the LatitudeType read from the labels.
LongitudeDirection p_longitudeDirection
 An enumerated type indicating the LongitudeDirection read from the labels.
int p_longitudeDomain
 This integer is either 180 or 360 and is read from the labels.
double p_equatorialRadius
 Polar radius of the target.
double p_polarRadius
 Polar radius of the target.
double p_eccentricity
 Planet Eccentricity.
bool p_sky
 Indicates whether projection is sky or land.
bool p_groundRangeGood
 Indicates if the ground range (min/max lat/lons) were read from the labels.
double p_minimumLatitude
 Contains the minimum latitude for the entire ground range.
double p_maximumLatitude
 Contains the maximum latitude for the entire ground range.
double p_minimumLongitude
 Contains the minimum longitude for the entire ground range.
double p_maximumLongitude
 Contains the maximum longitude for the entire ground range.
double p_minimumX
 The data elements p_minimumX, p_minimumY, p_maximumX, and p_maximumY are convience data elements when you write the XYRange virtual function.
double p_maximumX
 See minimumX description.
double p_minimumY
 See minimumX description.
double p_maximumY
 See minimumX description.
PvlGroup p_mappingGrp
 Mapping group that created this projection.

Detailed Description

Sinusoidal Map Projection.

This class provides methods for the forward and inverse equations of a Sinusoidal Equal-Area map projection (for a sphere). The code was converted to C++ from the Fortran version of the USGS General Cartographic Transformation Package (GCTP). This class inherits Projection and provides the two virtual methods SetGround (forward) and SetCoordinate (inverse) and a third virtual method, XYRange, for obtaining projection coordinate coverage for a latitude/longitude window. Please see the Projection class for a full accounting of all the methods available.

Author:
2003-01-29 Jeff Anderson

Member Enumeration Documentation

Enumerator:
Planetographic 
Planetocentric 
Enumerator:
PositiveEast 
PositiveWest 

Constructor & Destructor Documentation

Isis::Sinusoidal::Sinusoidal ( Isis::Pvl label,
bool  allowDefaults = false 
)

Constructs a Sinusoidal object.

Parameters:
label This argument must be a Label containing the proper mapping information as indicated in the Projection class. Additionally, the sinusoidal projection requires the center longitude to be defined in the keyword CenterLongitude.
allowDefaults If set to false the constructor expects that a keyword of CenterLongitude will be in the label. Otherwise it will attempt to compute the center longitude using the middle of the longitude range specified in the labels. Defaults to false
Exceptions:
Isis::iException::Io 

References _FILEINFO_, Isis::PvlObject::FindGroup(), Isis::PvlContainer::HasKeyword(), Isis::iException::Io, Isis::iException::Message(), Isis::Projection::p_longitudeDirection, Isis::Projection::p_maximumLongitude, Isis::Projection::p_minimumLongitude, Isis::PI(), Isis::Projection::PositiveWest, and Isis::PvlObject::Traverse.

Isis::Sinusoidal::~Sinusoidal (  ) 

Destroys the Sinusoidal object.


Member Function Documentation

double Isis::Projection::e4Compute (  )  const [protected, inherited]

A convience method to compute e4 = sqrt(1+ecc)**(1+ecc)*(1-ecc)**(1-ecc)).

Returns:
double

References Isis::Projection::Eccentricity().

Referenced by Isis::PolarStereographic::PolarStereographic().

double Isis::Projection::Eccentricity (  )  const [inline, inherited]
double Isis::Projection::EquatorialRadius (  )  const [inline, inherited]

This returns the equatorial radius of the target.

The radius was obtained from the label during object construction.

Returns:
double

References Isis::Projection::p_equatorialRadius.

Referenced by Isis::Projection::operator==().

double Isis::Projection::GetX (  )  const [protected, inherited]
double Isis::Projection::GetY (  )  const [protected, inherited]
bool Isis::Projection::Has180Domain (  )  const [inline, inherited]

This indicates if the longitude domain is -180 to 180 (as opposed to 0 to 360).

The longitude domain was obtained from the label during object construction.

Returns:
bool

References Isis::Projection::p_longitudeDomain.

Referenced by Isis::MosaicSceneItem::reproject().

bool Isis::Projection::Has360Domain (  )  const [inline, inherited]

This indicates if the longitude domain is 0 to 360 (as opposed to -180 to 180).

The longitude domain was obtained from the label during object construction.

Returns:
bool

References Isis::Projection::p_longitudeDomain.

bool Isis::Projection::HasGroundRange (  )  const [inline, inherited]

This indicates that the labels contained minimum and maximum latitudes and longitudes (e.g., a ground range coverage).

If the projection has ground range coverage then the MinimumLatitude, MaximumLatitude, MinimumLongitude, and MaximumLongitude methods can be used. The ground range coverage essentially defines the area of user interest.

Returns:
bool

References Isis::Projection::p_groundRangeGood.

Referenced by Isis::ProjectionFactory::CreateForCube(), Isis::Projection::Mapping(), Isis::Projection::MappingLatitudes(), Isis::Projection::MappingLongitudes(), and Isis::ObliqueCylindrical::XYRange().

virtual bool Isis::Projection::IsEquatorialCylindrical (  )  [inline, virtual, inherited]

This method returns true if the projection is equatorial cylindrical.

In other words, if an image projected at 0 is the same as an image projected at 360.

Returns:
bool true if the projection is equatorial cylindrical

Reimplemented in Isis::Equirectangular, Isis::Mercator, and Isis::SimpleCylindrical.

Referenced by Isis::Sensor::Sensor(), Isis::Sensor::SetLookDirection(), and Isis::ProcessMapMosaic::StartProcess().

bool Isis::Projection::IsGood (  )  const [inline, inherited]

This indicates if the last invocation of SetGround, SetCoordinate, or SetUniversalGround was with successful or not.

If there was success then the Latitude, Longitude, XCoord, YCoord, UniversalLatitude, UniversalLongitude, WorldX, and WorldY methods can be utilized.

Returns:
bool

References Isis::Projection::p_good.

Referenced by Isis::ProjectionFactory::CreateForCube(), Isis::Sensor::DemRadius(), Isis::Chip::Load(), and Isis::Projection::XYRangeCheck().

bool Isis::Projection::IsPlanetocentric (  )  const [inline, inherited]
bool Isis::Projection::IsPlanetographic (  )  const [inline, inherited]

This indicates if the latitude type is planetographic (as opposed to planetocentric).

The latitude type was obtained from the label during object construction.

Returns:
bool

References Isis::Projection::p_latitudeType, and Isis::Projection::Planetographic.

bool Isis::Projection::IsPositiveEast (  )  const [inline, inherited]

This indicates if the longitude direction type is positive west (as opposed to postive east).

The longitude type was obtained from the label during object construction.

Returns:
bool

References Isis::Projection::p_longitudeDirection, and Isis::Projection::PositiveEast.

bool Isis::Projection::IsPositiveWest (  )  const [inline, inherited]

This indicates if the longitude direction type is positive east (as opposed to postive west).

The longitude type was obtained from the label during object construction.

Returns:
bool

References Isis::Projection::p_longitudeDirection, and Isis::Projection::PositiveWest.

Referenced by Isis::Projection::operator==().

bool Isis::Projection::IsSky (  )  const [inline, inherited]

Returns true if projection is sky and false if it is land.

References Isis::Projection::p_sky.

Referenced by Isis::Camera::RaDecRange(), Isis::Camera::RaDecResolution(), Isis::Camera::SetImage(), and Isis::Camera::SetRightAscensionDeclination().

double Isis::Projection::Latitude (  )  const [inline, inherited]

This returns a latitude with correct latitude type as specified in the label object.

The method can only be used if SetGround, SetCoordinate, SetUniversalGround, or SetWorld return with success. Success can also be checked using the IsGood method.

Returns:
double

References Isis::Projection::p_latitude.

Referenced by Isis::MosaicFindTool::mouseButtonRelease(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::MosaicTrackTool::updateLabels(), and Isis::PolygonTools::XYToLatLon().

string Isis::Projection::LatitudeTypeString (  )  const [inherited]

This method returns the latitude type as a string.

It will return either Planetocentric or Planetographic.

Returns:
string

References Isis::Projection::p_latitudeType, and Isis::Projection::Planetographic.

double Isis::Projection::LocalRadius ( double  latitude  )  const [inherited]

This method returns the local radius in meters at the specified latitude position.

Parameters:
latitude A latitude in degrees (assumed to be of the correct LatitudeType).
Returns:
double

References a, c, Isis::Projection::p_equatorialRadius, Isis::Projection::p_polarRadius, and Isis::PI().

double Isis::Projection::LocalRadius (  )  const [inherited]

This method returns the local radius in meters at the current latitude position.

This is only usable if the use of SetGround or SetCoordinate was successful.

Returns:
double

References Isis::Projection::p_latitude.

Referenced by Isis::ProjectionFactory::CreateForCube(), and Isis::Equirectangular::Equirectangular().

double Isis::Projection::Longitude (  )  const [inline, inherited]

This returns a longitude with correct longitude direction and domain as specified in the label object.

The method can only be used if SetGround, SetCoordinate, SetUniversalGround, or SetWorld return with success. Success can also be checked using the IsGood method.

Returns:
double

References Isis::Projection::p_longitude.

Referenced by Isis::MosaicFindTool::mouseButtonRelease(), Isis::MosaicAreaTool::mouseButtonRelease(), Isis::Camera::SetImage(), Isis::MosaicTrackTool::updateLabels(), and Isis::PolygonTools::XYToLatLon().

string Isis::Projection::LongitudeDirectionString (  )  const [inherited]

This method returns the longitude direction as a string.

It will return either PositiveEast or PositiveWest.

Returns:
string

References Isis::Projection::p_longitudeDirection, and Isis::Projection::PositiveEast.

string Isis::Projection::LongitudeDomainString (  )  const [inherited]

This method returns the longitude domain as a string.

It will return either 180 or 360.

Returns:
string

References Isis::Projection::p_longitudeDomain.

PvlGroup Isis::Sinusoidal::Mapping (  )  [virtual]

This function returns the keywords that this projection uses.

Returns:
PvlGroup The keywords that this projection uses

Reimplemented from Isis::Projection.

References Isis::Projection::p_mappingGrp.

PvlGroup Isis::Sinusoidal::MappingLatitudes (  )  [virtual]

This function returns the latitude keywords that this projection uses.

Returns:
PvlGroup The latitude keywords that this projection uses

Reimplemented from Isis::Projection.

PvlGroup Isis::Sinusoidal::MappingLongitudes (  )  [virtual]

This function returns the longitude keywords that this projection uses.

Returns:
PvlGroup The longitude keywords that this projection uses

Reimplemented from Isis::Projection.

References Isis::Projection::p_mappingGrp.

double Isis::Projection::MaximumLatitude (  )  const [inline, inherited]

This returns the maximum latitude of the area of interest.

The value was obtained from the labels during object construction. This method can only be used if HasGroundRange returns a true.

Returns:
double

References Isis::Projection::p_maximumLatitude.

Referenced by Isis::GridGraphicsItem::GridGraphicsItem(), and Isis::ObliqueCylindrical::XYRange().

double Isis::Projection::MaximumLongitude (  )  const [inline, inherited]

This returns the maximum longitude of the area of interest.

The value was obtained from the labels during object construction. This method can only be used if HasGroundRange returns a true.

Returns:
double

References Isis::Projection::p_maximumLongitude.

Referenced by Isis::GridGraphicsItem::GridGraphicsItem(), and Isis::ObliqueCylindrical::XYRange().

double Isis::Projection::mCompute ( const double  sinphi,
const double  cosphi 
) const [protected, inherited]

A convience method to compute m = cosphi/sqrt(1-(ecc*sinphi)**2).

Parameters:
sinphi sine of phi
cosphi cosine of phi
Returns:
double

References Isis::Projection::Eccentricity().

Referenced by Isis::LambertConformal::LambertConformal(), and Isis::PolarStereographic::PolarStereographic().

double Isis::Projection::MinimumLatitude (  )  const [inline, inherited]

This returns the minimum latitude of the area of interest.

The value was obtained from the labels during object construction. This method can only be used if HasGroundRange returns a true.

Returns:
double

References Isis::Projection::p_minimumLatitude.

Referenced by Isis::GridGraphicsItem::GridGraphicsItem(), and Isis::ObliqueCylindrical::XYRange().

double Isis::Projection::MinimumLongitude (  )  const [inline, inherited]

This returns the minimum longitude of the area of interest.

The value was obtained from the labels during object construction. This method can only be used if HasGroundRange returns a true.

Returns:
double

References Isis::Projection::p_minimumLongitude.

Referenced by Isis::GridGraphicsItem::GridGraphicsItem(), and Isis::ObliqueCylindrical::XYRange().

std::string Isis::Sinusoidal::Name (  )  const [inline, virtual]

Returns the name of the map projection.

Returns:
string Name of projection

Implements Isis::Projection.

bool Isis::Projection::operator!= ( const Projection proj  )  [inherited]

This method returns if two map projection objects are not equal.

That is, they have at least some differences in the radii, latitude type, longitude direction, projection name, and projection specific parameters.

Returns:
bool
bool Isis::Sinusoidal::operator== ( const Isis::Projection proj  )  [virtual]

Compares two Projection objects to see if they are equal.

Parameters:
proj Projection object to do comparison on
Returns:
bool Returns true if the Projection objects are equal, and false if they are not

Reimplemented from Isis::Projection.

double Isis::Projection::phi2Compute ( const double  t  )  const [protected, inherited]
double Isis::Projection::PolarRadius (  )  const [inline, inherited]

This returns the polar radius of the target.

The radius was obtained from the label during object construction.

Returns:
double

References Isis::Projection::p_polarRadius.

Referenced by Isis::Projection::operator==().

double Isis::Projection::Resolution (  )  const [inherited]

This method returns the resolution for mapping world coordinates into projection coordinates.

For example, if the world coordinate system is an image then this routine returns the number of meters per pixel. Likewise, if the world coordinate system is a piece of paper, it might return the number of meters per inch of paper. If the SetWorldMapper method is not invoked then this method returns 1.0

Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::Resolution().

Referenced by Isis::ProcessExport::CreateWorldFile(), and Isis::Projection::operator==().

double Isis::Projection::Rotation (  )  const [inline, inherited]

Return the rotation of the map.

Returns:
double
double Isis::Projection::Scale (  )  const [inherited]

This method returns the scale for mapping world coordinates into projection coordinates.

For example, if the world coordinate system is an image then this routine returns the number of pixels per degree. Likewise, if the world coordinate system is a piece of paper, it might return the number of inches of paper per degree. If the SetWorldMapper method is not invoked then this method returns 1.0

Returns:
double

References a, Isis::Projection::p_equatorialRadius, Isis::Projection::p_mapper, Isis::Projection::p_polarRadius, Isis::PI(), Isis::WorldMapper::Resolution(), and Isis::Projection::TrueScaleLatitude().

void Isis::Projection::SetComputedXY ( double  x,
double  y 
) [protected, inherited]
bool Isis::Sinusoidal::SetCoordinate ( const double  x,
const double  y 
) [virtual]

This method is used to set the projection x/y.

The Set forces an attempted calculation of the corresponding latitude/longitude position. This may or may not be successful and a status is returned as such.

Parameters:
x X coordinate of the projection in units that are the same as the radii in the label
y Y coordinate of the projection in units that are the same as the radii in the label
Returns:
bool

Reimplemented from Isis::Projection.

References Isis::Projection::GetX(), Isis::Projection::GetY(), Isis::HALFPI(), Isis::Projection::p_equatorialRadius, Isis::Projection::p_good, Isis::Projection::p_latitude, Isis::Projection::p_longitude, Isis::Projection::p_longitudeDirection, Isis::PI(), Isis::Projection::PositiveWest, and Isis::Projection::SetXY().

bool Isis::Sinusoidal::SetGround ( const double  lat,
const double  lon 
) [virtual]

This method is used to set the latitude/longitude (assumed to be of the correct LatitudeType, LongitudeDirection, and LongitudeDomain.

The Set forces an attempted calculation of the projection X/Y values. This may or may not be successful and a status is returned as such.

Parameters:
lat Latitude value to project
lon Longitude value to project
Returns:
bool

Reimplemented from Isis::Projection.

References Isis::Projection::p_equatorialRadius, Isis::Projection::p_good, Isis::Projection::p_latitude, Isis::Projection::p_longitude, Isis::Projection::p_longitudeDirection, Isis::PI(), Isis::Projection::PositiveWest, Isis::Projection::SetComputedXY(), x, and y.

bool Isis::Projection::SetUniversalGround ( const double  lat,
const double  lon 
) [inherited]
void Isis::Projection::SetUpperLeftCorner ( const Displacement x,
const Displacement y 
) [inherited]

This method sets the UpperLeftCornerX and UpperLeftCornerY keywords in the projection mapping group.

Parameters:
x the upper left corner x value
y the upper left corner y value
units the units the coordinates are in

References Isis::PvlContainer::AddKeyword(), Isis::Displacement::GetMeters(), and Isis::Projection::p_mappingGrp.

Referenced by Isis::ProjectionFactory::CreateForCube(), and Isis::ProjectionFactory::CreateFromCube().

bool Isis::Projection::SetWorld ( const double  worldX,
const double  worldY 
) [inherited]

This method is used to set a world coordinate.

A world coordinate is a different coordinate type that has a one-to-one mapping to the projection coordinate system. For example, mapping pixel samples and lines to projection x's and y's. The Set forces an attempted calculation of the corresponding latitude/longitude position. This may or may not be successful and a status is returned as such. Note that is only applies if the Projection object was given an WorldMapper object during construction. If an WorldMapper was not supplied then SetWorld operates exactly the same as SetCoordinate (impling that world coordinate and projection coordinate are identical).

Parameters:
worldX World X coordinate in units that are specified by the WorldMapper object (e.g., pixels, millimeters, etc)
worldY World Y coordinate in units that are specified by the WorldMapper object (e.g., pixels, millimeters, etc)
Returns:
bool

References Isis::Projection::p_mapper, Isis::WorldMapper::ProjectionX(), Isis::WorldMapper::ProjectionY(), and Isis::Projection::SetCoordinate().

Referenced by Isis::ProcessExport::CreateWorldFile(), Isis::Chip::Load(), Isis::Camera::SetImage(), Isis::SubArea::UpdateLabel(), and Isis::PolygonTools::XYToLatLon().

void Isis::Projection::SetWorldMapper ( Isis::WorldMapper mapper  )  [inline, inherited]

If desired the programmer can use this method to set a world mapper to be used in the SetWorld, WorldX, and WorldY methods.

Mappers typically transform a projection coordinate (x/y) into the desired working coordinate system, for example, cube pixels or inches on a piece of paper. They transform in both directions (world to projection and projection to world). This allows for conversions from line/sample to latitude/longitude and vice versa. This projection will take ownership of the WorldMapper pointer.

Parameters:
mapper Pointer to the mapper

References Isis::Projection::p_mapper.

Referenced by Isis::ProjectionFactory::CreateForCube(), and Isis::ProjectionFactory::CreateFromCube().

void Isis::Projection::SetXY ( double  x,
double  y 
) [protected, inherited]
PvlGroup Isis::Projection::TargetRadii ( Pvl cubeLab,
PvlGroup mapGroup 
) [static, inherited]
PvlGroup Isis::Projection::TargetRadii ( std::string  target  )  [static, inherited]

Creates a Pvl Group with keywords TargetName, EquitorialRadius, and PolarRadius.

The values for the radii will be retrieved from the most recent Target Attitude and Shape Naif kernel available in the Isis data area.

Parameters:
target The name of the body for which the radii will be retrieved.
Returns:
PvlGroup Group named "Mapping" with keywords TargetName, EquatorialRadius, and PolarRadius.

References _FILEINFO_, code, Isis::Filename::Expanded(), Isis::Filename::HighestVersion(), Isis::iException::Io, and Isis::iException::Message().

Referenced by Isis::Projection::Projection(), Isis::ControlNet::SetTarget(), Isis::Projection::TargetRadii(), and Isis::ControlNetFileV0002::ToPvl().

double Isis::Projection::tCompute ( const double  phi,
const double  sinphi 
) const [protected, inherited]

A convience method to compute: t = tan(.5*(.5PI-phi)/((1-ecc*sinphi)/(1+ecc*sinphi))**(.5*ecc).

Parameters:
phi phi
sinphi sin of phi
Returns:
double

References Isis::Projection::Eccentricity(), and Isis::HALFPI().

Referenced by Isis::LambertConformal::LambertConformal(), Isis::PolarStereographic::PolarStereographic(), Isis::PolarStereographic::SetGround(), Isis::Mercator::SetGround(), and Isis::LambertConformal::SetGround().

double Isis::Projection::To180Domain ( const double  lon  )  [static, inherited]

This method converts a longitude into the -180 to 180 domain.

It will leave the longitude unchanged if it is already in the domain.

Returns:
double
Parameters:
lon Longitude to convert into the -180 to 180 domain.

Referenced by Isis::TransverseMercator::SetCoordinate(), Isis::PolarStereographic::SetCoordinate(), Isis::PointPerspective::SetCoordinate(), Isis::Orthographic::SetCoordinate(), Isis::Projection::SetUniversalGround(), Isis::Projection::ToPositiveEast(), Isis::Projection::ToPositiveWest(), and Isis::ProcessImportPds::TranslatePdsProjection().

double Isis::Projection::To360Domain ( const double  lon  )  [static, inherited]
string Isis::Projection::ToDMS ( double  angle  )  [static, inherited]

Converts angle(in degrees) to degrees, minutes, seconds.

Outputs in the form xxx yym zz.zzzs, for example, 206.291 degrees is 206 17m 27.6s

Parameters:
angle Angle in degrees to be converted to degrees, minutes, seconds
Returns:
string Degrees, minutes, seconds
string Isis::Projection::ToHMS ( double  angle  )  [static, inherited]

Converts angle(in degrees) to hours, minutes, seconds.

Outputs in the form xxh yym zz.zzzs For example, 206.291 will be 13h 45m 09.84s

Parameters:
angle Angle in degrees to be converted to hours, minutes, seconds
Returns:
string Hours, minutes, seconds

References Isis::Projection::ToHours().

double Isis::Projection::ToHours ( double  angle  )  [static, inherited]

Converts angle(in degrees) to hours.

Parameters:
angle Angle in degrees to be converted to hours
Returns:
double

Referenced by Isis::Projection::ToHMS().

double Isis::Projection::ToPlanetocentric ( double  lat,
double  eRadius,
double  pRadius 
) [static, inherited]

This method converts a planetographic latitude to a planetocentric latitude.

Parameters:
lat Planetographic latitude to convert.
Returns:
double

References Isis::PI().

double Isis::Projection::ToPlanetocentric ( const double  lat  )  const [inherited]

This method converts a planetographic latitude to a planetocentric latitude.

It utilizes the equatorial and polar radii to perform the computation.

Parameters:
lat Planetographic latitude to convert.
Returns:
double

References Isis::Projection::p_equatorialRadius, Isis::Projection::p_polarRadius, and Isis::PI().

Referenced by Isis::TransverseMercator::SetCoordinate(), Isis::PolarStereographic::SetCoordinate(), Isis::PointPerspective::SetCoordinate(), Isis::Orthographic::SetCoordinate(), Isis::Mercator::SetCoordinate(), Isis::LunarAzimuthalEqualArea::SetCoordinate(), Isis::LambertConformal::SetCoordinate(), and Isis::Projection::UniversalLatitude().

double Isis::Projection::ToPlanetographic ( double  lat,
double  eRadius,
double  pRadius 
) [static, inherited]

This method converts a planetocentric latitude to a planetographic latitude.

It is static so that a projection object does not need to exist.

Parameters:
lat Planetocentric latitude to convert.
eRadius Equatorial radius.
pRadius Polar radius
Returns:
double

References Isis::PI().

double Isis::Projection::ToPlanetographic ( const double  lat  )  const [inherited]
double Isis::Projection::ToPositiveEast ( const double  lon,
const int  domain 
) [static, inherited]

This method converts a longitude into the positive east direction.

Returns:
double
Parameters:
lon Longitude to convert into the positive east direction.

References _FILEINFO_, Isis::iException::Message(), Isis::iException::Programmer, Isis::Projection::To180Domain(), and Isis::Projection::To360Domain().

double Isis::Projection::ToPositiveWest ( const double  lon,
const int  domain 
) [static, inherited]

This method converts a longitude into the positive west direction.

Returns:
double
Parameters:
lon Longitude to convert into the positive west direction.

References _FILEINFO_, Isis::iException::Message(), Isis::iException::Programmer, Isis::Projection::To180Domain(), and Isis::Projection::To360Domain().

double Isis::Projection::ToProjectionX ( const double  worldX  )  const [inherited]

This method converts a world x value to a projection x value.

For example, if the world coordinate system is an image then this method converts a sample position to a projection x value. Note that if SetWorldMapper is not used then this routine simply returns the value of the argument. That is, no mapping occurs.

Parameters:
worldX World x coordinate
Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::ProjectionX().

Referenced by Isis::OverlapStatistics::OverlapStatistics(), and Isis::ProcessMapMosaic::StartProcess().

double Isis::Projection::ToProjectionY ( const double  worldY  )  const [inherited]

This method converts a world y value to a projection y value.

For example, if the world coordinate system is an image then this method converts a line position to a projection y value. Note that if SetWorldMapper is not used then this routine simply returns the value of the argument. That is, no mapping occurs.

Parameters:
worldY World y coordinate
Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::ProjectionY().

Referenced by Isis::OverlapStatistics::OverlapStatistics(), and Isis::ProcessMapMosaic::StartProcess().

double Isis::Projection::ToWorldX ( const double  projectionX  )  const [inherited]

This method converts a projection x value to a world x value.

For example, if the world coordinate system is an image then this method converts a projection x to a sample position. Note that if SetWorldMapper is not used then this routine simply returns the value of the argument. That is, no mapping occurs.

Parameters:
projectionX Projection x value in meters
Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::WorldX().

Referenced by Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

double Isis::Projection::ToWorldY ( const double  projectionY  )  const [inherited]

This method converts a projection y value to a world y value.

For example, if the world coordinate system is an image then this method converts a projection y to a line position. Note that if SetWorldMapper is not used then this routine simply returns the value of the argument. That is, no mapping occurs.

Parameters:
projectionY Projection y value in meters
Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::WorldY().

Referenced by Isis::OverlapStatistics::OverlapStatistics(), Isis::ProcessMapMosaic::SetOutputCube(), and Isis::ProcessMapMosaic::StartProcess().

double Isis::Projection::TrueScaleLatitude (  )  const [virtual, inherited]

This method returns the latitude of true scale.

It is a virtual function and if it is not overriden the latitude of true scale is 0. Otherwise it is projection specific.For example, the center latitude for Mercator, Equidistant, or a parallel for conic projections. This method is used by the Scale routine to ensure the local radius is used in the computation.

Returns:
double

Reimplemented in Isis::Equirectangular, Isis::LambertConformal, Isis::Mercator, Isis::Orthographic, Isis::PointPerspective, and Isis::PolarStereographic.

Referenced by Isis::ProjectionFactory::CreateForCube(), and Isis::Projection::Scale().

double Isis::Projection::UniversalLatitude (  )  [inherited]

This returns a universal latitude (planetocentric).

The method can only be used if SetGround, SetCoordinate, SetUniversalGround, or SetWorld return with success. Success can also be checked using the IsGood method.

Returns:
double

References Isis::Projection::p_latitude, Isis::Projection::p_latitudeType, Isis::Projection::Planetographic, and Isis::Projection::ToPlanetocentric().

Referenced by Isis::Chip::Load(), and Isis::Camera::SetImage().

double Isis::Projection::UniversalLongitude (  )  [inherited]

This returns a universal longitude (positive east in 0 to 360 domain).

The method can only be used if SetGround, SetCoordinate, SetUniversalGround, or SetWorld return with success. Success can also be checked using the IsGood method.

Returns:
double

References Isis::Projection::p_longitude, Isis::Projection::p_longitudeDirection, Isis::Projection::PositiveWest, and Isis::Projection::To360Domain().

Referenced by Isis::Chip::Load(), and Isis::Camera::SetImage().

std::string Isis::Sinusoidal::Version (  )  const [inline, virtual]

Returns the version of the map projection.

Returns:
std::string Version number

Implements Isis::Projection.

double Isis::Projection::WorldX (  )  const [inherited]

This returns the world X coordinate provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.

Success can also be checked using the IsGood method. The units of X will be in the units as specified by the WorldMapper object which was given to the SetWorldMapper method. If a mapper object was not given then world coordinates are the same as the projection coordinates (i.e., WorldX and XCoord will return the same value).

Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::WorldX().

Referenced by Isis::Sensor::DemRadius(), Isis::Chip::Load(), Isis::Camera::SetRightAscensionDeclination(), and Isis::ProcessMapMosaic::StartProcess().

double Isis::Projection::WorldY (  )  const [inherited]

This returns the world Y coordinate provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.

Success can also be checked using the IsGood method. The units of Y will be in the units as specified by the WorldMapper object which was given to the SetWorldMapper. If a mapper object was not given then world coordinates are the same as the projection coordinates (i.e., WorldY and YCoord will return the same value).

Returns:
double

References Isis::Projection::p_mapper, and Isis::WorldMapper::WorldY().

Referenced by Isis::Sensor::DemRadius(), Isis::Chip::Load(), and Isis::Camera::SetRightAscensionDeclination().

double Isis::Projection::XCoord (  )  const [inline, inherited]

This returns the projection X provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.

Success can also be checked using the IsGood method. The units of X will be in the same . units as the radii obtained from the label.

Returns:
double

Referenced by Isis::ProjectionFactory::CreateForCube(), Isis::ProcessExport::CreateWorldFile(), Isis::MosaicFindTool::getUserGroundPoint(), Isis::GridGraphicsItem::GridGraphicsItem(), Isis::PolygonTools::LatLonToXY(), Isis::MosaicSceneItem::reproject(), Isis::SubArea::UpdateLabel(), Isis::MosaicAreaTool::userChangedBox(), and Isis::LambertConformal::XYRange().

bool Isis::Sinusoidal::XYRange ( double &  minX,
double &  maxX,
double &  minY,
double &  maxY 
) [virtual]

This method is used to determine the x/y range which completely covers the area of interest specified by the lat/lon range.

The latitude/longitude range may be obtained from the labels. The purpose of this method is to return the x/y range so it can be used to compute how large a map may need to be. For example, how big a piece of paper is needed or how large of an image needs to be created. The method may fail as indicated by its return value.

Parameters:
minX Minimum x projection coordinate which covers the latitude longitude range specified in the labels.
maxX Maximum x projection coordinate which covers the latitude longitude range specified in the labels.
minY Minimum y projection coordinate which covers the latitude longitude range specified in the labels.
maxY Maximum y projection coordinate which covers the latitude longitude range specified in the labels.
Returns:
bool

Reimplemented from Isis::Projection.

References Isis::Projection::p_maximumLatitude, Isis::Projection::p_maximumLongitude, Isis::Projection::p_maximumX, Isis::Projection::p_maximumY, Isis::Projection::p_minimumLatitude, Isis::Projection::p_minimumLongitude, Isis::Projection::p_minimumX, Isis::Projection::p_minimumY, and Isis::Projection::XYRangeCheck().

void Isis::Projection::XYRangeCheck ( const double  latitude,
const double  longitude 
) [protected, inherited]

This convience function is established to assist in the development of the XYRange virtual method.

It allows the developer to test ground points (lat/lon) to see if they produce a minimum/maximum projection coordinate. For example in Sinusoidal,

       bool Sinusoidal::XYRange(double &minX, double &maxX,
                                    double &minY, double &maxY) {
        // Check the corners of the lat/lon range
         XYRangeCheck (p_minimumLatitude,p_minimumLongitude);
         XYRangeCheck (p_maximumLatitude,p_minimumLongitude);
         XYRangeCheck (p_minimumLatitude,p_maximumLongitude);
         XYRangeCheck (p_maximumLatitude,p_maximumLongitude);

         // If the latitude crosses the equator check there
         if ((p_minimumLatitude < 0.0) && (p_maximumLatitude > 0.0)) {
           XYRangeCheck (0.0,p_minimumLongitude);
           XYRangeCheck (0.0,p_maximumLongitude);
         }

         // Make sure everything is ordered
         if (p_minimumX >= p_maximumX) return false;
         if (p_minimumY >= p_maximumY) return false;

         // Return X/Y min/maxs
         minX = p_minimumX;
         maxX = p_maximumX;
         minY = p_minimumY;
         maxY = p_maximumY;
         return true;
      }
Parameters:
latitude Test for min/max projection coordinates at this latitude
longitude Test for min/max projection coordinates at this longitude

References Isis::Projection::IsGood(), Isis::Projection::p_maximumX, Isis::Projection::p_maximumY, Isis::Projection::p_minimumX, Isis::Projection::p_minimumY, and Isis::Projection::SetGround().

Referenced by Isis::TransverseMercator::XYRange(), XYRange(), Isis::SimpleCylindrical::XYRange(), Isis::PolarStereographic::XYRange(), Isis::PointPerspective::XYRange(), Isis::Orthographic::XYRange(), Isis::Mercator::XYRange(), Isis::LunarAzimuthalEqualArea::XYRange(), Isis::LambertConformal::XYRange(), and Isis::Equirectangular::XYRange().

double Isis::Projection::YCoord (  )  const [inline, inherited]

This returns the projection Y provided SetGround, SetCoordinate, SetUniversalGround, or SetWorld returned with success.

Success can also be checked using the IsGood method. The units of Y will be in the same units as the radii obtained from the label.

Returns:
double

Referenced by Isis::ProjectionFactory::CreateForCube(), Isis::ProcessExport::CreateWorldFile(), Isis::MosaicFindTool::getUserGroundPoint(), Isis::GridGraphicsItem::GridGraphicsItem(), Isis::PolygonTools::LatLonToXY(), Isis::MosaicSceneItem::reproject(), Isis::SubArea::UpdateLabel(), Isis::MosaicAreaTool::userChangedBox(), and Isis::LambertConformal::XYRange().


Member Data Documentation

double Isis::Projection::p_eccentricity [protected, inherited]

Planet Eccentricity.

Referenced by Isis::Projection::Eccentricity(), and Isis::Projection::Projection().

double Isis::Projection::p_equatorialRadius [protected, inherited]
bool Isis::Projection::p_good [protected, inherited]
bool Isis::Projection::p_groundRangeGood [protected, inherited]

Indicates if the ground range (min/max lat/lons) were read from the labels.

Referenced by Isis::Projection::HasGroundRange(), Isis::Projection::Projection(), and Isis::Projection::XYRange().

double Isis::Projection::p_latitude [protected, inherited]

An enumerated type indicating the LatitudeType read from the labels.

It can be either Planetographic or Planetocentric.

Referenced by Isis::Projection::IsPlanetocentric(), Isis::Projection::IsPlanetographic(), Isis::Projection::LatitudeTypeString(), Isis::Projection::Projection(), Isis::Projection::SetUniversalGround(), and Isis::Projection::UniversalLatitude().

double Isis::Projection::p_longitude [protected, inherited]

An enumerated type indicating the LongitudeDirection read from the labels.

It can be either PositiveEast or PositiveWest.Indicating which direction the positive axis for longitude is.

Referenced by Isis::Equirectangular::Equirectangular(), Isis::Projection::IsPositiveEast(), Isis::Projection::IsPositiveWest(), Isis::LambertConformal::LambertConformal(), Isis::Projection::LongitudeDirectionString(), Isis::Mercator::Mercator(), Isis::Orthographic::Orthographic(), Isis::PointPerspective::PointPerspective(), Isis::PolarStereographic::PolarStereographic(), Isis::Projection::Projection(), Isis::TransverseMercator::SetCoordinate(), SetCoordinate(), Isis::SimpleCylindrical::SetCoordinate(), Isis::PolarStereographic::SetCoordinate(), Isis::PointPerspective::SetCoordinate(), Isis::Orthographic::SetCoordinate(), Isis::ObliqueCylindrical::SetCoordinate(), Isis::Mercator::SetCoordinate(), Isis::LambertConformal::SetCoordinate(), Isis::Equirectangular::SetCoordinate(), Isis::TransverseMercator::SetGround(), SetGround(), Isis::SimpleCylindrical::SetGround(), Isis::PolarStereographic::SetGround(), Isis::PointPerspective::SetGround(), Isis::Orthographic::SetGround(), Isis::ObliqueCylindrical::SetGround(), Isis::Mercator::SetGround(), Isis::LunarAzimuthalEqualArea::SetGround(), Isis::LambertConformal::SetGround(), Isis::Equirectangular::SetGround(), Isis::Projection::SetUniversalGround(), Isis::SimpleCylindrical::SimpleCylindrical(), Sinusoidal(), Isis::TransverseMercator::TransverseMercator(), Isis::Projection::UniversalLongitude(), Isis::PolarStereographic::XYRange(), and Isis::LambertConformal::XYRange().

int Isis::Projection::p_longitudeDomain [protected, inherited]

This points to a mapper passed into the SetWorldMapper method.

This mapper allows the programmer to specify a different world coordinate system. Thus the programmer could pass in line/sample positions in order to obtain a latitude/longitude or set a lat/lon and get a line/sample.

Referenced by Isis::Projection::Projection(), Isis::Projection::Resolution(), Isis::Projection::Scale(), Isis::Projection::SetWorld(), Isis::Projection::SetWorldMapper(), Isis::Projection::ToProjectionX(), Isis::Projection::ToProjectionY(), Isis::Projection::ToWorldX(), Isis::Projection::ToWorldY(), Isis::Projection::WorldX(), Isis::Projection::WorldY(), and Isis::Projection::~Projection().

PvlGroup Isis::Projection::p_mappingGrp [protected, inherited]
double Isis::Projection::p_maximumLatitude [protected, inherited]
double Isis::Projection::p_maximumLongitude [protected, inherited]
double Isis::Projection::p_maximumX [protected, inherited]
double Isis::Projection::p_maximumY [protected, inherited]
double Isis::Projection::p_minimumLatitude [protected, inherited]
double Isis::Projection::p_minimumLongitude [protected, inherited]
double Isis::Projection::p_minimumX [protected, inherited]

The data elements p_minimumX, p_minimumY, p_maximumX, and p_maximumY are convience data elements when you write the XYRange virtual function.

They are used in conjuction with the XYRangeCheck convience method. After utilizing XYRangeCheck to test boundary conditions in the XYRange method these values will contain the projection x/y coverage for the ground range specified by min/max lat/lon.

Referenced by Isis::Projection::Projection(), Isis::TransverseMercator::XYRange(), XYRange(), Isis::SimpleCylindrical::XYRange(), Isis::PolarStereographic::XYRange(), Isis::PointPerspective::XYRange(), Isis::Orthographic::XYRange(), Isis::ObliqueCylindrical::XYRange(), Isis::Mercator::XYRange(), Isis::LunarAzimuthalEqualArea::XYRange(), Isis::LambertConformal::XYRange(), Isis::Equirectangular::XYRange(), and Isis::Projection::XYRangeCheck().

double Isis::Projection::p_minimumY [protected, inherited]
double Isis::Projection::p_polarRadius [protected, inherited]

Polar radius of the target.

This is a unitless value so that if the radius are in inches then the p_x and p_y will be in inches. Of course the units must be the same as the equatorial radius. The value is read from the labels.

Referenced by Isis::Projection::LocalRadius(), Isis::Projection::PolarRadius(), Isis::Projection::Projection(), Isis::Projection::Scale(), Isis::Projection::ToPlanetocentric(), and Isis::Projection::ToPlanetographic().

bool Isis::Projection::p_sky [protected, inherited]

Indicates whether projection is sky or land.

Referenced by Isis::Projection::IsSky(), and Isis::Projection::Projection().


The documentation for this class was generated from the following files: