com.mapbox.services.api.utils.turf

Class TurfMeasurement

java.lang.Object

com.mapbox.services.api.utils.turf.TurfMeasurement

public class TurfMeasurement
extends java.lang.Object

Class contains an assortment of methods used to calculate measurments such as bearing, destination, midpoint, etc.

Since:

1.2.0

See Also:

Turf documentation

Constructor Summary

Constructors

Constructor and Description
TurfMeasurement()

Method Summary

Modifier and Type	Method and Description
static com.mapbox.services.commons.geojson.Point	along(com.mapbox.services.commons.geojson.LineString line, double distance, java.lang.String units)
static double[]	bbox(com.mapbox.services.commons.geojson.LineString lineString) Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
static double[]	bbox(com.mapbox.services.commons.geojson.MultiLineString multiLineString) Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
static double[]	bbox(com.mapbox.services.commons.geojson.MultiPoint multiPoint) Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
static double[]	bbox(com.mapbox.services.commons.geojson.MultiPolygon multiPolygon) Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
static double[]	bbox(com.mapbox.services.commons.geojson.Point point) Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
static double[]	bbox(com.mapbox.services.commons.geojson.Polygon polygon) Takes a set of features, calculates the bbox of all input features, and returns a bounding box.
static double	bearing(com.mapbox.services.commons.geojson.Point p1, com.mapbox.services.commons.geojson.Point p2) Takes two points and finds the geographic bearing between them.
static double	bearing(com.mapbox.services.commons.models.Position p1, com.mapbox.services.commons.models.Position p2) Takes two positions and finds the geographic bearing between them.
static com.mapbox.services.commons.geojson.Point	destination(com.mapbox.services.commons.geojson.Point point1, double distance, double bearing, java.lang.String units) Takes a Point and calculates the location of a destination point given a distance in degrees, radians, miles, or kilometers; and bearing in degrees.
static com.mapbox.services.commons.models.Position	destination(com.mapbox.services.commons.models.Position p1, double distance, double bearing, java.lang.String units) Takes a Position and calculates the location of a destination point given a distance in degrees, radians, miles, or kilometers; and bearing in degrees.
static double	distance(com.mapbox.services.commons.geojson.Point point1, com.mapbox.services.commons.geojson.Point point2) Calculates the distance between two points in kilometers.
static double	distance(com.mapbox.services.commons.geojson.Point point1, com.mapbox.services.commons.geojson.Point point2, java.lang.String units) Calculates the distance between two points in degress, radians, miles, or kilometers.
static double	distance(com.mapbox.services.commons.models.Position point1, com.mapbox.services.commons.models.Position point2, java.lang.String units) Calculates the distance between two positions in degress, radians, miles, or kilometers.
static double	lineDistance(com.mapbox.services.commons.geojson.LineString lineString, java.lang.String units) Takes a line and measures its length in the specified units.
static double	lineDistance(com.mapbox.services.commons.geojson.MultiLineString multiLineString, java.lang.String units) Takes a line and measures its length in the specified units.
static double	lineDistance(com.mapbox.services.commons.geojson.MultiPolygon multiPolygon, java.lang.String units) Takes a line and measures its length in the specified units.
static double	lineDistance(com.mapbox.services.commons.geojson.Polygon polygon, java.lang.String units) Takes a line and measures its length in the specified units.
static com.mapbox.services.commons.geojson.Point	midpoint(com.mapbox.services.commons.geojson.Point from, com.mapbox.services.commons.geojson.Point to) Takes two Point and returns a point midway between them.
static com.mapbox.services.commons.models.Position	midpoint(com.mapbox.services.commons.models.Position from, com.mapbox.services.commons.models.Position to) Takes two Position and returns a position midway between them.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TurfMeasurement

public TurfMeasurement()

Method Detail

bearing

public static double bearing(com.mapbox.services.commons.models.Position p1,
                             com.mapbox.services.commons.models.Position p2)

Takes two positions and finds the geographic bearing between them.

Parameters:

p1 - Starting Position.

p2 - Ending Position.

Returns:

bearing in decimal degrees.

Since:

1.3.0

See Also:

Turf Bearing documentation

bearing

public static double bearing(com.mapbox.services.commons.geojson.Point p1,
                             com.mapbox.services.commons.geojson.Point p2)

Takes two points and finds the geographic bearing between them.

Parameters:

p1 - Starting Point.

p2 - Ending Point.

Returns:

bearing in decimal degrees.

Since:

1.2.0

See Also:

Turf Bearing documentation

destination

public static com.mapbox.services.commons.models.Position destination(com.mapbox.services.commons.models.Position p1,
                                                                      double distance,
                                                                      double bearing,
                                                                      java.lang.String units)
                                                               throws TurfException

Takes a Position and calculates the location of a destination point given a distance in degrees, radians, miles, or kilometers; and bearing in degrees. This uses the Haversine formula to account for global curvature.

Parameters:

p1 - Starting point.

distance - Distance from the starting point.

bearing - Ranging from -180 to 180.

units - Miles, kilometers, degrees, or radians (defaults kilometers).

Returns:

destination Point

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.3.0

See Also:

Turf Destination documetation

destination

public static com.mapbox.services.commons.geojson.Point destination(com.mapbox.services.commons.geojson.Point point1,
                                                                    double distance,
                                                                    double bearing,
                                                                    java.lang.String units)
                                                             throws TurfException

Takes a Point and calculates the location of a destination point given a distance in degrees, radians, miles, or kilometers; and bearing in degrees. This uses the Haversine formula to account for global curvature.

Parameters:

point1 - Starting point.

distance - Distance from the starting point.

bearing - Ranging from -180 to 180.

units - Miles, kilometers, degrees, or radians (defaults kilometers).

Returns:

destination Point

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Destination documetation

distance

public static double distance(com.mapbox.services.commons.models.Position point1,
                              com.mapbox.services.commons.models.Position point2,
                              java.lang.String units)
                       throws TurfException

Calculates the distance between two positions in degress, radians, miles, or kilometers. This uses the Haversine formula to account for global curvature.

Parameters:

point1 - Origin position.

point2 - Destination position.

units - Miles, kilometers, degrees, or radians (defaults kilometers).

Returns:

Distance between the two positions.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.3.0

See Also:

Turf distance documentation

distance

public static double distance(com.mapbox.services.commons.geojson.Point point1,
                              com.mapbox.services.commons.geojson.Point point2)
                       throws TurfException

Calculates the distance between two points in kilometers. This uses the Haversine formula to account for global curvature.

Parameters:

point1 - Origin point.

point2 - Destination point.

Returns:

Distance between the two points.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf distance documentation

distance

public static double distance(com.mapbox.services.commons.geojson.Point point1,
                              com.mapbox.services.commons.geojson.Point point2,
                              java.lang.String units)
                       throws TurfException

Calculates the distance between two points in degress, radians, miles, or kilometers. This uses the Haversine formula to account for global curvature.

Parameters:

point1 - Origin point.

point2 - Destination point.

units - Can be degrees, radians, miles, or kilometers (defaults kilometers).

Returns:

Distance between the two points.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf distance documentation

lineDistance

public static double lineDistance(com.mapbox.services.commons.geojson.LineString lineString,
                                  java.lang.String units)
                           throws TurfException

Takes a line and measures its length in the specified units.

Parameters:

lineString - Line to measure.

units - Can be degrees, radians, miles, or kilometers (defaults kilometers).

Returns:

Length of the input line.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Line Distance documentation

lineDistance

public static double lineDistance(com.mapbox.services.commons.geojson.Polygon polygon,
                                  java.lang.String units)
                           throws TurfException

Takes a line and measures its length in the specified units.

Parameters:

polygon - Line to measure.

units - Can be degrees, radians, miles, or kilometers (defaults kilometers).

Returns:

Length of the input line.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Line Distance documentation

lineDistance

public static double lineDistance(com.mapbox.services.commons.geojson.MultiLineString multiLineString,
                                  java.lang.String units)
                           throws TurfException

Takes a line and measures its length in the specified units.

Parameters:

multiLineString - Line to measure.

units - Can be degrees, radians, miles, or kilometers (defaults kilometers).

Returns:

Length of the input line.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Line Distance documentation

lineDistance

public static double lineDistance(com.mapbox.services.commons.geojson.MultiPolygon multiPolygon,
                                  java.lang.String units)
                           throws TurfException

Takes a line and measures its length in the specified units.

Parameters:

multiPolygon - Line to measure.

units - Can be degrees, radians, miles, or kilometers (defaults kilometers).

Returns:

Length of the input line.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.2.0

See Also:

Turf Line Distance documentation

midpoint

public static com.mapbox.services.commons.models.Position midpoint(com.mapbox.services.commons.models.Position from,
                                                                   com.mapbox.services.commons.models.Position to)
                                                            throws TurfException

Takes two Position and returns a position midway between them. The midpoint is calculated geodesically, meaning the curvature of the earth is taken into account.

Parameters:

from - First point.

to - Second point.

Returns:

A Position midway between pt1 and pt2.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.3.0

See Also:

Turf Midpoint documentation

midpoint

public static com.mapbox.services.commons.geojson.Point midpoint(com.mapbox.services.commons.geojson.Point from,
                                                                 com.mapbox.services.commons.geojson.Point to)
                                                          throws TurfException

Takes two Point and returns a point midway between them. The midpoint is calculated geodesically, meaning the curvature of the earth is taken into account.

Parameters:

from - First point.

to - Second point.

Returns:

A Point midway between pt1 and pt2.

Throws:

TurfException - TurfException Signals that a Turf exception of some sort has occurred.

Since:

1.3.0

See Also:

Turf Midpoint documentation

along

public static com.mapbox.services.commons.geojson.Point along(com.mapbox.services.commons.geojson.LineString line,
                                                              double distance,
                                                              java.lang.String units)
                                                       throws TurfException

Throws:

TurfException

bbox

public static double[] bbox(com.mapbox.services.commons.geojson.Point point)

Takes a set of features, calculates the bbox of all input features, and returns a bounding box.

Parameters:

point - A Point object.

Returns:

A double array defining the bounding box in this order [minX, minY, maxX, maxY].

Since:

2.0.0

bbox

public static double[] bbox(com.mapbox.services.commons.geojson.LineString lineString)

Takes a set of features, calculates the bbox of all input features, and returns a bounding box.

Parameters:

lineString - A LineString object.

Returns:

A double array defining the bounding box in this order [minX, minY, maxX, maxY].

Since:

2.0.0

bbox

public static double[] bbox(com.mapbox.services.commons.geojson.MultiPoint multiPoint)

Takes a set of features, calculates the bbox of all input features, and returns a bounding box.

Parameters:

multiPoint - A MultiPoint object.

Returns:

A double array defining the bounding box in this order [minX, minY, maxX, maxY].

Since:

2.0.0

bbox

public static double[] bbox(com.mapbox.services.commons.geojson.Polygon polygon)

Takes a set of features, calculates the bbox of all input features, and returns a bounding box.

Parameters:

polygon - A Polygon object.

Returns:

A double array defining the bounding box in this order [minX, minY, maxX, maxY].

Since:

2.0.0

bbox

public static double[] bbox(com.mapbox.services.commons.geojson.MultiLineString multiLineString)

Takes a set of features, calculates the bbox of all input features, and returns a bounding box.

Parameters:

multiLineString - A MultiLineString object.

Returns:

A double array defining the bounding box in this order [minX, minY, maxX, maxY].

Since:

2.0.0

bbox

public static double[] bbox(com.mapbox.services.commons.geojson.MultiPolygon multiPolygon)

Takes a set of features, calculates the bbox of all input features, and returns a bounding box.

Parameters:

multiPolygon - A MultiPolygon object.

Returns:

A double array defining the bounding box in this order [minX, minY, maxX, maxY].

Since:

2.0.0