GeospatialPose

public class GeospatialPose

Describes a specific location, elevation, and compass heading relative to Earth. It is comprised of:

  • Latitude and longitude are specified in degrees, with positive values being north of the equator and east of the prime meridian as defined by the WGS84 specification.
  • Altitude is specified in meters above the WGS84 ellipsoid, which is roughly equivalent to meters above sea level.
  • Heading is defined in degrees clockwise from north. See getHeading() for more information.
  • Accuracy of the latitude, longitude, altitude, and heading are available as numeric confidence intervals where a large value (large interval) means low confidence and small value (small interval) means high confidence.
An GeospatialPose can be retrieved from Earth.getCameraGeospatialPose().

Public Methods

double
getAltitude()
Returns the GeospatialPose's altitude in meters as elevation above the WGS84 ellipsoid.
double
getHeading()
Returns the GeospatialPose's heading.
double
getHeadingAccuracy()
Returns the GeospatialPose's estimated heading accuracy.
double
getHorizontalAccuracy()
Returns the GeospatialPose's estimated horizontal accuracy in meters with respect to latitude and longitude.
double
getLatitude()
Returns the GeospatialPose's latitude in degrees.
double
getLongitude()
Returns the GeospatialPose's longitude in degrees.
double
getVerticalAccuracy()
Returns the GeospatialPose's estimated altitude accuracy in meters.

Inherited Methods

Public Methods

getAltitude

public double getAltitude()

Returns the GeospatialPose's altitude in meters as elevation above the WGS84 ellipsoid.

getHeading

public double getHeading()

Returns the GeospatialPose's heading.

Heading is specified in degrees clockwise from true north and approximates the direction the device is facing. The value returned when facing north is 0°, when facing east is 90°, when facing south is +/-180°, and when facing west is -90°.

The heading approximation is based on the rotation of the device in its current orientation mode (i.e. portrait or landscape) and pitch. For example, when the device is held vertically or upright, the heading is based on the camera optical axis. If the device is held horizontally, looking downwards, the heading is based on the top of the device, with respect to the orientation mode.

Note: Heading is currently only supported in the device's default orientation mode, which is portrait mode for most supported devices.

Details
Returns the heading component of this pose's orientation in [-180.0, 180.0] degree range.

getHeadingAccuracy

public double getHeadingAccuracy()

Returns the GeospatialPose's estimated heading accuracy.

We define heading accuracy as the radius of the 68th percentile confidence level around getHeading(). In other words, there is a 68% probability that the true heading is within getHeadingAccuracy() of this GeospatialPose's heading. Larger values indicate lower accuracy.

For example, if the estimated heading is 60°, and the heading accuracy is 10°, then there is an estimated 68% probability of the true heading being between 50° and 70°.

Details
Returns the accuracy of the heading confidence in degrees.

getHorizontalAccuracy

public double getHorizontalAccuracy()

Returns the GeospatialPose's estimated horizontal accuracy in meters with respect to latitude and longitude.

We define horizontal accuracy as the radius of the 68th percentile confidence level around the estimated horizontal location. In other words, if you draw a circle centered at this GeospatialPose's latitude and longitude, and with a radius equal to the horizontal accuracy, then there is a 68% probability that the true location is inside the circle. Larger numbers indicate lower accuracy.

For example, if the latitude is 10°, longitude is 10°, and the returned value is 15, then there is a 68% probability that the true location is within 15 meters of the (10°, 10°) latitude/longitude coordinate.

Details
Returns the estimated horizontal accuracy with respect to latitude and longitude, radial, in meters.

getLatitude

public double getLatitude()

Returns the GeospatialPose's latitude in degrees. Positive values are north of the equator as defined by the WGS84 specification.

getLongitude

public double getLongitude()

Returns the GeospatialPose's longitude in degrees. Positive values are east of the prime meridian as defined by the WGS84 specification.

getVerticalAccuracy

public double getVerticalAccuracy()

Returns the GeospatialPose's estimated altitude accuracy in meters.

We define vertical accuracy as the radius of the 68th percentile confidence level around the estimated altitude. In other words, there is a 68% probability that the true altitude is within the output value (in meters) of this GeospatialPose's altitude (above or below). Larger numbers indicate lower accuracy.

For example, if this GeospatialPose's altitude is 100 meters, and the output value is 20 meters, there is a 68% chance that the true altitude is within 20 meters of 100 meters.

Details
Returns the estimated vertical accuracy in meters.