GpsLocalFrame (UnetStack 3.3.0 API)

org.arl.unet.utils.GpsLocalFrame

Utility class to convert GPS coordinates into a local coordinate frame and vice-versa.
The local coordinate frame uses metric coordinates (in meters) with x-axis pointing eastward, and y-axis pointing northward, from a specified GPS origin location.
GPS coordinates may be specified as decimal degrees, degrees and decimal minutes, or degrees, minutes and decimal seconds. When providing double[] to specify GPS coordinates, length 2 arrays are assumed to be latitude, longitude in decimal degrees, length 4 arrays are assumed to be latitude, longitude in degrees and decimal minutes, and length 6 arrays are assumed to be latitude, longitude in degrees, minutes and decimal seconds.
The local coordinate system positions are represented as double[] of length 2 with x, y coordinates (in meters) in that order.

Constructor Summary

Constructors
Constructor and description
`GpsLocalFrame (double[] latlong0)` Creates a local coordinate frame with specified GPS coordinates.
`GpsLocalFrame (double lat0, double long0)` Creates a local coordinate frame with specified GPS coordinates.
`GpsLocalFrame (double lat0d, double lat0m, double long0d, double long0m)` Creates a local coordinate frame with specified GPS coordinates.
`GpsLocalFrame (double lat0d, double lat0m, double lat0s, double long0d, double long0m, double long0s)` Creates a local coordinate frame with specified GPS coordinates.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`double[]`	`toGps(double[] xy)` Converts from local coordinates to GPS (decimal degrees).
	`double[]`	`toGps(double x, double y)` Converts from local coordinates to GPS (decimal degrees).
	`double[]`	`toGpsDM(double[] xy)` Converts from local coordinates to GPS (degrees, minutes).
	`double[]`	`toGpsDM(double x, double y)` Converts from local coordinates to GPS (degrees, minutes).
	`double[]`	`toGpsDMS(double[] xy)` Converts from local coordinates to GPS (degrees, minutes, seconds).
	`double[]`	`toGpsDMS(double x, double y)` Converts from local coordinates to GPS (degrees, minutes, seconds).
	`double[]`	`toLocal(double[] latlong)` Converts from GPS to local coordinates.
	`double[]`	`toLocal(double latd, double longd)` Converts from GPS to local coordinates.
	`double[]`	`toLocal(double latd, double latm, double longd, double longm)` Converts from GPS to local coordinates.
	`double[]`	`toLocal(double latd, double latm, double lats, double longd, double longm, double longs)` Converts from GPS to local coordinates.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Constructor Detail
  - public GpsLocalFrame(double[] latlong0)
    
    Creates a local coordinate frame with specified GPS coordinates.
    Parameters:
    latlong0 - GPS coordinates of origin
  - public GpsLocalFrame(double lat0, double long0)
    
    Creates a local coordinate frame with specified GPS coordinates.
    Parameters:
    lat0 - GPS latitude of origin
    long0 - GPS longitude of origin
  - public GpsLocalFrame(double lat0d, double lat0m, double long0d, double long0m)
    
    Creates a local coordinate frame with specified GPS coordinates.
    Parameters:
    lat0d - GPS latitude of origin (degrees)
    lat0m - GPS latitude of origin (minutes)
    long0d - GPS longitude of origin (degrees)
    long0m - GPS longitude of origin (minutes)
  - public GpsLocalFrame(double lat0d, double lat0m, double lat0s, double long0d, double long0m, double long0s)
    
    Creates a local coordinate frame with specified GPS coordinates.
    Parameters:
    lat0d - GPS latitude of origin (degrees)
    lat0m - GPS latitude of origin (minutes)
    lat0s - GPS latitude of origin (seconds)
    long0d - GPS longitude of origin (degrees)
    long0m - GPS longitude of origin (minutes)
    long0s - GPS longitude of origin (seconds)
- Method Detail
  - public double[] toGps(double[] xy)
    
    Converts from local coordinates to GPS (decimal degrees).
    Parameters:
    xy - x,y in local coordinates
    Returns:
    GPS coordinates in decimal degrees (double[] of length 2)
  - public double[] toGps(double x, double y)
    
    Converts from local coordinates to GPS (decimal degrees).
    Parameters:
    x - local x coordinate
    y - local y coordinate
    Returns:
    GPS coordinates in decimal degrees (double[] of length 2)
  - public double[] toGpsDM(double[] xy)
    
    Converts from local coordinates to GPS (degrees, minutes).
    Parameters:
    xy - x,y in local coordinates
    Returns:
    GPS coordinates in degrees, minutes (double[] of length 4)
  - public double[] toGpsDM(double x, double y)
    
    Converts from local coordinates to GPS (degrees, minutes).
    Parameters:
    x - local x coordinate
    y - local y coordinate
    Returns:
    GPS coordinates in degrees, minutes (double[] of length 4)
  - public double[] toGpsDMS(double[] xy)
    
    Converts from local coordinates to GPS (degrees, minutes, seconds).
    Parameters:
    xy - x,y in local coordinates
    Returns:
    GPS coordinates in degrees, minutes, seconds (double[] of length 6)
  - public double[] toGpsDMS(double x, double y)
    
    Converts from local coordinates to GPS (degrees, minutes, seconds).
    Parameters:
    x - local x coordinate
    y - local y coordinate
    Returns:
    GPS coordinates in degrees, minutes, seconds (double[] of length 6)
  - public double[] toLocal(double[] latlong)
    
    Converts from GPS to local coordinates.
    Parameters:
    latlong - GPS coordinates
    Returns:
    x, y in local coordinates
  - public double[] toLocal(double latd, double longd)
    
    Converts from GPS to local coordinates.
    Parameters:
    latd - GPS latitude (decimal degrees)
    longd - GPS longitude (decimal degrees)
    Returns:
    x, y in local coordinates
  - public double[] toLocal(double latd, double latm, double longd, double longm)
    
    Converts from GPS to local coordinates.
    Parameters:
    latd - GPS latitude (degrees)
    latm - GPS latitude (minutes)
    longd - GPS longitude (degrees)
    longm - GPS longitude (minutes)
    Returns:
    x, y in local coordinates
  - public double[] toLocal(double latd, double latm, double lats, double longd, double longm, double longs)
    
    Converts from GPS to local coordinates.
    Parameters:
    latd - GPS latitude (degrees)
    latm - GPS latitude (minutes)
    lats - GPS latitude (seconds)
    longd - GPS longitude (degrees)
    longm - GPS longitude (minutes)
    longs - GPS longitude (seconds)
    Returns:
    x, y in local coordinates

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class GpsLocalFrame

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public GpsLocalFrame(double[] latlong0)

public GpsLocalFrame(double lat0, double long0)

public GpsLocalFrame(double lat0d, double lat0m, double long0d, double long0m)

public GpsLocalFrame(double lat0d, double lat0m, double lat0s, double long0d, double long0m, double long0s)

Method Detail

public double[] toGps(double[] xy)

public double[] toGps(double x, double y)

public double[] toGpsDM(double[] xy)

public double[] toGpsDM(double x, double y)

public double[] toGpsDMS(double[] xy)

public double[] toGpsDMS(double x, double y)

public double[] toLocal(double[] latlong)

public double[] toLocal(double latd, double longd)

public double[] toLocal(double latd, double latm, double longd, double longm)

public double[] toLocal(double latd, double latm, double lats, double longd, double longm, double longs)