org.opentripplanner.profile

Class RaptorWorkerTimetable

java.lang.Object

org.opentripplanner.profile.RaptorWorkerTimetable

All Implemented Interfaces:

Serializable

public class RaptorWorkerTimetable
extends Object
implements Serializable

A RaptorWorkerTimetable is used by a RaptorWorker to perform large numbers of RAPTOR searches very quickly within a specific time window. It is used heavily in one-to-many profile routing, where we're interested in seeing how access to opportunities varies over time. This is an alternative representation of all the TripTimes in a single TripPattern that are running during a particular time range on a particular day. It packs the times a bit closer together and pre-filters the TripTimes based on whether they are running at all during the time window eliminates run-time checks that need to be performed when we search for the soonest departure. Note: we're not sure this actually provides a major speedup compared to operating directly on TripPatterns and TripTimes. Unlike in "normal" OTP searches, we assume non-overtaking (FIFO) vehicle behavior within a single TripPattern, which is generally the case in clean input data. One key difference here is that profile routing and spatial analysis do not need to take real-time (GTFS-RT) updates into account since they are intended to be generic results describing a scenario in the future.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RaptorWorkerTimetable.BoardingAssumption The assumptions made when boarding a frequency vehicle: best case (no wait), worst case (full headway) and half headway (in some sense the average).

Field Summary

Fields

Modifier and Type	Field and Description
int	dataIndex Index of this pattern in RaptorData
static int	MIN_BOARD_TIME_SECONDS slack required when boarding a transit vehicle
int	mode Mode of this pattern, see constants in com.conveyal.gtfs.model.Route
RaptorWorkerData	raptorData parent raptorworkerdata of this timetable
String	routeId for debugging, the ID of the route this represents
int[]	stopIndices Indices of stops in parent data
int[][]	timesPerTrip

Constructor Summary

Constructors

Constructor and Description
RaptorWorkerTimetable(int nTrips, int nStops)

Method Summary

Modifier and Type	Method and Description
int	findDepartureAfter(int stop, int time) Return the trip index within the pattern of the soonest departure at the given stop number, requiring at least MIN_BOARD_TIME_SECONDS seconds of slack.
static RaptorWorkerTimetable	forAddedPattern(AddTripPattern atp, TimeWindow window, TaskStatistics ts) Create a raptor worker timetable for an added pattern
static RaptorWorkerTimetable	forPattern(Graph graph, TripPattern pattern, TimeWindow window, Scenario scenario, TaskStatistics ts) This is a factory function rather than a constructor to avoid calling the super constructor for rejected patterns.
int	getArrival(int trip, int stop)
int	getDeparture(int trip, int stop)
int	getFrequencyDeparture(int trip, int stop, int time, int previousPattern, FrequencyRandomOffsets offsets)
int	getFrequencyDeparture(int trip, int stop, int time, int previousPattern, FrequencyRandomOffsets offsets, RaptorWorkerTimetable.BoardingAssumption assumption) Get the departure on frequency trip trip at stop stop after time time, with the given boarding assumption.
int	getFrequencyTravelTime(int trip, int from, int to) Get the travel time (departure to arrival) on frequency trip trip, from stop from to stop to.
int	getFrequencyTripCount() Get the number of frequency trips on this pattern (i.e.
boolean	hasFrequencyTrips() Does this timetable have any frequency trips?
boolean	hasScheduledTrips() does this timetable have any scheduled trips?

Methods inherited from class java.lang.Object

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

Field Detail

timesPerTrip

public int[][] timesPerTrip

stopIndices

public int[] stopIndices

Indices of stops in parent data

raptorData

public RaptorWorkerData raptorData

parent raptorworkerdata of this timetable

mode

public int mode

Mode of this pattern, see constants in com.conveyal.gtfs.model.Route

dataIndex

public int dataIndex

Index of this pattern in RaptorData

routeId

public transient String routeId

for debugging, the ID of the route this represents

MIN_BOARD_TIME_SECONDS

public static final int MIN_BOARD_TIME_SECONDS

slack required when boarding a transit vehicle

See Also:

Constant Field Values

Constructor Detail

RaptorWorkerTimetable

public RaptorWorkerTimetable(int nTrips,
                             int nStops)

Method Detail

findDepartureAfter

public int findDepartureAfter(int stop,
                              int time)

Return the trip index within the pattern of the soonest departure at the given stop number, requiring at least MIN_BOARD_TIME_SECONDS seconds of slack.

getArrival

public int getArrival(int trip,
                      int stop)

getDeparture

public int getDeparture(int trip,
                        int stop)

getFrequencyDeparture

public int getFrequencyDeparture(int trip,
                                 int stop,
                                 int time,
                                 int previousPattern,
                                 FrequencyRandomOffsets offsets)

getFrequencyDeparture

public int getFrequencyDeparture(int trip,
                                 int stop,
                                 int time,
                                 int previousPattern,
                                 FrequencyRandomOffsets offsets,
                                 RaptorWorkerTimetable.BoardingAssumption assumption)

Get the departure on frequency trip trip at stop stop after time time, with the given boarding assumption. (Note that the boarding assumption specified may be overridden by transfer rules).

getFrequencyTravelTime

public int getFrequencyTravelTime(int trip,
                                  int from,
                                  int to)

Get the travel time (departure to arrival) on frequency trip trip, from stop from to stop to.

getFrequencyTripCount

public int getFrequencyTripCount()

Get the number of frequency trips on this pattern (i.e. the number of trips in trips.txt, not the number of trips by vehicles)

hasFrequencyTrips

public boolean hasFrequencyTrips()

Does this timetable have any frequency trips?

hasScheduledTrips

public boolean hasScheduledTrips()

does this timetable have any scheduled trips?

forPattern

public static RaptorWorkerTimetable forPattern(Graph graph,
                                               TripPattern pattern,
                                               TimeWindow window,
                                               Scenario scenario,
                                               TaskStatistics ts)

This is a factory function rather than a constructor to avoid calling the super constructor for rejected patterns. BannedRoutes is formatted as agencyid_routeid.

forAddedPattern

public static RaptorWorkerTimetable forAddedPattern(AddTripPattern atp,
                                                    TimeWindow window,
                                                    TaskStatistics ts)

Create a raptor worker timetable for an added pattern