org.apache.lucene.spatial.spatial4j.geo3d

Class GeoPath

java.lang.Object

org.apache.lucene.spatial.spatial4j.geo3d.GeoBaseExtendedShape

org.apache.lucene.spatial.spatial4j.geo3d.GeoPath

All Implemented Interfaces:

GeoDistance, GeoDistanceShape, GeoMembershipShape, GeoShape, Membership

public class GeoPath
extends GeoBaseExtendedShape
implements GeoDistanceShape

GeoSearchableShape representing a path across the surface of the globe, with a specified half-width. Path is described by a series of points. Distances are measured from the starting point along the path, and then at right angles to the path.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoPath.PathSegment This is the precalculated data for a path segment.
static class	GeoPath.SegmentEndpoint This is precalculated data for segment endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
double	chordDistance
double	cutoffAngle
double	cutoffOffset
GeoPoint[]	edgePoints
double	originDistance
List<GeoPath.SegmentEndpoint>	points
List<GeoPath.PathSegment>	segments

Fields inherited from class org.apache.lucene.spatial.spatial4j.geo3d.GeoBaseExtendedShape

NORTH_POLE, SOUTH_POLE

Constructor Summary

Constructors

Constructor and Description
GeoPath(double cutoffAngle)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPoint(double lat, double lon)
double	computeArcDistance(GeoPoint point) Compute a true, accurate, great-circle distance.
double	computeLinearDistance(double x, double y, double z) Compute a linear distance to the point.
double	computeLinearDistance(GeoPoint point) Compute a linear distance to the point.
double	computeNormalDistance(double x, double y, double z) Compute an estimate of "distance" to the GeoPoint.
double	computeNormalDistance(GeoPoint point) Compute an estimate of "distance" to the GeoPoint.
double	computeSquaredLinearDistance(double x, double y, double z) Compute a squared linear distance to the vector.
double	computeSquaredLinearDistance(GeoPoint point) Compute a squared linear distance to the vector.
double	computeSquaredNormalDistance(double x, double y, double z) Compute a squared estimate of the "distance" to the GeoPoint.
double	computeSquaredNormalDistance(GeoPoint point) Compute a squared estimate of the "distance" to the GeoPoint.
void	done()
boolean	equals(Object o) Equals
Bounds	getBounds(Bounds bounds) Compute longitude/latitude bounds for the shape.
GeoPoint[]	getEdgePoints() Return a sample point that is on the edge of the shape.
int	hashCode()
boolean	intersects(Plane plane, GeoPoint[] notablePoints, Membership... bounds) Assess whether a plane, within the provided bounds, intersects with the shape.
boolean	isWithin(double x, double y, double z) Check if a point is within this shape.
boolean	isWithin(Vector point) Check if a point is within this shape.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cutoffAngle

public final double cutoffAngle

cutoffOffset

public final double cutoffOffset

originDistance

public final double originDistance

chordDistance

public final double chordDistance

points

public final List<GeoPath.SegmentEndpoint> points

segments

public final List<GeoPath.PathSegment> segments

edgePoints

public GeoPoint[] edgePoints

Constructor Detail

GeoPath

public GeoPath(double cutoffAngle)

Method Detail

addPoint

public void addPoint(double lat,
            double lon)

done

public void done()

computeNormalDistance

public double computeNormalDistance(GeoPoint point)

Compute an estimate of "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Specified by:

computeNormalDistance in interface GeoDistance

Parameters:

point - is the point to compute the distance to.

Returns:

the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeNormalDistance

public double computeNormalDistance(double x,
                           double y,
                           double z)

Compute an estimate of "distance" to the GeoPoint. A return value of Double.MAX_VALUE should be returned for points outside of the shape.

Specified by:

computeNormalDistance in interface GeoDistance

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeSquaredNormalDistance

public double computeSquaredNormalDistance(GeoPoint point)

Compute a squared estimate of the "distance" to the GeoPoint. Double.MAX_VALUE indicates a point outside of the shape.

Specified by:

computeSquaredNormalDistance in interface GeoDistance

Parameters:

point - is the point to compute the distance to.

Returns:

the square of the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeSquaredNormalDistance

public double computeSquaredNormalDistance(double x,
                                  double y,
                                  double z)

Compute a squared estimate of the "distance" to the GeoPoint. Double.MAX_VALUE indicates a point outside of the shape.

Specified by:

computeSquaredNormalDistance in interface GeoDistance

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the square of the normal distance, defined as the perpendicular distance from from the point to one of the shape's bounding plane. Normal distances can therefore typically only go up to PI/2, except when they represent the sum of a sequence of normal distances.

computeLinearDistance

public double computeLinearDistance(GeoPoint point)

Compute a linear distance to the point.

Specified by:

computeLinearDistance in interface GeoDistance

Parameters:

point - is the point to compute the distance to.

Returns:

the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeLinearDistance

public double computeLinearDistance(double x,
                           double y,
                           double z)

Compute a linear distance to the point.

Specified by:

computeLinearDistance in interface GeoDistance

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeSquaredLinearDistance

public double computeSquaredLinearDistance(GeoPoint point)

Compute a squared linear distance to the vector.

Specified by:

computeSquaredLinearDistance in interface GeoDistance

Parameters:

point - is the point to compute the distance to.

Returns:

the square of the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeSquaredLinearDistance

public double computeSquaredLinearDistance(double x,
                                  double y,
                                  double z)

Compute a squared linear distance to the vector.

Specified by:

computeSquaredLinearDistance in interface GeoDistance

Parameters:

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the square of the linear (or chord) distance, defined as the distance from from the point to the nearest point on the unit sphere and on one of the shape's bounding planes. Linear distances can therefore typically go up to PI, except when they represent the sum of a sequence of linear distances.

computeArcDistance

public double computeArcDistance(GeoPoint point)

Compute a true, accurate, great-circle distance. Double.MAX_VALUE indicates a point is outside of the shape.

Specified by:

computeArcDistance in interface GeoDistance

Parameters:

point - is the point.

Returns:

the distance.

isWithin

public boolean isWithin(Vector point)

Description copied from class: GeoBaseExtendedShape

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

Specified by:

isWithin in class GeoBaseExtendedShape

Parameters:

point - is the point to check.

Returns:

true if the point is within this shape

isWithin

public boolean isWithin(double x,
               double y,
               double z)

Description copied from class: GeoBaseExtendedShape

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

Specified by:

isWithin in class GeoBaseExtendedShape

Parameters:

x - is x coordinate of point to check.

y - is y coordinate of point to check.

z - is z coordinate of point to check.

Returns:

true if the point is within this shape

getEdgePoints

public GeoPoint[] getEdgePoints()

Description copied from class: GeoBaseExtendedShape

Return a sample point that is on the edge of the shape.

Specified by:

getEdgePoints in interface GeoShape

Specified by:

getEdgePoints in class GeoBaseExtendedShape

Returns:

a number of edge points, one for each disconnected edge.

intersects

public boolean intersects(Plane plane,
                 GeoPoint[] notablePoints,
                 Membership... bounds)

Description copied from class: GeoBaseExtendedShape

Assess whether a plane, within the provided bounds, intersects with the shape.

Specified by:

intersects in interface GeoShape

Specified by:

intersects in class GeoBaseExtendedShape

Parameters:

plane - is the plane to assess for intersection with the shape's edges or bounding curves.

notablePoints - represents the intersections of the plane with the supplied bounds. These are used to disambiguate when two planes are identical and it needs to be determined whether any points exist that fulfill all the bounds.

bounds - are a set of bounds that define an area that an intersection must be within in order to qualify (provided by a GeoArea).

Returns:

true if there's such an intersection, false if not.

getBounds

public Bounds getBounds(Bounds bounds)

Compute longitude/latitude bounds for the shape.

Specified by:

getBounds in interface GeoShape

Overrides:

getBounds in class GeoBaseExtendedShape

Parameters:

bounds - is the optional input bounds object. If this is null, a bounds object will be created. Otherwise, the input object will be modified.

Returns:

a Bounds object describing the shape's bounds. If the bounds cannot be computed, then return a Bounds object with noLongitudeBound, noTopLatitudeBound, and noBottomLatitudeBound.

equals

public boolean equals(Object o)

Description copied from interface: GeoShape

Equals

Specified by:

equals in interface GeoShape

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object