org.opentripplanner.graph_builder.linking

Class StreetSplitter

java.lang.Object

org.opentripplanner.graph_builder.linking.StreetSplitter

public class StreetSplitter
extends Object

This class links transit stops to streets by splitting the streets (unless the stop is extremely close to the street intersection). It is intended to eventually completely replace the existing stop linking code, which had been through so many revisions and adaptations to different street and turn representations that it was very glitchy. This new code is also intended to be deterministic in linking to streets, independent of the order in which the JVM decides to iterate over Maps and even in the presence of points that are exactly halfway between multiple candidate linking points. See discussion in pull request #1922, follow up issue #1934, and the original issue calling for replacement of the stop linker, #1305.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DESTRUCTIVE_SPLIT DESTRUCTIVE_SPLIT means edges are split and new edges and vertices are created.
static double	DUPLICATE_WAY_EPSILON_METERS if there are two ways and the distances to them differ by less than this value, we link to both of them
static HashSet<Graph>	graphsWithSplitters
static int	MAX_SEARCH_RADIUS_METERS
static boolean	NON_DESTRUCTIVE_SPLIT NON_DESTRUCTIVE_SPLIT means new temporary edges and vertices are created and no edges are deleted.
static int	WARNING_DISTANCE_METERS

Constructor Summary

Constructors

Constructor and Description
StreetSplitter(Graph graph) Construct a new StreetSplitter.
StreetSplitter(Graph graph, HashGridSpatialIndex<Edge> hashGridSpatialIndex, org.locationtech.jts.index.SpatialIndex transitStopIndex) Construct a new StreetSplitter.

Method Summary

Modifier and Type	Method and Description
Boolean	getAddExtraEdgesToAreas()
void	linkAllStationsToGraph() Link all relevant vertices to the street network.
Vertex	linkOriginDestination(GenericLocation location, RoutingRequest options, boolean endVertex) Used to link origin and destination points to graph non destructively.
boolean	linkToClosestWalkableEdge(Vertex vertex, boolean destructiveSplitting, boolean createSemiPermanentEdges) Link this vertex into the graph to the closest walkable edge.
boolean	linkToGraph(Vertex vertex, TraverseMode traverseMode, RoutingRequest options, boolean destructiveSplitting, boolean createSemiPermanentEdges) Link a vertex into the graph to the closest edge that allows the traversal of the specified mode.
boolean	linkToGraph(Vertex vertex, TraverseModeSet traverseModeSet, RoutingRequest options, boolean destructiveSplitting, boolean createSemiPermanentEdges) Link this vertex into the graph (ie, connect the vertex to other vertices in the graph by creating one or more new edges/vertexes which are then connected to the other vertices/edges of the graph.
void	removeEdgeFromIdx(StreetEdge edge)
void	removeRentalStationVertexAndAssociatedSemiPermanentVerticesAndEdges(RentalStationVertex rentalStationVertex) Helper method for removing all vertices and edges associated with a SemiPermanentSplitterVertex.
void	setAddExtraEdgesToAreas(Boolean addExtraEdgesToAreas)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SEARCH_RADIUS_METERS

public static final int MAX_SEARCH_RADIUS_METERS

See Also:

Constant Field Values

WARNING_DISTANCE_METERS

public static final int WARNING_DISTANCE_METERS

See Also:

Constant Field Values

DESTRUCTIVE_SPLIT

public static final boolean DESTRUCTIVE_SPLIT

DESTRUCTIVE_SPLIT means edges are split and new edges and vertices are created. This should occur when linking transit stops etc. during graph building or inserting floating bicycles in a bikeshare system in realtime into the graph. When these splits occur, a spatial index of all edges should be kept updated, otherwise there will appear to be snapping issues as observed in https://github.com/opentripplanner/OpenTripPlanner/issues/2758.

See Also:

Constant Field Values

NON_DESTRUCTIVE_SPLIT

public static final boolean NON_DESTRUCTIVE_SPLIT

NON_DESTRUCTIVE_SPLIT means new temporary edges and vertices are created and no edges are deleted. This is used in individual requests when temporarily inserting the origin/destination into the graph. The spatial index of street edges should not be updated to include these temporary edges.

See Also:

Constant Field Values

DUPLICATE_WAY_EPSILON_METERS

public static final double DUPLICATE_WAY_EPSILON_METERS

if there are two ways and the distances to them differ by less than this value, we link to both of them

See Also:

Constant Field Values

graphsWithSplitters

public static final HashSet<Graph> graphsWithSplitters

Constructor Detail

StreetSplitter

public StreetSplitter(Graph graph,
                      HashGridSpatialIndex<Edge> hashGridSpatialIndex,
                      org.locationtech.jts.index.SpatialIndex transitStopIndex)

Construct a new StreetSplitter. IMPORTANT NOTE: Only one StreetSplitter should be active on a graph at any given time. This is because any newly-created split edges in this street splitter won't show up in the index of the other street splitters (and potentially StreetVertexIndexServices).

Parameters:

hashGridSpatialIndex - If not null this index is used instead of creating new one

transitStopIndex - Index of all transitStops which is generated in org.opentripplanner.routing.impl.StreetVertexIndexServiceImpl

StreetSplitter

public StreetSplitter(Graph graph)

Construct a new StreetSplitter. Be aware that only one StreetSplitter should be active on a graph at any given time. StreetSplitter generates index on graph and splits destructively (used in transit splitter)

Parameters:

graph -

Method Detail

linkAllStationsToGraph

public void linkAllStationsToGraph()

Link all relevant vertices to the street network. This is to be called only during graph building in order to destructively split edges in order to create permanent edges.

linkToClosestWalkableEdge

public boolean linkToClosestWalkableEdge(Vertex vertex,
                                         boolean destructiveSplitting,
                                         boolean createSemiPermanentEdges)

Link this vertex into the graph to the closest walkable edge.

Parameters:

vertex - The vertex to be linked.

destructiveSplitting - If true splitting is permanent (Used when linking transit stops etc.) when false the original edge is kept in the graph after creating split edges.

createSemiPermanentEdges - If true, semi-permanent edges and a semi-permanent splitter vertex is created. These vertices and edges are intended to be kept in the graph and linked to during subsequent requests, but might be removed at a later time. For example a floating bike rental may need to be removed from the graph once the data is updated to show that the floating bike rental no longer exists or if its location has significantly changed.

linkToGraph

public boolean linkToGraph(Vertex vertex,
                           TraverseMode traverseMode,
                           RoutingRequest options,
                           boolean destructiveSplitting,
                           boolean createSemiPermanentEdges)

Link a vertex into the graph to the closest edge that allows the traversal of the specified mode.

linkToGraph

public boolean linkToGraph(Vertex vertex,
                           TraverseModeSet traverseModeSet,
                           RoutingRequest options,
                           boolean destructiveSplitting,
                           boolean createSemiPermanentEdges)

Link this vertex into the graph (ie, connect the vertex to other vertices in the graph by creating one or more new edges/vertexes which are then connected to the other vertices/edges of the graph.

Parameters:

vertex - The vertex to be linked.

traverseModeSet - The traverse modes.

options - The routing options.

destructiveSplitting - If true, splitting is permanent (Used when linking transit stops etc). When false the original edge is kept in the graph after creating split edges.

createSemiPermanentEdges - If true, semi-permanent edges and a semi-permanent splitter vertex is created. These vertices and edges are intended to be kept in the graph and linked to during subsequent requests, but might be removed at a later time. For example a floating bike rental may need to be removed from the graph once the data is updated to show that the floating bike rental no longer exists or if its location has significantly changed.

linkOriginDestination

public Vertex linkOriginDestination(GenericLocation location,
                                    RoutingRequest options,
                                    boolean endVertex)

Used to link origin and destination points to graph non destructively. Split edges don't replace existing ones and only temporary edges and vertices are created. Will throw TrivialPathException if origin and destination Location are on the same edge

Parameters:

location -

options -

endVertex - true if this is destination vertex

Returns:

getAddExtraEdgesToAreas

public Boolean getAddExtraEdgesToAreas()

setAddExtraEdgesToAreas

public void setAddExtraEdgesToAreas(Boolean addExtraEdgesToAreas)

removeRentalStationVertexAndAssociatedSemiPermanentVerticesAndEdges

public void removeRentalStationVertexAndAssociatedSemiPermanentVerticesAndEdges(RentalStationVertex rentalStationVertex)

Helper method for removing all vertices and edges associated with a SemiPermanentSplitterVertex. The purpose of a SemiPermanentSplitterVertex is to model access to another vertex (typically a bike/car/vehicle rental station vertex) from an existing set of street vertices. This method removes all edges immediately connected to the given vertex, but also searches outward for Street{Bike/Car/Vehicle}RentalLink edges and associated connected vertices and edges and removes those as well from the graph.

removeEdgeFromIdx

public void removeEdgeFromIdx(StreetEdge edge)