planner.geography

Class GeoArea

java.lang.Object

planner.geography.GeoArea

Direct Known Subclasses:

GeoCircle, GeoPoint, GeoPolygon

public abstract class GeoArea
extends Object

Abstract class for representing a geographic area (avoid area or objective) for planner use

Author:

dtdavis

Constructor Summary

Constructors

Constructor and Description
GeoArea()

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<double[]>	boundingBox()
abstract double	boundingCircleRadius()
abstract double[]	closestPoint(double[] point)
abstract boolean	contains(double[] point)
abstract AreaElementType	convertToAreaElementType() Converts the GeoRectangle to an AVCL area object
static double	distance(double[] point1, double[] point2)
static double	distance(double[] pt, double[] end1, double[] end2)
static double	dotProduct(double x1, double y1, double x2, double y2) Computes the dot product of 2 points
abstract double	getArea()
abstract double[]	getCentroid()
abstract double[]	getIntersection(double[] point1, double[] point2) Determines the closest point of intersection between the region and a line
static double[]	getLineIntersection(double[] line11, double[] line12, double[] line21, double[] line22) Returns the point of intersection of two lines (each defined by 2 points)
static double[]	getLineSegmentIntersection(double[] end11, double[] end12, double[] end21, double[] end22) Returns the point of intersection of two line segments (defined by their end points)
static double[]	getLineToSegmentIntersection(double[] line1, double[] line2, double[] seg1, double[] seg2) Returns the point of intersection of a line and a line segment
abstract double[]	getSegmentIntersection(double[] point1, double[] point2) Determines the closest point of intersection between the region and a line segment If the line is tangent to the polygon, null will be returned (no intersection)
abstract List<double[]>	getTangents(double[] start) Determines the points on the area's edge that are tangentially reachable from a specified point
static boolean	isColocated(double[] pt1, double[] pt2, double tolerance) Returns true if two points are colocated within a specified tolerance
static boolean	isColocated(double point1X, double point1Y, double point2X, double point2Y, double tolerance) Returns true if two points are colocated within a specified tolerance
boolean	isConcave()
static boolean	isInLineSegment(double[] point, double[] end1, double[] end2) Determines whether or not a point is in a line segment, but not an end point A point is considered to be on an end point if it is within 1mm of a segment end All points are double[2] format
static boolean	isInSegment(double pointX, double pointY, double end1X, double end1Y, double end2X, double end2Y) Determines whether or not a point is on a specified line segment but not an end point A point is considered to be on an end point if it is within 1mm of a segment end Method assumes that the point is on the line containing the segment All points are double[2] format
abstract boolean	isOnEdge(double[] point)
static boolean	isOnSegment(double[] point, double[] end1, double[] end2) Determines whether or not a point is on a specified line segment All points are double[2] format
static boolean	isOnSegment(double pointX, double pointY, double end1X, double end1Y, double end2X, double end2Y) Determines whether or not a point is on a specified line segment Method assumes that the point is on the line containing the segment All points are double[2] format
List<double[]>	orientedBoundingBox() Will default to the orthogonal bounding box, so must be over-ridden for GeoArea types that are not necessarily orthogonally oriented (polygon)
abstract String	toMATLABString(String colorCode) Generates a string representation of the Path object that can be used to plot the path in MATLAB

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoArea

public GeoArea()

Method Detail

getTangents

public abstract List<double[]> getTangents(double[] start)

Determines the points on the area's edge that are tangentially reachable from a specified point

Parameters:

start - the point from which tangents are to be determined start[0] = x, start[1] = y

Returns:

an ArrayList with two double[2] objects representing the tangent points

getIntersection

public abstract double[] getIntersection(double[] point1,
                       double[] point2)

Determines the closest point of intersection between the region and a line

Parameters:

point1 - first point on the line (point1[0] = x, point1[1] = y)

point2 - second point on the line (point2[0] = x, point2[1] = y)

Returns:

a 2 element array with the (X, Y) point of intersection (null if no intersect)

getSegmentIntersection

public abstract double[] getSegmentIntersection(double[] point1,
                              double[] point2)

Determines the closest point of intersection between the region and a line segment If the line is tangent to the polygon, null will be returned (no intersection)

Parameters:

point1 - first point on the line (point1[0] = x, point1[1] = y)

point2 - second point on the line (point2[0] = x, point2[1] = y)

Returns:

a 2 element array with the (X, Y) point of intersection (null if no intersect)

getCentroid

public abstract double[] getCentroid()

Returns:

Returns a double[2] with the (x, y) position of the area's centroid

getArea

public abstract double getArea()

Returns:

Returns the area (square meters) of the GeoArea

closestPoint

public abstract double[] closestPoint(double[] point)

Parameters:

point - double[2] with the (x, y) coordinates of the point being tested

Returns:

Returns the point in the GeoArea that is closest to the parameter point

boundingBox

public abstract List<double[]> boundingBox()

Returns:

Returns an ArrayList of 4 points that define an oriented rectangle enclosing the GeoArea

boundingCircleRadius

public abstract double boundingCircleRadius()

Returns:

Returns the radius of a circle (centered at the area centroid) that encloses the area

contains

public abstract boolean contains(double[] point)

Parameters:

point - double[2] defining the point being tested

Returns:

Returns true if the point defined by the parameter is inside the GeoArea

isOnEdge

public abstract boolean isOnEdge(double[] point)

Parameters:

point - double[2] defining the point being tested

Returns:

Returns true if the point defined by the parameter is on the edge of the GeoArea

convertToAreaElementType

public abstract AreaElementType convertToAreaElementType()

Converts the GeoRectangle to an AVCL area object

Returns:

Object AVCL area object corresponding to the GeoPoint

toMATLABString

public abstract String toMATLABString(String colorCode)

Generates a string representation of the Path object that can be used to plot the path in MATLAB

Parameters:

colorCode - MATLAB code for the color that is to be used in plotting the areas

Returns:

MATLAB compatible string that will plot the areas in the set

orientedBoundingBox

public List<double[]> orientedBoundingBox()

Will default to the orthogonal bounding box, so must be over-ridden for GeoArea types that are not necessarily orthogonally oriented (polygon)

Returns:

Returns the corner points of an oriented bounding box for the region

isConcave

public boolean isConcave()

Returns:

Returns true if the polygon is concave. By default, areas are assumed to be convex, so if a child class can be concave, it should override this method

distance

public static double distance(double[] point1,
              double[] point2)

Parameters:

point1 -

point2 -

Returns:

Returns the distance between two points

distance

public static double distance(double[] pt,
              double[] end1,
              double[] end2)

Parameters:

pt - double[2] containing the (x, y) position of the point being tested

end1 - double[2] containing the first endpoint of the line segment

end2 - double[2] containing the second endpoint of the line segment

Returns:

Computes the distance of a 2D point from a line segment

getLineIntersection

public static double[] getLineIntersection(double[] line11,
                           double[] line12,
                           double[] line21,
                           double[] line22)

Returns the point of intersection of two lines (each defined by 2 points)

Parameters:

line11 - the first point defining the first line

line12 - the second point defining the first line

line21 - the first point defining the second line

line22 - the second point defining the second line

Returns:

a double[2] containing the (X,Y) point of intersection (null if no intersect)

getLineSegmentIntersection

public static double[] getLineSegmentIntersection(double[] end11,
                                  double[] end12,
                                  double[] end21,
                                  double[] end22)

Returns the point of intersection of two line segments (defined by their end points)

Parameters:

end12 - the first endpoint of the first line segment

end11 - the second endpoint of the first line segment

end21 - the first endpoint of the second line segment

end22 - the second endpoint of the second line segment

Returns:

a double[2] containing the (X,Y) point of intersection (null if no intersect)

getLineToSegmentIntersection

public static double[] getLineToSegmentIntersection(double[] line1,
                                    double[] line2,
                                    double[] seg1,
                                    double[] seg2)

Returns the point of intersection of a line and a line segment

Parameters:

line1 - the first point defining the line

line2 - the second point defining the line

seg1 - the first endpoint of the line segment

seg2 - the second endpoint of the line segment

Returns:

a double[2] containing the (X,Y) point of intersection (null if no intersect)

isOnSegment

public static boolean isOnSegment(double[] point,
                  double[] end1,
                  double[] end2)

Determines whether or not a point is on a specified line segment All points are double[2] format

Parameters:

point - point being tested

end1 - first endpoint of the segment

end2 - second endpoint of the segment

Returns:

true if the point being tested is on the segment

isOnSegment

public static boolean isOnSegment(double pointX,
                  double pointY,
                  double end1X,
                  double end1Y,
                  double end2X,
                  double end2Y)

Determines whether or not a point is on a specified line segment Method assumes that the point is on the line containing the segment All points are double[2] format

Parameters:

pointX - x coordinate of the point being tested

pointY - y coordinate of the point being tested

end1X - x coordinate of the first endpoint of the segment

end1Y - y coordinate of the first endpoint of the segment

end2X - x coordinate of the second endpoint of the segment

end2Y - y coordinate of the second endpoint of the segment

Returns:

true if the point is on the segment

isInLineSegment

public static boolean isInLineSegment(double[] point,
                      double[] end1,
                      double[] end2)

Determines whether or not a point is in a line segment, but not an end point A point is considered to be on an end point if it is within 1mm of a segment end All points are double[2] format

Parameters:

point - point being tested

end1 - first endpoint of the segment

end2 - second endpoint of the segment

Returns:

boolean whether point is within the line segment

isInSegment

public static boolean isInSegment(double pointX,
                  double pointY,
                  double end1X,
                  double end1Y,
                  double end2X,
                  double end2Y)

Determines whether or not a point is on a specified line segment but not an end point A point is considered to be on an end point if it is within 1mm of a segment end Method assumes that the point is on the line containing the segment All points are double[2] format

Parameters:

pointX - x coordinate of the point being tested

pointY - y coordinate of the point being tested

end1X - x coordinate of the first endpoint of the segment

end1Y - y coordinate of the first endpoint of the segment

end2X - x coordinate of the second endpoint of the segment

end2Y - y coordinate of the second endpoint of the segment

Returns:

true if the point is on the segment but not an end point

isColocated

public static boolean isColocated(double[] pt1,
                  double[] pt2,
                  double tolerance)

Returns true if two points are colocated within a specified tolerance

Parameters:

pt1 -

pt2 -

tolerance -

Returns:

true if pt1 and pt2 are within "tolerance" meters of one another

isColocated

public static boolean isColocated(double point1X,
                  double point1Y,
                  double point2X,
                  double point2Y,
                  double tolerance)

Returns true if two points are colocated within a specified tolerance

Parameters:

point1X - x coordinate

point1Y - y coordinate

point2X - x coordinate

point2Y - y coordinate

tolerance -

Returns:

true if point1 and point2 are within "tolerance" meters of one another

dotProduct

public static double dotProduct(double x1,
                double y1,
                double x2,
                double y2)

Computes the dot product of 2 points

Parameters:

x1 - north/south Cartesian coordinate of the first point

y1 - east/west Cartesian coordinate of the first point

x2 - north/south Cartesian coordinate of the second point

y2 - east/west Cartesian coordinate of the second point

Returns:

dot product of (x1, y1) and (x2, y2)