EarthVector (GeoWave STANAG4676 Format 1.0.0 API)

java.lang.Object
- org.locationtech.geowave.format.stanag4676.parser.util.EarthVector

```
public class EarthVector
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`CEKM`
`static int`	`DEGREES`
`static double`	`DPR`
`static double`	`EARTH_FLATTENING`
`static double`	`EARTH_ROT_RATE`
`static double`	`ECF_EPSILON`
`protected javax.vecmath.Vector3d`	`ecfVector`
`protected double`	`elevation`
`static double`	`FLAT_COEFF1`
`static double`	`FLAT_COEFF2`
`static double`	`FLATTENING_FACTOR`
`static double`	`FTperKM`
`static double`	`FTperSM`
`static double`	`G`
`static double`	`GM`
`static double`	`INperKM`
`static double`	`J2`
`static double`	`J3`
`static double`	`J4`
`static double`	`J5`
`static double`	`KMperDegree`
`static double`	`KMperNM`
`static double`	`KMperSM`
`protected double`	`latitude`
`protected double`	`longitude`
`static double`	`NMperDegree`
`protected boolean`	`oblate`
`static double`	`POLAR_RENM`
`static double`	`RAD_1`
`static double`	`RAD_180`
`static double`	`RAD_270`
`static double`	`RAD_360`
`static double`	`RAD_45`
`static double`	`RAD_90`
`static int`	`RADIANS`
`static double`	`REKM`
`static double`	`RENM`
`static int`	`SEC_180`
`static int`	`SEC_270`
`static int`	`SEC_360`
`static int`	`SEC_90`
`static double`	`SMperKM`
`static double`	`X_EPSILON`
`static double`	`Y_EPSILON`
`static double`	`YDperKM`

Constructor Summary

Constructors
Constructor and Description
`EarthVector()` Default constructor
`EarthVector(double inlat, double inlon)` lat/long (radians) constructor
`EarthVector(double inlat, double inlon, double inelev)` lat/long/elev (radians) constructor
`EarthVector(double inlat, double inlon, double inelev, int units)` lat/long/elev (radians or degrees) constructor
`EarthVector(double inlat, double inlon, int units)` lat/long (radians or degrees) constructor
`EarthVector(EarthVector loc)` EarthVector (copy) constructor
`EarthVector(javax.vecmath.Point2d point)` Point2d (radians) constructor
`EarthVector(javax.vecmath.Point2d point, double inelev)` Point2d/elev (radians) constructor
`EarthVector(javax.vecmath.Point2d point, double inelev, int units)` Point2d/elev (degrees or radians) constructor
`EarthVector(javax.vecmath.Point2d point, int units)` Point2d (degrees or radians) constructor
`EarthVector(javax.vecmath.Vector3d vec)` Vector3d (ECF or unit vector) constructor If vector is ECF, elevation is derived from it Otherwise, elevation is zero
`EarthVector(javax.vecmath.Vector3d vec, double inelev)` Vector3d (unit vector)/elev constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static double`	`degreestoKM(double distDeg, double latDeg)`
`static double`	`degToRad(double deg)` Convert degrees to radians
`boolean`	`epsilonEquals(EarthVector otherEv, double epsilon)` equals - compare ecf position (x,y,z) for equality with an epsilon value
`boolean`	`equals(Object obj)` equals - compare ecf position (x,y,z) for equality
`EarthVector`	`findPoint(double distanceKM, double azimuth)` Locate a coordinate at a specific distance (km) and heading (radians) from this one.
`EarthVector`	`findPoint(double distanceKM, double azimuth, double elevAngle)` Locate a coordinate at a specific distance (km), elevation angle (radians), and heading (radians) from this one.
`EarthVector`	`findPoint(EarthVector nextCoord, double fraction)` Locate a coordinate on the line between this one and the "next" coord, at some fraction of the distance between them
`EarthVector`	`findPointReverseDirection(EarthVector nextCoord, double fraction)`
`static EarthVector`	`fromDegrees(double lat, double lon)` Factory methods
`double`	`getAzimuth(EarthVector loc)` Compute the azimuth (in radians) from this coord to the input coord
`double`	`getDistance(EarthVector loc)` Compute the distance (km) from this coord to the input coord using vector math (my personal favorite)
`double`	`getDistanceReverseDirection(EarthVector loc)` Compute the distance (km) from this coord to the input coord using vector math (my personal favorite)
`double`	`getEarthRadiusKM()` Retrieve the radius of the earth (km) at this coordinate's latitude
`static double`	`getEarthRadiusKM(double lat, boolean flat)` Retrieve the radius of the earth (km) statically for the given latitude
`double`	`getElevation()` Get the elevation (km)
`double`	`getLatitude()` Get the latitude (radians)
`double`	`getLatitude(int units)` Get the latitude (degrees or radians)
`double`	`getLongitude()` Get the longitude (radians)
`double`	`getLongitude(int units)` Get the longitude (degrees or radians)
`javax.vecmath.Vector3d`	`getNormalizedEarthTangentVector(double azimuth)`
`int`	`getNumGreatCircleSegments(EarthVector endpoint, double segmentLengthKM)`
`int`	`getNumGreatCircleSegments(EarthVector endpoint, double segmentLengthKM, boolean reverseDirection)`
`javax.vecmath.Point2d`	`getPoint2d()`
`double`	`getRadius()` Compute the radius (km) from the origin to this coord
`double`	`getSphereDistance(EarthVector loc)` Compute the distance (km) from this coord to the input coord using trigonometry.
`javax.vecmath.Vector3d`	`getUnitVector()` Normalize the ECF vector
`javax.vecmath.Vector3d`	`getVector()` Return the ECF vector
`javax.vecmath.Vector3d`	`getVector(EarthVector loc)` Compute the vector from this coord to the input coord
`double`	`getVectorDistanceKMSq(EarthVector loc)`
`double`	`getX()` Get the x coordinate of the ECF vector (km)
`double`	`getY()` Get the y coordinate of the ECF vector (km)
`double`	`getZ()` Get the z coordinate of the ECF vector (km)
`int`	`hashCode()`
`protected void`	`initVector()` Initialize the internal ECF vector from radian lat/long
`boolean`	`isOblate()`
`double`	`kmPerDegree()` Retrieve the number of kilometers per degree for this coord's latitude
`static double`	`kmPerDegree(double lat)` Retrieve the number of kilometers per degree at the given latitude
`double`	`kmToDegrees(double distKM)`
`static double`	`kmToDegrees(double distKM, double latDeg)`
`static double`	`KMToNM(double km)` Convert kilometers to nautical miles
`double`	`kmToRadians(double distKM)`
`static double`	`kmToRadians(double distKM, double latRad)`
`static double`	`KMToSM(double km)` Convert kilometers to statute miles
`EarthVector[]`	`makeGreatCircle(EarthVector endpoint)` Create a great circle from this point to an endpoint
`EarthVector[]`	`makeGreatCircleNumSegments(EarthVector endpoint, int segments)`
`EarthVector[]`	`makeGreatCircleNumSegments(EarthVector endpoint, int segments, boolean reverseDirection)`
`EarthVector[]`	`makeGreatCircleSegmentLength(EarthVector endpoint, double segmentLengthKM)`
`EarthVector[]`	`makeGreatCircleSegmentLengthReverseDirection(EarthVector endpoint, double segmentLengthKM)`
`EarthVector[]`	`makeInterpolatedLineNumSegments(EarthVector endpoint, int segments)`
`EarthVector[]`	`makeInterpolatedLineNumSegments(EarthVector endpoint, int segments, boolean reverseDirection)`
`EarthVector[]`	`makeInterpolatedLineSegmentLength(EarthVector endpoint, double segmentLengthKM)`
`EarthVector[]`	`makeInterpolatedLineSegmentLength(EarthVector endpoint, double segmentLengthKM, boolean reverseDirection)`
`static double`	`NMToKM(double nm)` Convert nautical miles to kilometers
`static double`	`normalizeLatitude(double lat)`
`static double`	`normalizeLongitude(double lon)`
`static double`	`radianstoKM(double distRad, double latRad)`
`static double`	`radToDeg(double rad)` Convert radians to degrees
`javax.vecmath.Vector3d`	`rotate(javax.vecmath.Vector3d rotAxis, double angle)` Rotates this coordinate about the input vector through the input angle (radians - because we usually use this internally)
`void`	`setCoord(EarthVector coord)` Copy the input coordinate
`void`	`setElevation(double inelev)` Set the elevation (km)
`void`	`setLatitude(double inlat)` Set the latitude (radians)
`void`	`setLatitude(double inlat, int units)` Set the latitude (degrees or radians)
`void`	`setLongitude(double inlon)` Set the longitude (radians)
`void`	`setLongitude(double inlon, int units)` Set the longitude (degrees or radians)
`void`	`setOblate(boolean isOblate)` Set/get oblateness
`EarthVector`	`setVector(javax.vecmath.Vector3d vec)` Copy the ECF vector
`protected double`	`sign(double x)` return the sign of the argument
`static double`	`SMToKM(double sm)` Convert statute miles to kilometers
`String`	`toString()`
`static EarthVector`	`translateDegrees(double lat, double lon, javax.vecmath.Vector3d translation)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- X_EPSILON
```
public static final double X_EPSILON
```
  See Also:
  
  Constant Field Values
- Y_EPSILON
```
public static final double Y_EPSILON
```
  See Also:
  
  Constant Field Values
- ECF_EPSILON
```
public static final double ECF_EPSILON
```
  See Also:
  
  Constant Field Values
- DEGREES
```
public static final int DEGREES
```
  See Also:
  
  Constant Field Values
- RADIANS
```
public static final int RADIANS
```
  See Also:
  
  Constant Field Values
- KMperNM
```
public static final double KMperNM
```
  See Also:
  
  Constant Field Values
- KMperSM
```
public static final double KMperSM
```
  See Also:
  
  Constant Field Values
- FTperSM
```
public static final double FTperSM
```
  See Also:
  
  Constant Field Values
- SMperKM
```
public static final double SMperKM
```
  See Also:
  
  Constant Field Values
- FTperKM
```
public static final double FTperKM
```
  See Also:
  
  Constant Field Values
- INperKM
```
public static final double INperKM
```
  See Also:
  
  Constant Field Values
- YDperKM
```
public static final double YDperKM
```
  See Also:
  
  Constant Field Values
- KMperDegree
```
public static final double KMperDegree
```
  See Also:
  
  Constant Field Values
- NMperDegree
```
public static final double NMperDegree
```
  See Also:
  
  Constant Field Values
- REKM
```
public static final double REKM
```
  See Also:
  
  Constant Field Values
- CEKM
```
public static final double CEKM
```
  See Also:
  
  Constant Field Values
- RENM
```
public static final double RENM
```
  See Also:
  
  Constant Field Values
- POLAR_RENM
```
public static final double POLAR_RENM
```
  See Also:
  
  Constant Field Values
- FLATTENING_FACTOR
```
public static final double FLATTENING_FACTOR
```
  See Also:
  
  Constant Field Values
- EARTH_FLATTENING
```
public static final double EARTH_FLATTENING
```
  See Also:
  
  Constant Field Values
- FLAT_COEFF1
```
public static final double FLAT_COEFF1
```
  See Also:
  
  Constant Field Values
- FLAT_COEFF2
```
public static final double FLAT_COEFF2
```
  See Also:
  
  Constant Field Values
- DPR
```
public static final double DPR
```
  See Also:
  
  Constant Field Values
- RAD_1
```
public static final double RAD_1
```
  See Also:
  
  Constant Field Values
- RAD_45
```
public static final double RAD_45
```
  See Also:
  
  Constant Field Values
- RAD_90
```
public static final double RAD_90
```
  See Also:
  
  Constant Field Values
- RAD_180
```
public static final double RAD_180
```
  See Also:
  
  Constant Field Values
- RAD_270
```
public static final double RAD_270
```
  See Also:
  
  Constant Field Values
- RAD_360
```
public static final double RAD_360
```
  See Also:
  
  Constant Field Values
- EARTH_ROT_RATE
```
public static final double EARTH_ROT_RATE
```
  See Also:
  
  Constant Field Values
- G
```
public static final double G
```
  See Also:
  
  Constant Field Values
- GM
```
public static final double GM
```
  See Also:
  
  Constant Field Values
- J2
```
public static final double J2
```
  See Also:
  
  Constant Field Values
- J3
```
public static final double J3
```
  See Also:
  
  Constant Field Values
- J4
```
public static final double J4
```
  See Also:
  
  Constant Field Values
- J5
```
public static final double J5
```
  See Also:
  
  Constant Field Values
- SEC_90
```
public static final int SEC_90
```
  See Also:
  
  Constant Field Values
- SEC_180
```
public static final int SEC_180
```
  See Also:
  
  Constant Field Values
- SEC_270
```
public static final int SEC_270
```
  See Also:
  
  Constant Field Values
- SEC_360
```
public static final int SEC_360
```
  See Also:
  
  Constant Field Values
- latitude
```
protected double latitude
```
- longitude
```
protected double longitude
```
- elevation
```
protected double elevation
```
- ecfVector
```
protected javax.vecmath.Vector3d ecfVector
```
- oblate
```
protected boolean oblate
```

Constructor Detail

EarthVector
```
public EarthVector()
```
Default constructor

EarthVector

public EarthVector(double inlat,
                   double inlon)

lat/long (radians) constructor

EarthVector

public EarthVector(double inlat,
                   double inlon,
                   int units)

lat/long (radians or degrees) constructor

EarthVector

public EarthVector(double inlat,
                   double inlon,
                   double inelev)

lat/long/elev (radians) constructor

EarthVector

public EarthVector(double inlat,
                   double inlon,
                   double inelev,
                   int units)

lat/long/elev (radians or degrees) constructor

EarthVector

public EarthVector(javax.vecmath.Point2d point)

Point2d (radians) constructor

EarthVector

public EarthVector(javax.vecmath.Point2d point,
                   int units)

Point2d (degrees or radians) constructor

EarthVector

public EarthVector(javax.vecmath.Point2d point,
                   double inelev)

Point2d/elev (radians) constructor

EarthVector

public EarthVector(javax.vecmath.Point2d point,
                   double inelev,
                   int units)

Point2d/elev (degrees or radians) constructor

EarthVector
```
public EarthVector(javax.vecmath.Vector3d vec)
```
Vector3d (ECF or unit vector) constructor If vector is ECF, elevation is derived from it Otherwise, elevation is zero

EarthVector

public EarthVector(javax.vecmath.Vector3d vec,
                   double inelev)

Vector3d (unit vector)/elev constructor

EarthVector
```
public EarthVector(EarthVector loc)
```
EarthVector (copy) constructor

Method Detail

fromDegrees

public static EarthVector fromDegrees(double lat,
                                      double lon)

Factory methods

translateDegrees

public static EarthVector translateDegrees(double lat,
                                           double lon,
                                           javax.vecmath.Vector3d translation)

setCoord

public void setCoord(EarthVector coord)

Copy the input coordinate

epsilonEquals

public boolean epsilonEquals(EarthVector otherEv,
                             double epsilon)

equals - compare ecf position (x,y,z) for equality with an epsilon value

equals
```
public boolean equals(Object obj)
```
equals - compare ecf position (x,y,z) for equality

Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

initVector
```
protected void initVector()
```
Initialize the internal ECF vector from radian lat/long

normalizeLongitude

public static double normalizeLongitude(double lon)

normalizeLatitude

public static double normalizeLatitude(double lat)

setOblate

public void setOblate(boolean isOblate)

Set/get oblateness

isOblate
```
public boolean isOblate()
```

degToRad

public static double degToRad(double deg)

Convert degrees to radians

radToDeg

public static double radToDeg(double rad)

Convert radians to degrees

KMToNM
```
public static double KMToNM(double km)
```
Convert kilometers to nautical miles

KMToSM

public static double KMToSM(double km)

Convert kilometers to statute miles

NMToKM
```
public static double NMToKM(double nm)
```
Convert nautical miles to kilometers

SMToKM

public static double SMToKM(double sm)

Convert statute miles to kilometers

getLatitude
```
public double getLatitude()
```
Get the latitude (radians)

getLatitude
```
public double getLatitude(int units)
```
Get the latitude (degrees or radians)

getLongitude
```
public double getLongitude()
```
Get the longitude (radians)

getLongitude
```
public double getLongitude(int units)
```
Get the longitude (degrees or radians)

getElevation
```
public double getElevation()
```
Get the elevation (km)

setLatitude

public void setLatitude(double inlat)

Set the latitude (radians)

setLatitude

public void setLatitude(double inlat,
                        int units)

Set the latitude (degrees or radians)

setLongitude

public void setLongitude(double inlon)

Set the longitude (radians)

setLongitude

public void setLongitude(double inlon,
                         int units)

Set the longitude (degrees or radians)

setElevation

public void setElevation(double inelev)

Set the elevation (km)

getVector

public javax.vecmath.Vector3d getVector()

Return the ECF vector

setVector

public EarthVector setVector(javax.vecmath.Vector3d vec)

Copy the ECF vector

getX
```
public double getX()
```
Get the x coordinate of the ECF vector (km)

getY
```
public double getY()
```
Get the y coordinate of the ECF vector (km)

getZ
```
public double getZ()
```
Get the z coordinate of the ECF vector (km)

getUnitVector

public javax.vecmath.Vector3d getUnitVector()

Normalize the ECF vector

makeGreatCircle
```
public EarthVector[] makeGreatCircle(EarthVector endpoint)
```
Create a great circle from this point to an endpoint

makeGreatCircleSegmentLength

public EarthVector[] makeGreatCircleSegmentLength(EarthVector endpoint,
                                                  double segmentLengthKM)

makeGreatCircleSegmentLengthReverseDirection

public EarthVector[] makeGreatCircleSegmentLengthReverseDirection(EarthVector endpoint,
                                                                  double segmentLengthKM)

makeGreatCircleNumSegments

public EarthVector[] makeGreatCircleNumSegments(EarthVector endpoint,
                                                int segments)

makeGreatCircleNumSegments

public EarthVector[] makeGreatCircleNumSegments(EarthVector endpoint,
                                                int segments,
                                                boolean reverseDirection)

makeInterpolatedLineSegmentLength

public EarthVector[] makeInterpolatedLineSegmentLength(EarthVector endpoint,
                                                       double segmentLengthKM)

makeInterpolatedLineSegmentLength

public EarthVector[] makeInterpolatedLineSegmentLength(EarthVector endpoint,
                                                       double segmentLengthKM,
                                                       boolean reverseDirection)

makeInterpolatedLineNumSegments

public EarthVector[] makeInterpolatedLineNumSegments(EarthVector endpoint,
                                                     int segments)

makeInterpolatedLineNumSegments

public EarthVector[] makeInterpolatedLineNumSegments(EarthVector endpoint,
                                                     int segments,
                                                     boolean reverseDirection)

getNumGreatCircleSegments

public int getNumGreatCircleSegments(EarthVector endpoint,
                                     double segmentLengthKM)

getNumGreatCircleSegments

public int getNumGreatCircleSegments(EarthVector endpoint,
                                     double segmentLengthKM,
                                     boolean reverseDirection)

findPoint
```
public EarthVector findPoint(EarthVector nextCoord,
                             double fraction)
```
Locate a coordinate on the line between this one and the "next" coord, at some fraction of the distance between them

findPointReverseDirection

public EarthVector findPointReverseDirection(EarthVector nextCoord,
                                             double fraction)

getNormalizedEarthTangentVector

public javax.vecmath.Vector3d getNormalizedEarthTangentVector(double azimuth)

findPoint

public EarthVector findPoint(double distanceKM,
                             double azimuth)

Locate a coordinate at a specific distance (km) and heading (radians) from this one.

findPoint

public EarthVector findPoint(double distanceKM,
                             double azimuth,
                             double elevAngle)

Locate a coordinate at a specific distance (km), elevation angle (radians), and heading (radians) from this one.

kmToRadians

public static double kmToRadians(double distKM,
                                 double latRad)

kmToDegrees

public static double kmToDegrees(double distKM,
                                 double latDeg)

radianstoKM

public static double radianstoKM(double distRad,
                                 double latRad)

degreestoKM

public static double degreestoKM(double distDeg,
                                 double latDeg)

kmToRadians

public double kmToRadians(double distKM)

kmToDegrees

public double kmToDegrees(double distKM)

rotate
```
public javax.vecmath.Vector3d rotate(javax.vecmath.Vector3d rotAxis,
                                     double angle)
```
Rotates this coordinate about the input vector through the input angle (radians - because we usually use this internally)

Parameters:

vecAxis - The axis of rotation

ang - The angle of rotation (in radians)

getVectorDistanceKMSq

public double getVectorDistanceKMSq(EarthVector loc)

getDistance
```
public double getDistance(EarthVector loc)
```
Compute the distance (km) from this coord to the input coord using vector math (my personal favorite)

Parameters:

loc - The coordinate to compute the distance to

getDistanceReverseDirection
```
public double getDistanceReverseDirection(EarthVector loc)
```
Compute the distance (km) from this coord to the input coord using vector math (my personal favorite)

Parameters:

loc - The coordinate to compute the distance to

getSphereDistance
```
public double getSphereDistance(EarthVector loc)
```
Compute the distance (km) from this coord to the input coord using trigonometry.

Parameters:

loc - The coordinate to compute the distance to

getAzimuth
```
public double getAzimuth(EarthVector loc)
```
Compute the azimuth (in radians) from this coord to the input coord

Parameters:

loc - The coordinate to compute the distance to

getVector
```
public javax.vecmath.Vector3d getVector(EarthVector loc)
```
Compute the vector from this coord to the input coord

Parameters:

loc -

Returns:

getRadius
```
public double getRadius()
```
Compute the radius (km) from the origin to this coord

getEarthRadiusKM
```
public double getEarthRadiusKM()
```
Retrieve the radius of the earth (km) at this coordinate's latitude

getEarthRadiusKM

public static double getEarthRadiusKM(double lat,
                                      boolean flat)

Retrieve the radius of the earth (km) statically for the given latitude

kmPerDegree
```
public static double kmPerDegree(double lat)
```
Retrieve the number of kilometers per degree at the given latitude

kmPerDegree
```
public double kmPerDegree()
```
Retrieve the number of kilometers per degree for this coord's latitude

sign
```
protected double sign(double x)
```
return the sign of the argument

toString
```
public String toString()
```
Overrides:

toString in class Object

getPoint2d

public javax.vecmath.Point2d getPoint2d()

Class EarthVector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

X_EPSILON

Y_EPSILON

ECF_EPSILON

DEGREES

RADIANS

KMperNM

KMperSM

FTperSM

SMperKM

FTperKM

INperKM

YDperKM

KMperDegree

NMperDegree

REKM

CEKM

RENM

POLAR_RENM

FLATTENING_FACTOR

EARTH_FLATTENING

FLAT_COEFF1

FLAT_COEFF2

DPR

RAD_1

RAD_45

RAD_90

RAD_180

RAD_270

RAD_360

EARTH_ROT_RATE

G

GM

J2

J3

J4

J5

SEC_90

SEC_180

SEC_270

SEC_360

latitude

longitude

elevation

ecfVector

oblate

Constructor Detail

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

EarthVector

Method Detail

fromDegrees

translateDegrees

setCoord

epsilonEquals

equals

hashCode

initVector

normalizeLongitude

normalizeLatitude

setOblate

isOblate

degToRad

radToDeg

KMToNM

KMToSM