org.opentripplanner.routing.services

Class StreetVertexIndexService

java.lang.Object

org.opentripplanner.routing.services.StreetVertexIndexService

public class StreetVertexIndexService
extends Object

Indexes all edges and transit vertices of the graph spatially. Has a variety of query methods used during network linking and trip planning. Creates a TemporaryStreetLocation representing a location on a street that's not at an intersection, based on input latitude and longitude. Instantiating this class is expensive, because it creates a spatial index of all of the intersections in the graph.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DISTANCE_ERROR
static HashSet<Graph>	graphsWithStreetVertexIndexServices
static double	MAX_DISTANCE_FROM_STREET_METERS

Constructor Summary

Constructors

Constructor and Description
StreetVertexIndexService(Graph graph) Construct a new StreetVertexIndexService using the given graph.

Method Summary

Modifier and Type	Method and Description
static TemporaryStreetLocation	createTemporaryStreetLocation(Graph graph, String label, I18NString name, Iterable<StreetEdge> edges, org.locationtech.jts.geom.Coordinate nearestPoint, boolean endVertex) Creates a TemporaryStreetLocation on the given street (set of PlainStreetEdges).
Collection<Edge>	getEdgesForEnvelope(org.locationtech.jts.geom.Envelope envelope) Return the edges whose geometry intersect with the specified envelope.
StreetVertex	getIntersectionAt(org.locationtech.jts.geom.Coordinate coordinate)
List<TransitStop>	getNearbyTransitStops(org.locationtech.jts.geom.Coordinate coordinate, double radius) Get all transit stops within a given distance of a coordinate
Vertex	getSampleVertexAt(org.locationtech.jts.geom.Coordinate coordinate, boolean dest) Get a vertex at a given coordinate, using the same logic as in Samples.
StreetSplitter	getStreetSplitter() Getter method for StreetSplitter
List<TransitStop>	getTransitStopForEnvelope(org.locationtech.jts.geom.Envelope envelope)
Vertex	getVertexForLocation(GenericLocation loc, RoutingRequest options, boolean endVertex) Finds the appropriate vertex for this location.
List<Vertex>	getVerticesForEnvelope(org.locationtech.jts.geom.Envelope envelope) Returns the vertices intersecting with the specified envelope.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DISTANCE_ERROR

public static final double DISTANCE_ERROR

See Also:

Constant Field Values

MAX_DISTANCE_FROM_STREET_METERS

public static final double MAX_DISTANCE_FROM_STREET_METERS

See Also:

Constant Field Values

graphsWithStreetVertexIndexServices

public static final HashSet<Graph> graphsWithStreetVertexIndexServices

Constructor Detail

StreetVertexIndexService

public StreetVertexIndexService(Graph graph)

Construct a new StreetVertexIndexService using the given graph. Upon instantiation, a number of spatial indexes will be created to be used for the quick lookup of data with spatial attributes. After a refactor in the year 2019, this class was refactored to be just this class instead of the previous structure of having an interface and factory implementation. The StreetVertexIndexFactory was always being used to create the same StreetVertexIndexService implementation. IMPORTANT NOTE: Only one StreetVertexIndexService should be active on a graph at any given time. This is because any newly-created (or removed) vertices or edges in this StreetVertexIndexService won't show up in the indices of the other StreetVertexIndexServices.

Parameters:

graph -

Method Detail

createTemporaryStreetLocation

public static TemporaryStreetLocation createTemporaryStreetLocation(Graph graph,
                                                                    String label,
                                                                    I18NString name,
                                                                    Iterable<StreetEdge> edges,
                                                                    org.locationtech.jts.geom.Coordinate nearestPoint,
                                                                    boolean endVertex)

Creates a TemporaryStreetLocation on the given street (set of PlainStreetEdges). How far along is controlled by the location parameter, which represents a distance along the edge between 0 (the from vertex) and 1 (the to vertex).

Parameters:

graph -

label -

name -

edges - A collection of nearby edges, which represent one street.

nearestPoint -

Returns:

the new TemporaryStreetLocation

getNearbyTransitStops

public List<TransitStop> getNearbyTransitStops(org.locationtech.jts.geom.Coordinate coordinate,
                                               double radius)

Get all transit stops within a given distance of a coordinate

getVerticesForEnvelope

public List<Vertex> getVerticesForEnvelope(org.locationtech.jts.geom.Envelope envelope)

Returns the vertices intersecting with the specified envelope.

Parameters:

envelope -

Returns:

getEdgesForEnvelope

public Collection<Edge> getEdgesForEnvelope(org.locationtech.jts.geom.Envelope envelope)

Return the edges whose geometry intersect with the specified envelope. Warning: edges w/o geometry will not be indexed.

Parameters:

envelope -

Returns:

getTransitStopForEnvelope

public List<TransitStop> getTransitStopForEnvelope(org.locationtech.jts.geom.Envelope envelope)

Parameters:

envelope -

Returns:

The transit stops within an envelope.

getIntersectionAt

public StreetVertex getIntersectionAt(org.locationtech.jts.geom.Coordinate coordinate)

Parameters:

coordinate - Location to search intersection at. Look in a MAX_CORNER_DISTANCE_METERS radius.

Returns:

The nearest intersection, null if none found.

getVertexForLocation

public Vertex getVertexForLocation(GenericLocation loc,
                                   RoutingRequest options,
                                   boolean endVertex)

Finds the appropriate vertex for this location.

Parameters:

loc -

options -

endVertex: - whether this is a start vertex (if it's false) or end vertex (if it's true)

Returns:

toString

public String toString()

Overrides:

toString in class Object

getSampleVertexAt

public Vertex getSampleVertexAt(org.locationtech.jts.geom.Coordinate coordinate,
                                boolean dest)

Get a vertex at a given coordinate, using the same logic as in Samples. Used in Analyst so that origins and destinations are linked the same way.

getStreetSplitter

public StreetSplitter getStreetSplitter()

Getter method for StreetSplitter

Returns:

StreetSplitter