JNISpice
version 2.0.0

spice.basic
Class PlanetographicCoordinates

java.lang.Object
  extended by spice.basic.Coordinates
      extended by spice.basic.PlanetographicCoordinates

public class PlanetographicCoordinates
extends Coordinates

Class PlanetographicCoordinates represents sets of coordinates expressed in the planetographic system: positions are specified by longitude, latitude, and altitude.

Planetographic coordinates are defined using a reference spheroid. The spheroid may be oblate, prolate, or a sphere.

By default, for objects other than the Earth, Moon, and Sun, planetographic longitude is defined such that, for a distant, fixed observer, the sub-observer point's longitude increases with time. For the Earth, Moon and Sun, longitude is positive East by default. The default sense of planetographic longitude for a given body can be overridden via kernel pool assignments; see Particulars for details.

Planetographic latitude of a point is the angle between the X-Y plane and the line normal to the reference spheroid that passes through the point and the closest point on the reference spheroid to the point.

Version 1.0.0 28-NOV-2009 (NJB)


Field Summary
 
Fields inherited from class spice.basic.Coordinates
ALTITUDE, COLATITUDE, CYLINDRICAL, DECLINATION, GEODETIC, LATITUDE, LATITUDINAL, LONGITUDE, PLANETOGRAPHIC, RA, RADEC, RADIUS, RANGE, RECTANGULAR, SPHERICAL, X, Y, Z
 
Constructor Summary
PlanetographicCoordinates()
          No-arguments constructor.
PlanetographicCoordinates(Body body, double longitude, double latitude, double altitude, double re, double f)
          Construct a PlanetographicCoordinates instance from a Body, an equatorial radius, flattening coefficient, altitude, longitude, and latitude.
PlanetographicCoordinates(Body body, Vector3 v, double re, double f)
          Construct a PlanetographicCoordinates instance from a Body, a 3-vector, and reference spheroid parameters.
PlanetographicCoordinates(PlanetographicCoordinates coords)
          Copy constructor.
 
Method Summary
 double getAltitude()
          Return altitude.
 Body getBody()
          Return central body with with this coordinate instance is associated.
 double getEquatorialRadius()
          Return the equatorial radius of the reference spheroid.
 double getFlatteningCoefficient()
          Return the flattening coefficient of the reference spheroid.
 double getLatitude()
          Return latitude in radians.
 double getLongitude()
          Return longitude in radians.
 Matrix33 getPgrRecJacobian()
          Return the Jacobian matrix of the planetographic-to-rectangular coordinate transformation at the point specified by this instance.
static Matrix33 getRecPgrJacobian(Body body, Vector3 v, double re, double f)
          Return the Jacobian matrix of the rectangular-to-planetographic coordinate transformation at the point specified by a Body, a 3-vector and reference spheroid parameters.
 Vector3 toRectangular()
          Convert this instance to rectangular coordinates.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PlanetographicCoordinates

public PlanetographicCoordinates()
No-arguments constructor.


PlanetographicCoordinates

public PlanetographicCoordinates(PlanetographicCoordinates coords)
                          throws SpiceException
Copy constructor.

This method creates a deep copy.

Throws:
SpiceException

PlanetographicCoordinates

public PlanetographicCoordinates(Body body,
                                 double longitude,
                                 double latitude,
                                 double altitude,
                                 double re,
                                 double f)
                          throws SpiceException
Construct a PlanetographicCoordinates instance from a Body, an equatorial radius, flattening coefficient, altitude, longitude, and latitude. Angular units are radians.

Throws:
SpiceException

PlanetographicCoordinates

public PlanetographicCoordinates(Body body,
                                 Vector3 v,
                                 double re,
                                 double f)
                          throws SpiceException
Construct a PlanetographicCoordinates instance from a Body, a 3-vector, and reference spheroid parameters.

Throws:
SpiceException
Method Detail

getBody

public Body getBody()
             throws SpiceException
Return central body with with this coordinate instance is associated.

Throws:
SpiceException

getLongitude

public double getLongitude()
Return longitude in radians.


getLatitude

public double getLatitude()
Return latitude in radians.


getAltitude

public double getAltitude()
Return altitude.


getEquatorialRadius

public double getEquatorialRadius()
Return the equatorial radius of the reference spheroid.


getFlatteningCoefficient

public double getFlatteningCoefficient()
Return the flattening coefficient of the reference spheroid.


toRectangular

public Vector3 toRectangular()
                      throws SpiceException
Convert this instance to rectangular coordinates.

Specified by:
toRectangular in class Coordinates
Throws:
SpiceException

getPgrRecJacobian

public Matrix33 getPgrRecJacobian()
                           throws SpiceException
Return the Jacobian matrix of the planetographic-to-rectangular coordinate transformation at the point specified by this instance.

Throws:
SpiceException

getRecPgrJacobian

public static Matrix33 getRecPgrJacobian(Body body,
                                         Vector3 v,
                                         double re,
                                         double f)
                                  throws SpiceException
Return the Jacobian matrix of the rectangular-to-planetographic coordinate transformation at the point specified by a Body, a 3-vector and reference spheroid parameters.

Throws:
SpiceException

JNISpice
version 2.0.0

JNISpice Alpha Test Version 2.0.0 28-JAN-2017 (NJB)