Package org.locationtech.jts.linearref

Class LocationIndexOfPoint

java.lang.Object

org.locationtech.jts.linearref.LocationIndexOfPoint

class LocationIndexOfPoint
extends java.lang.Object

Computes the LinearLocation of the point on a linear Geometry nearest a given Coordinate. The nearest point is not necessarily unique; this class always computes the nearest point closest to the start of the geometry.

Field Summary

Fields

Modifier and Type	Field	Description
private Geometry	linearGeom

Constructor Summary

Constructors

Constructor	Description
LocationIndexOfPoint(Geometry linearGeom)

Method Summary

Modifier and Type	Method	Description
LinearLocation	indexOf(Coordinate inputPt)	Find the nearest location along a linear Geometry to a given point.
static LinearLocation	indexOf(Geometry linearGeom, Coordinate inputPt)
LinearLocation	indexOfAfter(Coordinate inputPt, LinearLocation minIndex)	Find the nearest LinearLocation along the linear Geometry to a given Coordinate after the specified minimum LinearLocation.
static LinearLocation	indexOfAfter(Geometry linearGeom, Coordinate inputPt, LinearLocation minIndex)
private LinearLocation	indexOfFromStart(Coordinate inputPt, LinearLocation minIndex)

Methods inherited from class java.lang.Object

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

Field Detail

linearGeom

private Geometry linearGeom

Constructor Detail

LocationIndexOfPoint

public LocationIndexOfPoint(Geometry linearGeom)

Method Detail

indexOf

public static LinearLocation indexOf(Geometry linearGeom,
                                     Coordinate inputPt)

indexOfAfter

public static LinearLocation indexOfAfter(Geometry linearGeom,
                                          Coordinate inputPt,
                                          LinearLocation minIndex)

indexOf

public LinearLocation indexOf(Coordinate inputPt)

Find the nearest location along a linear Geometry to a given point.

Parameters:

inputPt - the coordinate to locate

Returns:

the location of the nearest point

indexOfAfter

public LinearLocation indexOfAfter(Coordinate inputPt,
                                   LinearLocation minIndex)

Find the nearest LinearLocation along the linear Geometry to a given Coordinate after the specified minimum LinearLocation. If possible the location returned will be strictly greater than the minLocation. If this is not possible, the value returned will equal minLocation. (An example where this is not possible is when minLocation = [end of line] ).

Parameters:

inputPt - the coordinate to locate

minIndex - the minimum location for the point location

Returns:

the location of the nearest point

indexOfFromStart

private LinearLocation indexOfFromStart(Coordinate inputPt,
                                        LinearLocation minIndex)