GeoCircle (Lucene 5.2.1 API)

java.lang.Object
- org.apache.lucene.spatial.spatial4j.geo3d.GeoBaseExtendedShape
- - org.apache.lucene.spatial.spatial4j.geo3d.GeoCircle

All Implemented Interfaces:

GeoDistance, GeoDistanceShape, GeoMembershipShape, GeoShape, GeoSizeable, Membership
```
public class GeoCircle
extends GeoBaseExtendedShape
implements GeoDistanceShape, GeoSizeable
```
Circular area with a center and radius.

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

Field Summary

Fields
Modifier and Type	Field and Description
`GeoPoint`	`center`
`SidedPlane`	`circlePlane`
`static GeoPoint[]`	`circlePoints`
`double`	`cutoffAngle`
`double`	`cutoffLinearDistance`
`double`	`cutoffNormalDistance`
`GeoPoint[]`	`edgePoints`

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

Constructor Summary

Constructors
Constructor and Description

GeoCircle(double lat, double lon, double cutoffAngle)

Constructors
Constructor and Description
`GeoCircle(double lat, double lon, double cutoffAngle)`

Method Summary

Methods
Modifier and Type	Method and Description
`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 vector.
`double`	`computeLinearDistance(GeoPoint point)` Compute a linear distance to the vector.
`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.
`boolean`	`equals(Object o)` Equals
`Bounds`	`getBounds(Bounds bounds)` Compute longitude/latitude bounds for the shape.
`GeoPoint`	`getCenter()` Returns the center of a circle into which the area will be inscribed.
`GeoPoint[]`	`getEdgePoints()` Return a sample point that is on the edge of the shape.
`double`	`getRadius()` Returns the radius of a circle into which the GeoSizeable area can be inscribed.
`int`	`hashCode()`
`boolean`	`intersects(Plane p, 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
  - center
```
public final GeoPoint center
```
  - cutoffAngle
```
public final double cutoffAngle
```
  - cutoffNormalDistance
```
public final double cutoffNormalDistance
```
  - cutoffLinearDistance
```
public final double cutoffLinearDistance
```
  - circlePlane
```
public final SidedPlane circlePlane
```
  - edgePoints
```
public final GeoPoint[] edgePoints
```
  - circlePoints
```
public static final GeoPoint[] circlePoints
```
- Constructor Detail
  - GeoCircle
```
public GeoCircle(double lat,
         double lon,
         double cutoffAngle)
```
- Method Detail
  - getRadius
```
public double getRadius()
```
    Description copied from interface: GeoSizeable
    
    Returns the radius of a circle into which the GeoSizeable area can be inscribed.
    
    Specified by:
    
    getRadius in interface GeoSizeable
    
    Returns:
    the radius.
  - getCenter
```
public GeoPoint getCenter()
```
    Returns the center of a circle into which the area will be inscribed.
    
    Specified by:
    
    getCenter in interface GeoSizeable
    
    Returns:
    the center.
  - 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 vector. return Double.MAX_VALUE for points outside the shape.
    
    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 vector. return Double.MAX_VALUE for points outside the shape.
    
    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 p,
                 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:
    p - 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

Class GeoCircle

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

center

cutoffAngle

cutoffNormalDistance

cutoffLinearDistance

circlePlane

edgePoints

circlePoints

Constructor Detail

GeoCircle

Method Detail

getRadius

getCenter

computeNormalDistance

computeNormalDistance

computeSquaredNormalDistance

computeSquaredNormalDistance

computeLinearDistance

computeLinearDistance

computeSquaredLinearDistance

computeSquaredLinearDistance

computeArcDistance

isWithin

isWithin

getEdgePoints

intersects

getBounds

equals

hashCode

toString