prajna.data

Class GeoCoord

java.lang.Object

prajna.data.GeoCoord

All Implemented Interfaces:

java.io.Serializable

public class GeoCoord
extends java.lang.Object
implements java.io.Serializable

Simple class for representing a coordinate with Latitude, Longitude and Altitude. Internal coordinates are in radians and earth radii to minimize conversions and computations needed during projections.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeoCoord(double latitude, double longitude) Constructor - sets the latitude and longitude.
GeoCoord(double latitude, double longitude, double altitude) Constructor - sets the latitude, longitude, and altitude.
GeoCoord(java.lang.String latLonStr) Constructor, accepting DDMMSS-formatted String with the two coordinates separated by a space or slash.
GeoCoord(java.lang.String latString, java.lang.String lonString) Constructor, with two DDMMSS-formatted strings.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determine if a particular object is equal to this GeoCoord.
double	getAltitude() Gets the altitude, in meters
double	getAzimuth(GeoCoord targetPoint) Returns the azimuth, measured from true north, to the targetPoint.
GeoCoord	getBearingPoint(double distance, double azimuth) returns a new GeoCoord at the specified distance and azimuth from this GeoCoord.
GeoCoord	getBearingPointRadians(double dist, double azi) returns a new GeoCoord at the specified distance and azimuth from this GeoCoord.
double	getDistance(GeoCoord targetPoint) Returns the distance from this coordinate to the targetPoint.
double	getDistanceRadians(GeoCoord targetPoint) Returns the distance from this coordinate to the targetPoint.
double	getLatitude() Returns the latitude (in degrees)
double	getLatRadians() Returns the latitude in radians
java.lang.String	getLatString() Returns the Latitude of this coordinate in DDMMSS format, with either N or S appended.
double	getLongitude() Returns the longitude (in degrees)
double	getLonRadians() Returns the longitude in degrees
java.lang.String	getLonString() Returns the Longitude of this coordinate in DDDMMSS format, with either E or W appended.
int	hashCode() Returns a hash code value for the object.
void	setAltitude(double altitude) Set the altitude of this GeoCoord.
void	setAltitude(Measure altitude) Set the altitude of this GeoCoord using a linear measurement
java.lang.String	toString() Return a string representation of this coordiante.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GeoCoord

public GeoCoord(double latitude,
        double longitude)

Constructor - sets the latitude and longitude. Values should be in decimal degrees.

Parameters:

latitude - the latitude of the coordinate

longitude - the longitude of the coordinate

GeoCoord

public GeoCoord(double latitude,
        double longitude,
        double altitude)

Constructor - sets the latitude, longitude, and altitude. Values should be in decimal degrees, and altitude should be in meters

Parameters:

latitude - the latitude of the coordinate

longitude - the longitude of the coordinate

altitude - the altitude of the coordinate

GeoCoord

public GeoCoord(java.lang.String latLonStr)

Constructor, accepting DDMMSS-formatted String with the two coordinates separated by a space or slash. This constructor also accepts decimal degrees separated by a comma. For instance, the string 123456N 1352457W is a valid coordinate, as is 12.4567,-135.7897.

Parameters:

latLonStr - a latitude/longitude string, in either DDMMSS format or in decimal degrees

GeoCoord

public GeoCoord(java.lang.String latString,
        java.lang.String lonString)

Constructor, with two DDMMSS-formatted strings. This constructor also handles decimal degree strings

Parameters:

latString - a string representing the latitude

lonString - a string representing the longitude

Method Detail

equals

public boolean equals(java.lang.Object obj)

Determine if a particular object is equal to this GeoCoord. Two coordinates are equal if their latitude, longitude and altitude are equal

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare

getAltitude

public double getAltitude()

Gets the altitude, in meters

Returns:

the altitude, in meters.

getAzimuth

public double getAzimuth(GeoCoord targetPoint)

Returns the azimuth, measured from true north, to the targetPoint. The returned value is in degrees

Parameters:

targetPoint - the coordinate to find the azimuth to

Returns:

the azimuth from true north, in degrees

getBearingPoint

public GeoCoord getBearingPoint(double distance,
                       double azimuth)

returns a new GeoCoord at the specified distance and azimuth from this GeoCoord.

Parameters:

distance - the distance, in meters, to the target point

azimuth - the azimuth to the target point, in degrees

Returns:

a new GeoCoord

getBearingPointRadians

public GeoCoord getBearingPointRadians(double dist,
                              double azi)

returns a new GeoCoord at the specified distance and azimuth from this GeoCoord. This method takes radian measure for the distance and azimuth.

Parameters:

dist - the distance, in radians, to the target point

azi - the azimuth to the target point, in radians

Returns:

a new GeoCoord

getDistance

public double getDistance(GeoCoord targetPoint)

Returns the distance from this coordinate to the targetPoint. Distance is returned in meters, using a standard earth radius of 6378137 meters.

Parameters:

targetPoint - the coordinate to find the distance to

Returns:

the distance, in meters

getDistanceRadians

public double getDistanceRadians(GeoCoord targetPoint)

Returns the distance from this coordinate to the targetPoint. Distance is returned in radians (or earth radii). Use this distance calculation if using a non-standard geoid, or if the calculations are for another planetary body. To convert to linear distance, multiply the result of this method by the body's radius.

Parameters:

targetPoint - the coordinate to find the distance to

Returns:

the distance, measured in earth radii

getLatitude

public double getLatitude()

Returns the latitude (in degrees)

Returns:

the latitude

getLatRadians

public double getLatRadians()

Returns the latitude in radians

Returns:

the latitude in radians

getLatString

public java.lang.String getLatString()

Returns the Latitude of this coordinate in DDMMSS format, with either N or S appended. For instance, the coordinate 30 degrees, 15 minutes 7 seconds North would be returned as 301507N

Returns:

The latitude string in DDMMSS format

getLongitude

public double getLongitude()

Returns the longitude (in degrees)

Returns:

the longitude

getLonRadians

public double getLonRadians()

Returns the longitude in degrees

Returns:

the longitude in degrees

getLonString

public java.lang.String getLonString()

Returns the Longitude of this coordinate in DDDMMSS format, with either E or W appended. For instance, the coordinate 30 degrees, 15 minutes 7 seconds West would be returned as 301507W

Returns:

The latitude string in DDMMSS format

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

setAltitude

public void setAltitude(double altitude)

Set the altitude of this GeoCoord. The altitude is in Meters

Parameters:

altitude - the altitude, in meters

setAltitude

public void setAltitude(Measure altitude)

Set the altitude of this GeoCoord using a linear measurement

Parameters:

altitude - the altitude in any unit

toString

public java.lang.String toString()

Return a string representation of this coordiante. This returns a DDMMSS formatted string, separated by spaces. The altitude, if non-zero, is appended in meters.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this coordinate