org.opentripplanner.api.resource

Class SurfaceResource

java.lang.Object

org.opentripplanner.api.common.RoutingResource

org.opentripplanner.api.resource.SurfaceResource

@Path(value="/surfaces")
 @Produces(value="application/json")
public class SurfaceResource
extends RoutingResource

Surfaces cannot be isolated per-router because sometimes you want to compare two surfaces from different router IDs. Though one could question whether that really makes sense (perhaps alternative scenarios should be "within" the same router)

Field Summary

Fields inherited from class org.opentripplanner.api.common.RoutingResource

arriveBy, bannedAgencies, bannedRoutes, bannedStops, bannedStopsHard, bannedTrips, batch, bikeBoardCost, bikeSpeed, bikeSwitchCost, bikeSwitchTime, clampInitialWait, date, disableRemainingWeightHeuristic, flexFlagStopBufferSize, flexIgnoreDrtAdvanceBookMin, flexUseEligibilityServices, flexUseReservationServices, fromPlace, ignoreRealtimeUpdates, intermediatePlaces, maxPreTransitTime, maxTransfers, maxWalkDistance, minTransferTime, modes, nonpreferredTransferPenalty, numItineraries, optimize, otherThanPreferredRoutesPenalty, otpServer, preferredAgencies, preferredRoutes, reverseOptimizeOnTheFly, routerId, showIntermediateStops, startTransitStopId, startTransitTripId, time, toPlace, transferPenalty, triangleSafetyFactor, triangleSlopeFactor, triangleTimeFactor, unpreferredAgencies, unpreferredRoutes, waitAtBeginningFactor, waitReluctance, walkBoardCost, walkReluctance, walkSpeed, wheelchair, whiteListedAgencies, whiteListedRoutes

Constructor Summary

Constructors

Constructor and Description
SurfaceResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createSurface(int cutoffMinutes, String routerId)
javax.ws.rs.core.Response	differenceTileGet(Integer surfaceId, Integer compareToSurfaceId, int x, int y, int z) Renders a raster tile for showing the difference between two TimeSurfaces.
javax.ws.rs.core.Response	getIndicator(Integer surfaceId, String targetPointSetId, String originPointSetId, boolean detail) Evaluate a surface at all the points in a PointSet.
javax.ws.rs.core.Response	getIsochrone(Integer surfaceId, int spacing, int nMax) Create vector isochrones for a surface.
static List<IsochroneData>	getIsochronesAccumulative(TimeSurface surf, int spacing, int nMax) Use Laurent's accumulative grid sampler.
javax.ws.rs.core.Response	getRaster(Integer surfaceId, Integer width, Integer height, Double resolution, IsoTimeParameter time, MIMEImageFormat format, CRSParameter crs) Produce a single grayscale raster of travel time, like travel time tiles but not broken into tiles.
javax.ws.rs.core.Response	getTimeSurfaceList() List all the available surfaces.
javax.ws.rs.core.Response	getTimeSurfaceList(Integer surfaceId) Describe a specific surface.
javax.ws.rs.core.Response	tileGet(Integer surfaceId, int x, int y, int z)

Methods inherited from class org.opentripplanner.api.common.RoutingResource

buildRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

SurfaceResource

public SurfaceResource()

Method Detail

createSurface

@POST
public javax.ws.rs.core.Response createSurface(@QueryParam(value="cutoffMinutes") @DefaultValue(value="90")
                                                     int cutoffMinutes,
                                                     @QueryParam(value="routerId")
                                                     String routerId)

getTimeSurfaceList

@GET
public javax.ws.rs.core.Response getTimeSurfaceList()

List all the available surfaces.

getTimeSurfaceList

@GET
 @Path(value="/{surfaceId}")
public javax.ws.rs.core.Response getTimeSurfaceList(@PathParam(value="surfaceId")
                                                                                      Integer surfaceId)

Describe a specific surface.

getIndicator

@GET
 @Path(value="/{surfaceId}/indicator")
public javax.ws.rs.core.Response getIndicator(@PathParam(value="surfaceId")
                                                                                          Integer surfaceId,
                                                                                          @QueryParam(value="targets")
                                                                                          String targetPointSetId,
                                                                                          @QueryParam(value="origins")
                                                                                          String originPointSetId,
                                                                                          @QueryParam(value="detail")
                                                                                          boolean detail)

Evaluate a surface at all the points in a PointSet. This sends back a ResultSet serialized as JSON. Normally we return historgrams with the number of points reached (in field 'counts') and the number of opportunities reached (i.e. the sum of the magnitudes of all points reached) in each one-minute bin of travel time.

Parameters:

detail - if true, include the travel time to every point in the pointset (which is in fact an ordered list)

getIsochrone

@GET
 @Path(value="/{surfaceId}/isochrone")
public javax.ws.rs.core.Response getIsochrone(@PathParam(value="surfaceId")
                                                                                          Integer surfaceId,
                                                                                          @QueryParam(value="spacing")
                                                                                          int spacing,
                                                                                          @QueryParam(value="nMax") @DefaultValue(value="1")
                                                                                          int nMax)

Create vector isochrones for a surface.

tileGet

@Path(value="/{surfaceId}/isotiles/{z}/{x}/{y}.png")
 @GET
 @Produces(value="image/png")
public javax.ws.rs.core.Response tileGet(@PathParam(value="surfaceId")
                                                                                                                                  Integer surfaceId,
                                                                                                                                  @PathParam(value="x")
                                                                                                                                  int x,
                                                                                                                                  @PathParam(value="y")
                                                                                                                                  int y,
                                                                                                                                  @PathParam(value="z")
                                                                                                                                  int z)
                                                                                                                           throws Exception

Throws:

Exception

differenceTileGet

@Path(value="/{surfaceId}/differencetiles/{compareToSurfaceId}/{z}/{x}/{y}.png")
 @GET
 @Produces(value="image/png")
public javax.ws.rs.core.Response differenceTileGet(@PathParam(value="surfaceId")
                                                                                                                                                                        Integer surfaceId,
                                                                                                                                                                        @PathParam(value="compareToSurfaceId")
                                                                                                                                                                        Integer compareToSurfaceId,
                                                                                                                                                                        @PathParam(value="x")
                                                                                                                                                                        int x,
                                                                                                                                                                        @PathParam(value="y")
                                                                                                                                                                        int y,
                                                                                                                                                                        @PathParam(value="z")
                                                                                                                                                                        int z)
                                                                                                                                                                 throws Exception

Renders a raster tile for showing the difference between two TimeSurfaces. This service is included as a way to provide difference tiles using existing mechanisms in OTP. TODO However, there is some room for debate around how differences are expressed in URLs. We may want a more general purpose mechanism for combining time surfaces. For example you could make a web service request to create a time surface A-B or A+B, and the server would give you an ID for that surface, and then you could use that ID anywhere a surface ID is required. Perhaps internally there would be some sort of DifferenceTimeSurface subclass that could just drop in anywhere TimeSurface is used. This approach would be more stateful but more flexible.

Parameters:

surfaceId - The id of the first surface

compareToSurfaceId - The id of of the surface, which is compared to the first surface

Throws:

Exception

getIsochronesAccumulative

public static List<IsochroneData> getIsochronesAccumulative(TimeSurface surf,
                                                            int spacing,
                                                            int nMax)

Use Laurent's accumulative grid sampler. Cutoffs in minutes. The grid and Delaunay triangulation are cached, so subsequent requests are very fast.

Parameters:

spacing - the number of minutes between isochrones

Returns:

a list of evenly-spaced isochrones up to the timesurface's cutoff point

getRaster

@Path(value="/{surfaceId}/raster")
 @GET
 @Produces(value="image/*")
public javax.ws.rs.core.Response getRaster(@PathParam(value="surfaceId")
                                                                                                                Integer surfaceId,
                                                                                                                @QueryParam(value="width") @DefaultValue(value="1024")
                                                                                                                Integer width,
                                                                                                                @QueryParam(value="height") @DefaultValue(value="768")
                                                                                                                Integer height,
                                                                                                                @QueryParam(value="resolution")
                                                                                                                Double resolution,
                                                                                                                @QueryParam(value="time")
                                                                                                                IsoTimeParameter time,
                                                                                                                @QueryParam(value="format") @DefaultValue(value="image/geotiff")
                                                                                                                MIMEImageFormat format,
                                                                                                                @QueryParam(value="crs") @DefaultValue(value="EPSG:4326")
                                                                                                                CRSParameter crs)
                                                                                                         throws Exception

Produce a single grayscale raster of travel time, like travel time tiles but not broken into tiles.

Throws:

Exception