Feature: allow direct on-demand service to limited zones

ansoncfit · ansoncfit · commit 70979b87d5da · 2022-02-06T16:27:56.000-05:00
diff --git a/src/main/java/com/conveyal/r5/analyst/TravelTimeComputer.java b/src/main/java/com/conveyal/r5/analyst/TravelTimeComputer.java
@@ -222,9 +222,12 @@ public OneOriginResult computeTravelTimes() {
                 );
 
                 if (accessService != NO_WAIT_ALL_STOPS) {
-                    LOG.info("Delaying direct travel times by {} seconds (to wait for {} pick-up).",
+                    LOG.info("Delaying on-demand service by {} seconds (to wait for {} pick-up).",
                             accessService.waitTimeSeconds, accessMode);
-                    if (accessService.stopsReachable != null) {
+                    if (accessService.serviceArea != null) {
+                        pointSetTimes.incrementWithinAndClip(accessService.serviceArea, accessService.waitTimeSeconds);
+                    }
+                    else if (accessService.stops != null) {
                         // Disallow direct travel to destination if pickupDelay zones are associated with stops.
                         pointSetTimes = PointSetTimes.allUnreached(destinations);
                     } else {
diff --git a/src/main/java/com/conveyal/r5/analyst/scenario/PickupDelay.java b/src/main/java/com/conveyal/r5/analyst/scenario/PickupDelay.java
@@ -66,9 +66,17 @@ public class PickupDelay extends Modification {
     public String idAttribute = "id";
 
     /**
-     * A JSON map from polygon IDs to lists of polygon IDs. If any stop_id is specified for a polygon, service is
-     * only allowed between the polygon and the stops (i.e. no direct trips). If no stop_ids are specified,
-     * passengers boarding an on-demand service in a pick-up zone should be able to alight anywhere.
+     * A JSON map from polygon IDs to lists of polygon IDs, representing origin zones and allowable destination zones
+     * for direct legs. For example, "a":["b","c"] allows passengers to travel from zone a to destinations in zones
+     * b and c. For now, this does not enable use of stops in zones b and c for onward travel, so in most cases,
+     * these zones should be explicitly repeated in stopsForZone.
+     */
+    public Map<String, Set<String>> destinationsForZone;
+
+    /**
+     * A JSON map from polygon IDs to lists of polygon IDs, representing origin zones and allowable boarding stops
+     * for access legs. For example "a":["d","e"] allows passengers to travel from zone a to transit stops in zones d
+     * and e.
      */
     public Map<String, Set<String>> stopsForZone;
 
@@ -114,58 +122,68 @@ public boolean resolve (TransportNetwork network) {
             // Collect any errors from the IndexedPolygonCollection construction, so they can be seen in the UI.
             errors.addAll(polygons.getErrors());
             // Handle pickup service to stop mapping if supplied in the modification JSON.
-            if (stopsForZone == null) {
-                this.pickupWaitTimes = new PickupWaitTimes(polygons, null, Collections.emptySet(), this.streetMode);
+            if (stopsForZone == null && destinationsForZone == null) {
+                this.pickupWaitTimes = new PickupWaitTimes(
+                        polygons,
+                        null,
+                        null,
+                        Collections.emptySet(),
+                        this.streetMode
+                );
             } else {
-                // Iterate over all zone-stop mappings and resolve them against the network.
+                // Iterate over all zone-zone mappings and resolve them against the network.
                 // Because they are used in lambda functions, these variables must be final and non-null.
                 // That is why there's a separate PickupWaitTimes constructor call above with a null parameter.
                 final Map<ModificationPolygon, TIntSet> stopNumbersForZonePolygon = new HashMap<>();
-                final Map<ModificationPolygon, PickupWaitTimes.EgressService> egressServices = new HashMap<>();
-                if (stopsForZone.isEmpty()) {
-                    errors.add("If stopsForZone is specified, it must be non-empty.");
-                }
-                stopsForZone.forEach((zonePolygonId, stopPolygonIds) -> {
-                    ModificationPolygon zonePolygon = polygons.getById(zonePolygonId);
-                    if (zonePolygon == null) {
-                        errors.add("Could not find zone polygon with ID: " + zonePolygonId);
-                    }
-                    TIntSet stopNumbers = stopNumbersForZonePolygon.get(zonePolygon);
-                    if (stopNumbers == null) {
-                        stopNumbers = new TIntHashSet();
-                        stopNumbersForZonePolygon.put(zonePolygon, stopNumbers);
-                    }
-                    for (String stopPolygonId : stopPolygonIds) {
-                        ModificationPolygon stopPolygon = polygons.getById(stopPolygonId);
-                        if (stopPolygon == null) {
-                            errors.add("Could not find stop polygon with ID: " + stopPolygonId);
+                final Map<ModificationPolygon, Geometry> destinationsForZonePolygon = new HashMap<>();
+                final Map<ModificationPolygon, EgressService> egressServices = new HashMap<>();
+                if (destinationsForZone != null) {
+                    destinationsForZone.forEach((zonePolygonId, destinationPolygonIds) -> {
+                        ModificationPolygon zonePolygon = tryToGetPolygon(polygons, zonePolygonId, "zone");
+                        for (String id : destinationPolygonIds) {
+                            ModificationPolygon destinationPolygon = tryToGetPolygon(polygons, id, "destination");
+                            destinationsForZonePolygon.put(zonePolygon, destinationPolygon.polygonal);
                         }
-                        TIntSet stops = network.transitLayer.findStopsInGeometry(stopPolygon.polygonal);
-                        if (stops.isEmpty()) {
-                            errors.add("Stop polygon did not contain any stops: " + stopPolygonId);
+                    });
+                }
+                if (stopsForZone != null) {
+                    stopsForZone.forEach((zonePolygonId, stopPolygonIds) -> {
+                        ModificationPolygon zonePolygon = tryToGetPolygon(polygons, zonePolygonId, "zone");
+                        TIntSet stopNumbers = stopNumbersForZonePolygon.get(zonePolygon);
+                        if (stopNumbers == null) {
+                            stopNumbers = new TIntHashSet();
+                            stopNumbersForZonePolygon.put(zonePolygon, stopNumbers);
                         }
-                        stopNumbers.addAll(stops);
-                        // Derive egress services from this pair of polygons
-                        double egressWaitMinutes = stopPolygon.data;
-                        if (egressWaitMinutes >= 0) {
-                            // This stop polygon can be used on the egress end of a trip.
-                            int egressWaitSeconds = (int) (egressWaitMinutes * 60);
-                            Geometry serviceArea = zonePolygon.polygonal;
-                            PickupWaitTimes.EgressService egressService = egressServices.get(stopPolygon);
-                            if (egressService != null) {
-                                // Merge service are with any other service polygons associated with this stop polygon.
-                                serviceArea = serviceArea.union(egressService.serviceArea);
+                        for (String stopPolygonId : stopPolygonIds) {
+                            ModificationPolygon stopPolygon = tryToGetPolygon(polygons, stopPolygonId, "stop");
+                            TIntSet stops = network.transitLayer.findStopsInGeometry(stopPolygon.polygonal);
+                            if (stops.isEmpty()) {
+                                errors.add("Stop polygon did not contain any stops: " + stopPolygonId);
+                            }
+                            stopNumbers.addAll(stops);
+                            // Derive egress services from this pair of polygons
+                            double egressWaitMinutes = stopPolygon.data;
+                            if (egressWaitMinutes >= 0) {
+                                // This stop polygon can be used on the egress end of a trip.
+                                int egressWaitSeconds = (int) (egressWaitMinutes * 60);
+                                Geometry serviceArea = zonePolygon.polygonal;
+                                EgressService egressService = egressServices.get(stopPolygon);
+                                if (egressService != null) {
+                                    // Merge service area with any other service polygons associated with this stop polygon.
+                                    serviceArea = serviceArea.union(egressService.serviceArea);
+                                }
+                                egressService = new EgressService(egressWaitSeconds, stops, serviceArea);
+                                egressServices.put(stopPolygon, egressService);
                             }
-                            egressService = new PickupWaitTimes.EgressService(egressWaitSeconds, stops, serviceArea);
-                            egressServices.put(stopPolygon, egressService);
                         }
-                    }
-                });
+
+                    });
+                }
                 // TODO filter out polygons that aren't keys in stopsForZone using new IndexedPolygonCollection constructor
-                // egress wait times for stop numbers
                 this.pickupWaitTimes = new PickupWaitTimes(
                         polygons,
                         stopNumbersForZonePolygon,
+                        destinationsForZonePolygon,
                         egressServices.values(),
                         this.streetMode
                 );
@@ -177,6 +195,14 @@ public boolean resolve (TransportNetwork network) {
         return errors.size() > 0;
     }
 
+    private ModificationPolygon tryToGetPolygon (IndexedPolygonCollection polygons, String id, String label) {
+        ModificationPolygon polygon = polygons.getById(id);
+        if (polygon == null) {
+            errors.add("Could not find " + label + " polygon with ID: " + id);
+        }
+        return polygon;
+    }
+
     @Override
     public boolean apply (TransportNetwork network) {
         // network.streetLayer is already a protective copy made by method Scenario.applyToTransportNetwork.
diff --git a/src/main/java/com/conveyal/r5/analyst/scenario/PickupWaitTimes.java b/src/main/java/com/conveyal/r5/analyst/scenario/PickupWaitTimes.java
@@ -35,10 +35,18 @@ public class PickupWaitTimes {
      * ends, it should contain even polygons whose wait time data is negative (indicating they can't be used on access)
      * because they may still be used for egress. TODO Clarify -- this implies stop zones should have delay = -1? But
      * that's not congruent with egressWaitMinutes >= 0 in PickupDelay.
-     * If the Map is not present (null) then all the zones allow access to any stop in the network.
+     * If this and destinationAreasForZonePolygon are both null, then all the zones allow access to any stop in the
+     * network.
      */
     private final Map<ModificationPolygon, TIntSet> stopNumbersForZonePolygon;
 
+    /**
+     * Map associating each on-demand pick-up zone with specific areas to which direct service (without using a
+     * scheduled transit mode) is provided. If this and stopNumbersForZonePolygon are both null, then all the zones
+     * provide service to all destinations.
+     */
+    private final Map<ModificationPolygon, Geometry> destinationAreasForZonePolygon;
+
     private final TIntObjectMap<EgressService> egressServiceForStop;
 
     // A temporary reversed Multimap should be made, maybe only when building the egress tables, mapping each stop
@@ -57,14 +65,16 @@ public class PickupWaitTimes {
     public PickupWaitTimes (
         IndexedPolygonCollection polygons,
         Map<ModificationPolygon, TIntSet> stopNumbersForZonePolygon,
+        Map<ModificationPolygon, Geometry> destinationAreasForZonePolygon,
         Collection<EgressService> egressServices,
         StreetMode streetMode
     ) {
         this.polygons = polygons;
         this.stopNumbersForZonePolygon = stopNumbersForZonePolygon;
+        this.destinationAreasForZonePolygon = destinationAreasForZonePolygon;
         this.egressServiceForStop = new TIntObjectHashMap<>();
         for (EgressService egressService : egressServices) {
-            egressService.egressStops.forEach(stop -> {
+            egressService.stops.forEach(stop -> {
                 egressServiceForStop.put(stop, egressService);
                 return true;
             });
@@ -75,7 +85,8 @@ public PickupWaitTimes (
     /**
      * Given a particular departure location, get a description of the on-demand pickup service available there.
      * Currently this chooses just one "best" zone polygon based on location and priority values in the polygons.
-     * @return an AccessService with the wait time to be picked up, and any restrictions on reachable stops.
+     * @return an AccessService with the wait time to be picked up, and any restrictions on reachable stops and
+     * service areas
      */
     public AccessService getAccessService (double lat, double lon) {
         Point point = GeometryUtils.geometryFactory.createPoint(new Coordinate(lon, lat));
@@ -97,7 +108,10 @@ public AccessService getAccessService (double lat, double lon) {
                 stopsReachable = new TIntHashSet();
             }
         }
-        return new AccessService(waitTimeSeconds, stopsReachable);
+
+        Geometry directAreasReachable = destinationAreasForZonePolygon.get(polygon);
+
+        return new AccessService(waitTimeSeconds, stopsReachable, directAreasReachable);
     }
 
     /**
@@ -108,67 +122,6 @@ public EgressService getEgressService (int stopNumber) {
         return egressServiceForStop.get(stopNumber);
     }
 
-    // TODO superclass Service contains all fields, and is the type of these two constants?
-
-    /** Special instance representing situations where a service is defined, but not available at this location. */
-    public static final AccessService NO_SERVICE_HERE = new AccessService(-1, null);
-
-    /** Special instance representing no on-demand service defined, so we can access all stops with no wait. */
-    public static final AccessService NO_WAIT_ALL_STOPS = new AccessService(0, null);
-
-    /**
-     * This represents an on-demand service available at a particular departure location.
-     * This is the result of evaluating the PickupWaitTimes at a particular place.
-     * Alternatively instead of defining this data-holder class we could allow passing a travel time map into a method
-     * on this class, and have this class transform it.
-     */
-    public static class AccessService {
-
-        /**
-         * The amount of time you have to wait at this location (in seconds) to be picked up on demand. Zero if you can
-         * be picked up immediately (e.g. a taxi stand outside a station), -1 if no service is available at all.
-         */
-        public final int waitTimeSeconds;
-
-        /**
-         * If a limitation is placed on the transit stops one is allowed to access using this service, this is the
-         * set of allowed stops. This is null if all stops are reachable and no filtering should happen.
-         * If we eventually want to reflect multiple services with different waits, we could instead return a
-         * TIntIntMap from allowed stop indexes to wait times.
-         */
-        public final TIntSet stopsReachable;
-
-        public AccessService (int waitTimeSeconds, TIntSet stopsReachable) {
-            this.waitTimeSeconds = waitTimeSeconds;
-            this.stopsReachable = stopsReachable;
-        }
-    }
-
-    // TODO pull all of these classes out into an on-demand Java package
-    // It's a bit weird that EgressServices are pre-computed and AccessService instances are built on demand.
-    // The two classes could be almost identical with the exception of comments. One could extend the other.
-    public static class EgressService {
-
-        public final int waitTimeSeconds;
-
-        public final TIntSet egressStops;
-
-        /**
-         * The geographic area one is allowed to access using this service. If null, no geographic restriction applies.
-         * This may be the union of several polygons that were all associated with one stop or group of stops.
-         * In floating point WGS84 (lon, lat) coordinates. Should be a polygon or multipolygon.
-         */
-        public final Geometry serviceArea;
-
-        public EgressService (int waitTimeSeconds, TIntSet egressStops, Geometry serviceArea) {
-            if (waitTimeSeconds < 0) throw new AssertionError("Wait times should always be non-negative.");
-            this.waitTimeSeconds = waitTimeSeconds;
-            this.egressStops = egressStops;
-            this.serviceArea = serviceArea;
-        }
-
-    }
-
     public int getDefaultWaitInSeconds() {
         return (int) (polygons.defaultData * 60);
     }
diff --git a/src/main/java/com/conveyal/r5/streets/PointSetTimes.java b/src/main/java/com/conveyal/r5/streets/PointSetTimes.java
@@ -1,7 +1,10 @@
 package com.conveyal.r5.streets;
 
+import com.conveyal.gtfs.Geometries;
 import com.conveyal.r5.analyst.PointSet;
 import com.conveyal.r5.profile.FastRaptorWorker;
+import org.locationtech.jts.geom.Coordinate;
+import org.locationtech.jts.geom.Geometry;
 
 import java.util.Arrays;
 
@@ -33,6 +36,18 @@ public static PointSetTimes allUnreached (PointSet pointSet) {
         return new PointSetTimes(pointSet, times);
     }
 
+    public void incrementWithinAndClip(Geometry area, int seconds) {
+        for (int i = 0; i < travelTimes.length; i++) {
+            if (travelTimes[i] != UNREACHED &&
+                area.contains(Geometries.geometryFactory.createPoint(new Coordinate(pointSet.getLon(i), pointSet.getLat(i)))))
+            {
+                travelTimes[i] += seconds;
+            } else {
+                travelTimes[i] = UNREACHED;
+            }
+        }
+    }
+
     public int size()  {
         return travelTimes.length;
     }
diff --git a/src/main/java/com/conveyal/r5/streets/StreetLayer.java b/src/main/java/com/conveyal/r5/streets/StreetLayer.java
@@ -54,7 +54,6 @@
 
 import static com.conveyal.r5.analyst.scenario.ondemand.AccessService.NO_WAIT_ALL_STOPS;
 import static com.conveyal.r5.common.GeometryUtils.checkWgsEnvelopeSize;
-import static com.conveyal.r5.streets.VertexStore.fixedDegreeGeometryToFloating;
 
 /**
  * This class stores the street network. Information about public transit is in a separate layer.
