org.opentripplanner.graph_builder.module

Class NearbyStopFinder

java.lang.Object

org.opentripplanner.graph_builder.module.NearbyStopFinder

public class NearbyStopFinder
extends Object

These library functions are used by the streetless and streetful stop linkers, and in profile transfer generation. Ideally they could also be used in long distance mode and profile routing for the street segments. For each stop, it finds the closest stops on all other patterns. This reduces the number of transfer edges significantly compared to simple radius-constrained all-to-all stop linkage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NearbyStopFinder.StopAtDistance Represents a stop that is comparable to other stops on the basis of its distance from some point.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	useStreets

Constructor Summary

Constructors

Constructor and Description
NearbyStopFinder(Graph graph, double radiusMeters) Construct a NearbyStopFinder for the given graph and search radius, choosing whether to search via the street network or straight line distance based on the presence of OSM street data in the graph.
NearbyStopFinder(Graph graph, double radiusMeters, boolean useStreets) Construct a NearbyStopFinder for the given graph and search radius.

Method Summary

Modifier and Type	Method and Description
List<NearbyStopFinder.StopAtDistance>	findNearbyStops(Vertex vertex) Return all stops within a certain radius of the given vertex, using network distance along streets.
Set<NearbyStopFinder.StopAtDistance>	findNearbyStopsConsideringPatterns(Vertex vertex) Find all unique nearby stops that are the closest stop on some trip pattern.
List<NearbyStopFinder.StopAtDistance>	findNearbyStopsEuclidean(Vertex originVertex) Return all stops within a certain radius of the given vertex, using straight-line distance independent of streets.
List<NearbyStopFinder.StopAtDistance>	findNearbyStopsViaStreets(Vertex originVertex) Return all stops within a certain radius of the given vertex, using network distance along streets.
static NearbyStopFinder.StopAtDistance	stopAtDistanceForState(State state) Given a State at a TransitStop, bundle the TransitStop together with information about how far away it is and the geometry of the path leading up to the given State.

Methods inherited from class java.lang.Object

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

Field Detail

useStreets

public final boolean useStreets

Constructor Detail

NearbyStopFinder

public NearbyStopFinder(Graph graph,
                        double radiusMeters)

Construct a NearbyStopFinder for the given graph and search radius, choosing whether to search via the street network or straight line distance based on the presence of OSM street data in the graph.

NearbyStopFinder

public NearbyStopFinder(Graph graph,
                        double radiusMeters,
                        boolean useStreets)

Construct a NearbyStopFinder for the given graph and search radius.

Parameters:

useStreets - if true, search via the street network instead of using straight-line distance.

Method Detail

findNearbyStopsConsideringPatterns

public Set<NearbyStopFinder.StopAtDistance> findNearbyStopsConsideringPatterns(Vertex vertex)

Find all unique nearby stops that are the closest stop on some trip pattern. Note that the result will include the origin vertex if it is an instance of TransitStop. This is intentional: we don't want to return the next stop down the line for trip patterns that pass through the origin vertex.

findNearbyStops

public List<NearbyStopFinder.StopAtDistance> findNearbyStops(Vertex vertex)

Return all stops within a certain radius of the given vertex, using network distance along streets. Use the correct method depending on whether the graph has street data or not. If the origin vertex is a TransitStop, the result will include it; this characteristic is essential for associating the correct stop with each trip pattern in the vicinity.

findNearbyStopsViaStreets

public List<NearbyStopFinder.StopAtDistance> findNearbyStopsViaStreets(Vertex originVertex)

Return all stops within a certain radius of the given vertex, using network distance along streets. If the origin vertex is a TransitStop, the result will include it.

findNearbyStopsEuclidean

public List<NearbyStopFinder.StopAtDistance> findNearbyStopsEuclidean(Vertex originVertex)

Return all stops within a certain radius of the given vertex, using straight-line distance independent of streets. If the origin vertex is a TransitStop, the result will include it.

stopAtDistanceForState

public static NearbyStopFinder.StopAtDistance stopAtDistanceForState(State state)

Given a State at a TransitStop, bundle the TransitStop together with information about how far away it is and the geometry of the path leading up to the given State. TODO this should probably be merged with similar classes in Profile routing.