org.apache.lucene.util

Class GeoUtils

java.lang.Object

org.apache.lucene.util.GeoUtils

public final class GeoUtils
extends Object

Basic reusable geo-spatial utility methods

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static short	BITS
static double	MAX_LAT_INCL Maximum latitude value.
static double	MAX_LON_INCL Maximum longitude value.
static double	MIN_LAT_INCL Minimum latitude value.
static double	MIN_LON_INCL Minimum longitude value.
static double	TOLERANCE

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	bboxContains(double lon, double lat, double minLon, double minLat, double maxLon, double maxLat) Determine if a bbox (defined by minLon, minLat, maxLon, maxLat) contains the provided point (defined by lon, lat) NOTE: this is a basic method that does not handle dateline or pole crossing.
static GeoRect	circleToBBox(double centerLon, double centerLat, double radiusMeters) Compute Bounding Box for a circle using WGS-84 parameters
static ArrayList<double[]>	circleToPoly(double lon, double lat, double radiusMeters) Converts a given circle (defined as a point/radius) to an approximated line-segment polygon
static double	compare(double v1, double v2)
static String	geoTermToString(long term)
static boolean	isValidLat(double lat)
static boolean	isValidLon(double lon)
static boolean	lineCrossesPoly(double x1, double y1, double x2, double y2, double[] shapeX, double[] shapeY, double sMinX, double sMinY, double sMaxX, double sMaxY)
static Long	mortonHash(double lon, double lat)
static double	mortonUnhashLat(long hash)
static double	mortonUnhashLon(long hash)
static double	normalizeLat(double lat_deg) Puts latitude in range of -90 to 90.
static double	normalizeLon(double lon_deg) Puts longitude in range of -180 to +180.
static boolean	pointInPolygon(double[] x, double[] y, double lat, double lon) simple even-odd point in polygon computation 1.
static GeoRect	polyToBBox(double[] polyLons, double[] polyLats)
static boolean	rectContains(double aMinX, double aMinY, double aMaxX, double aMaxY, double bMinX, double bMinY, double bMaxX, double bMaxY) Computes whether rectangle a contains rectangle b (touching allowed)
static boolean	rectCrosses(double aMinX, double aMinY, double aMaxX, double aMaxY, double bMinX, double bMinY, double bMaxX, double bMaxY)
static boolean	rectCrossesCircle(double rMinX, double rMinY, double rMaxX, double rMaxY, double centerLon, double centerLat, double radiusMeters) Determine if a bbox (defined by minLon, minLat, maxLon, maxLat) contains the provided point (defined by lon, lat) NOTE: this is basic method that does not handle dateline or pole crossing.
static boolean	rectCrossesPoly(double rMinX, double rMinY, double rMaxX, double rMaxY, double[] shapeX, double[] shapeY, double sMinX, double sMinY, double sMaxX, double sMaxY) Computes whether a rectangle crosses a shape.
static boolean	rectDisjoint(double aMinX, double aMinY, double aMaxX, double aMaxY, double bMinX, double bMinY, double bMaxX, double bMaxY)
static boolean	rectIntersects(double aMinX, double aMinY, double aMaxX, double aMaxY, double bMinX, double bMinY, double bMaxX, double bMaxY) Computes whether a rectangle intersects another rectangle (crosses, within, touching, etc)
static boolean	rectWithin(double aMinX, double aMinY, double aMaxX, double aMaxY, double bMinX, double bMinY, double bMaxX, double bMaxY) Computes whether the first (a) rectangle is wholly within another (b) rectangle (shared boundaries allowed)
static boolean	rectWithinCircle(double rMinX, double rMinY, double rMaxX, double rMaxY, double centerLon, double centerLat, double radiusMeters)
static boolean	rectWithinPoly(double rMinX, double rMinY, double rMaxX, double rMaxY, double[] shapeX, double[] shapeY, double sMinX, double sMinY, double sMaxX, double sMaxY) Computes whether a rectangle is within a given polygon (shared boundaries allowed)

Methods inherited from class java.lang.Object

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

Field Detail

BITS

public static final short BITS

See Also:

Constant Field Values

TOLERANCE

public static final double TOLERANCE

See Also:

Constant Field Values

MIN_LON_INCL

public static final double MIN_LON_INCL

Minimum longitude value.

See Also:

Constant Field Values

MAX_LON_INCL

public static final double MAX_LON_INCL

Maximum longitude value.

See Also:

Constant Field Values

MIN_LAT_INCL

public static final double MIN_LAT_INCL

Minimum latitude value.

See Also:

Constant Field Values

MAX_LAT_INCL

public static final double MAX_LAT_INCL

Maximum latitude value.

See Also:

Constant Field Values

Method Detail

mortonHash

public static final Long mortonHash(double lon,
              double lat)

mortonUnhashLon

public static final double mortonUnhashLon(long hash)

mortonUnhashLat

public static final double mortonUnhashLat(long hash)

compare

public static double compare(double v1,
             double v2)

normalizeLon

public static double normalizeLon(double lon_deg)

Puts longitude in range of -180 to +180.

normalizeLat

public static double normalizeLat(double lat_deg)

Puts latitude in range of -90 to 90.

bboxContains

public static boolean bboxContains(double lon,
                   double lat,
                   double minLon,
                   double minLat,
                   double maxLon,
                   double maxLat)

Determine if a bbox (defined by minLon, minLat, maxLon, maxLat) contains the provided point (defined by lon, lat) NOTE: this is a basic method that does not handle dateline or pole crossing. Unwrapping must be done before calling this method.

pointInPolygon

public static boolean pointInPolygon(double[] x,
                     double[] y,
                     double lat,
                     double lon)

simple even-odd point in polygon computation 1. Determine if point is contained in the longitudinal range 2. Determine whether point crosses the edge by computing the latitudinal delta between the end-point of a parallel vector (originating at the point) and the y-component of the edge sink NOTE: Requires polygon point (x,y) order either clockwise or counter-clockwise

geoTermToString

public static String geoTermToString(long term)

rectDisjoint

public static boolean rectDisjoint(double aMinX,
                   double aMinY,
                   double aMaxX,
                   double aMaxY,
                   double bMinX,
                   double bMinY,
                   double bMaxX,
                   double bMaxY)

rectWithin

public static boolean rectWithin(double aMinX,
                 double aMinY,
                 double aMaxX,
                 double aMaxY,
                 double bMinX,
                 double bMinY,
                 double bMaxX,
                 double bMaxY)

Computes whether the first (a) rectangle is wholly within another (b) rectangle (shared boundaries allowed)

rectCrosses

public static boolean rectCrosses(double aMinX,
                  double aMinY,
                  double aMaxX,
                  double aMaxY,
                  double bMinX,
                  double bMinY,
                  double bMaxX,
                  double bMaxY)

rectContains

public static boolean rectContains(double aMinX,
                   double aMinY,
                   double aMaxX,
                   double aMaxY,
                   double bMinX,
                   double bMinY,
                   double bMaxX,
                   double bMaxY)

Computes whether rectangle a contains rectangle b (touching allowed)

rectIntersects

public static boolean rectIntersects(double aMinX,
                     double aMinY,
                     double aMaxX,
                     double aMaxY,
                     double bMinX,
                     double bMinY,
                     double bMaxX,
                     double bMaxY)

Computes whether a rectangle intersects another rectangle (crosses, within, touching, etc)

rectCrossesPoly

public static boolean rectCrossesPoly(double rMinX,
                      double rMinY,
                      double rMaxX,
                      double rMaxY,
                      double[] shapeX,
                      double[] shapeY,
                      double sMinX,
                      double sMinY,
                      double sMaxX,
                      double sMaxY)

Computes whether a rectangle crosses a shape. (touching not allowed)

lineCrossesPoly

public static boolean lineCrossesPoly(double x1,
                      double y1,
                      double x2,
                      double y2,
                      double[] shapeX,
                      double[] shapeY,
                      double sMinX,
                      double sMinY,
                      double sMaxX,
                      double sMaxY)

circleToPoly

public static ArrayList<double[]> circleToPoly(double lon,
                               double lat,
                               double radiusMeters)

Converts a given circle (defined as a point/radius) to an approximated line-segment polygon

Parameters:

lon - longitudinal center of circle (in degrees)

lat - latitudinal center of circle (in degrees)

radiusMeters - distance radius of circle (in meters)

Returns:

a list of lon/lat points representing the circle

rectWithinPoly

public static boolean rectWithinPoly(double rMinX,
                     double rMinY,
                     double rMaxX,
                     double rMaxY,
                     double[] shapeX,
                     double[] shapeY,
                     double sMinX,
                     double sMinY,
                     double sMaxX,
                     double sMaxY)

Computes whether a rectangle is within a given polygon (shared boundaries allowed)

rectWithinCircle

public static boolean rectWithinCircle(double rMinX,
                       double rMinY,
                       double rMaxX,
                       double rMaxY,
                       double centerLon,
                       double centerLat,
                       double radiusMeters)

rectCrossesCircle

public static boolean rectCrossesCircle(double rMinX,
                        double rMinY,
                        double rMaxX,
                        double rMaxY,
                        double centerLon,
                        double centerLat,
                        double radiusMeters)

Determine if a bbox (defined by minLon, minLat, maxLon, maxLat) contains the provided point (defined by lon, lat) NOTE: this is basic method that does not handle dateline or pole crossing. Unwrapping must be done before calling this method.

circleToBBox

public static GeoRect circleToBBox(double centerLon,
                   double centerLat,
                   double radiusMeters)

Compute Bounding Box for a circle using WGS-84 parameters

polyToBBox

public static GeoRect polyToBBox(double[] polyLons,
                 double[] polyLats)

isValidLat

public static boolean isValidLat(double lat)

isValidLon

public static boolean isValidLon(double lon)