Merge branch 'dev' into abyrd/cost-field-cleanup

Author: abyrd

src/main/java/com/conveyal/r5/analyst/cluster/TransportNetworkConfig.java

@@ -62,4 +62,18 @@ public class TransportNetworkConfig {
      */
     public boolean saveShapes;
 
+    /**
+     * Steepest allowable slope for traversal. If a way has an "incline" tag  (e.g., from OSW or GATIS rather than
+     * a typical OSM source) with an absolute value that exceeds this limit, custom TraversalPermissionLabelers can
+     * remove permissions. Currently implemented only for pedestrians.
+     */
+    public Double maxIncline;
+
+    /**
+     * Whether to exclude pedestrian traversal of ways with highway=stairs tags and nodes with kerb=raised tags. This
+     * option should generally be used with detailed sidewalk networks and a TraversalPermissionLabeler that forces
+     * use of sidewalks (i.e., disallows walking on roadways).
+     */
+    public boolean stepFree;
+
 }

src/main/java/com/conveyal/r5/labeling/NoSidewalkCyclingTraversalPermissionLabeler.java

@@ -0,0 +1,25 @@
+package com.conveyal.r5.labeling;
+
+import com.conveyal.osmlib.Way;
+import com.conveyal.r5.analyst.cluster.TransportNetworkConfig;
+import com.conveyal.r5.streets.EdgeStore;
+
+/**
+ * USTraversalPermissionLabeler, except biking is disallowed on ways with footway=sidewalk tag
+ */
+public class NoSidewalkCyclingTraversalPermissionLabeler extends USTraversalPermissionLabeler {
+    public NoSidewalkCyclingTraversalPermissionLabeler (TransportNetworkConfig config) {
+        super(config);
+    }
+
+    @Override
+    public RoadPermission getPermissions(Way way) {
+        RoadPermission rp = super.getPermissions(way);
+        if (way.hasTag("footway", "sidewalk")) {
+            rp.forward.remove(EdgeStore.EdgeFlag.ALLOWS_BIKE);
+            rp.backward.remove(EdgeStore.EdgeFlag.ALLOWS_BIKE);
+        }
+        return rp;
+    }
+
+}

src/main/java/com/conveyal/r5/labeling/NoSteepInclinesTraversalPermissionLabeler.java

@@ -0,0 +1,35 @@
+package com.conveyal.r5.labeling;
+
+import com.conveyal.osmlib.Way;
+import com.conveyal.r5.analyst.cluster.TransportNetworkConfig;
+import com.conveyal.r5.streets.EdgeStore;
+
+/**
+ * USTraversalPermissionLabeler, except walking is disallowed on ways that allow cars and ways with inclines
+ * steeper than a specified limit.
+ */
+public class NoSteepInclinesTraversalPermissionLabeler extends SidewalkTraversalPermissionLabeler {
+
+    Double maxIncline;
+    public NoSteepInclinesTraversalPermissionLabeler (TransportNetworkConfig config) {
+        super(config);
+        if (config != null) {
+            if (config.maxIncline != null) this.maxIncline = config.maxIncline;
+        }
+    }
+    @Override
+    public RoadPermission getPermissions(Way way) {
+        // Base class (SidewalkTraversalPermissionLabeler) disallows walking on ways that allow cars
+        RoadPermission rp = super.getPermissions(way);
+
+        // Disallow walking on ways with slopes steeper than specified maxIncline
+        if  (maxIncline != null) {
+            if (way.hasTag("incline") && Math.abs(Double.parseDouble(way.getTag("incline"))) > maxIncline) {
+                rp.disallowPedestrians();
+            }
+        }
+
+        return rp;
+    }
+
+}

src/main/java/com/conveyal/r5/labeling/RoadPermission.java

@@ -18,4 +18,10 @@ public RoadPermission(EnumSet<EdgeStore.EdgeFlag> forward,
         this.backward = backward;
 
     }
+
+    public void disallowPedestrians() {
+        this.forward.remove(EdgeStore.EdgeFlag.ALLOWS_PEDESTRIAN);
+        this.backward.remove(EdgeStore.EdgeFlag.ALLOWS_PEDESTRIAN);
+    }
+
 }

src/main/java/com/conveyal/r5/labeling/SidewalkTraversalPermissionLabeler.java

@@ -1,6 +1,7 @@
 package com.conveyal.r5.labeling;
 
 import com.conveyal.osmlib.Way;
+import com.conveyal.r5.analyst.cluster.TransportNetworkConfig;
 import com.conveyal.r5.streets.EdgeStore;
 
 /**
@@ -16,6 +17,10 @@ public class SidewalkTraversalPermissionLabeler extends TraversalPermissionLabel
                 "access=yes");
     }
 
+    public SidewalkTraversalPermissionLabeler (TransportNetworkConfig config) {
+        super(config);
+    }
+
     @Override
     public RoadPermission getPermissions(Way way) {
         RoadPermission rp = super.getPermissions(way);
@@ -24,10 +29,7 @@ public RoadPermission getPermissions(Way way) {
             rp.backward.contains(EdgeStore.EdgeFlag.ALLOWS_CAR) ||
             rp.backward.contains(EdgeStore.EdgeFlag.NO_THRU_TRAFFIC_CAR)
         ) {
-            rp.forward.remove(EdgeStore.EdgeFlag.ALLOWS_PEDESTRIAN);
-            rp.forward.remove(EdgeStore.EdgeFlag.NO_THRU_TRAFFIC_PEDESTRIAN);
-            rp.backward.remove(EdgeStore.EdgeFlag.ALLOWS_PEDESTRIAN);
-            rp.backward.remove(EdgeStore.EdgeFlag.NO_THRU_TRAFFIC_PEDESTRIAN);
+            rp.disallowPedestrians();
         }
         return rp;
     }

src/main/java/com/conveyal/r5/labeling/TraversalPermissionLabeler.java

@@ -1,6 +1,7 @@
 package com.conveyal.r5.labeling;
 
 import com.conveyal.osmlib.Way;
+import com.conveyal.r5.analyst.cluster.TransportNetworkConfig;
 import com.conveyal.r5.streets.EdgeStore;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -29,6 +30,8 @@ public abstract class TraversalPermissionLabeler {
     //This is immutable map of highway tag and boolean which is true if this tag has same road with _link
     static final Map<String, Boolean> validHighwayTags;
 
+    boolean stepFree;
+
     static {
 
         Map<String, Boolean> validHighwayTagsConst;
@@ -63,6 +66,12 @@ public abstract class TraversalPermissionLabeler {
         addPermissions("footway|steps|platform|public_transport=platform|railway=platform|corridor", "access=no;foot=yes");
     }
 
+    public TraversalPermissionLabeler (TransportNetworkConfig config) {
+        if (config != null) {
+            this.stepFree = config.stepFree;
+        }
+    }
+
     public RoadPermission getPermissions(Way way) {
         EnumMap<Node, Label> tree = getTreeForWay(way);
 
@@ -132,6 +141,10 @@ public RoadPermission getPermissions(Way way) {
             applyOppositeBicyclePermissions(way, backward);
         }
 
+        if (stepFree && way.hasTag("highway", "steps")) {
+            forward.remove(EdgeStore.EdgeFlag.ALLOWS_PEDESTRIAN);
+            backward.remove(EdgeStore.EdgeFlag.ALLOWS_PEDESTRIAN);
+        }
 
         return new RoadPermission(forward, backward);
     }

src/main/java/com/conveyal/r5/labeling/USTraversalPermissionLabeler.java

@@ -1,6 +1,8 @@
 package com.conveyal.r5.labeling;
 
 
+import com.conveyal.r5.analyst.cluster.TransportNetworkConfig;
+
 /**
  * Traversal permission labeler for the United States, adding things that differ from the base TraversalPermissionLabeler.
  * https://wiki.openstreetmap.org/wiki/OSM_tags_for_routing/Access-Restrictions#United_States_of_America
@@ -12,4 +14,8 @@ public class USTraversalPermissionLabeler extends TraversalPermissionLabeler {
         addPermissions("cycleway", "bicycle=yes;foot=yes");
     }
 
+    public USTraversalPermissionLabeler (TransportNetworkConfig config) {
+        super(config);
+    }
+
 }

src/main/java/com/conveyal/r5/streets/StreetLayer.java

@@ -12,6 +12,8 @@
 import com.conveyal.r5.api.util.ParkRideParking;
 import com.conveyal.r5.common.GeometryUtils;
 import com.conveyal.r5.labeling.LevelOfTrafficStressLabeler;
+import com.conveyal.r5.labeling.NoSidewalkCyclingTraversalPermissionLabeler;
+import com.conveyal.r5.labeling.NoSteepInclinesTraversalPermissionLabeler;
 import com.conveyal.r5.labeling.RoadPermission;
 import com.conveyal.r5.labeling.SidewalkTraversalPermissionLabeler;
 import com.conveyal.r5.labeling.SpeedLabeler;
@@ -133,6 +135,7 @@ public class StreetLayer implements Serializable, Cloneable {
     public TIntObjectMap<BikeRentalStation> bikeRentalStationMap;
     public TIntObjectMap<ParkRideParking> parkRideLocationsMap;
 
+    private boolean stepFree = false;
     // TODO these are only needed when building the network, should we really be keeping them here in the layer?
     //      We should instead have a network builder that holds references to this transient state. Note initial
     //      approach of specifying a TraversalPermissionLabeler in TransportNetworkConfig.
@@ -209,21 +212,26 @@ public class StreetLayer implements Serializable, Cloneable {
 
     public StreetLayer() {
         speedLabeler = new SpeedLabeler(SpeedConfig.defaultConfig());
-        permissionLabeler = new USTraversalPermissionLabeler();
+        permissionLabeler = new USTraversalPermissionLabeler(null);
     }
 
     public StreetLayer(TransportNetworkConfig config) {
         this();
         if (config != null) {
             permissionLabeler = switch (config.traversalPermissionLabeler) {
-                case "sidewalk" -> new SidewalkTraversalPermissionLabeler();
-                case null -> new USTraversalPermissionLabeler();
+                case "sidewalk" -> new SidewalkTraversalPermissionLabeler(config);
+                case "noSidewalkCycling" -> new NoSidewalkCyclingTraversalPermissionLabeler(config);
+                case "noSteepWays" -> new NoSteepInclinesTraversalPermissionLabeler(config);
+                case null -> new USTraversalPermissionLabeler(config);
                 default -> throw new IllegalArgumentException(
                         "Unknown traversal permission labeler: " + config.traversalPermissionLabeler
                 );
             };
+
+            stepFree = config.stepFree;
+            
         } else {
-            permissionLabeler = new USTraversalPermissionLabeler();
+            permissionLabeler = new USTraversalPermissionLabeler(null);
         }
     }
 
@@ -334,7 +342,7 @@ void loadFromOsm (OSM osm, boolean removeIslands, boolean saveVertexIndex) {
                 }
                 final boolean intersection = osm.intersectionNodes.contains(way.nodes[n]);
                 final boolean lastNode = (n == (way.nodes.length - 1));
-                if (intersection || lastNode || isImpassable(node)) {
+                if (intersection || lastNode || isImpassable(node, stepFree)) {
                     makeEdgePair(way, beginIdx, n, entry.getKey());
                     beginIdx = n;
                 }
@@ -1059,7 +1067,7 @@ private int getVertexIndexForOsmNode(long osmNodeId) {
                 if (node.hasTag("highway", "traffic_signals")) {
                     vertexStore.setFlag(vertexIndex, TRAFFIC_SIGNAL);
                 }
-                if (isImpassable(node)) {
+                if (isImpassable(node, stepFree)) {
                     vertexStore.setFlag(vertexIndex, IMPASSABLE);
                 }
                 vertexIndexForOsmNode.put(osmNodeId, vertexIndex);
@@ -1113,7 +1121,7 @@ private static short speedToShort(Float speed) {
      *
      * Ideally such areas would be treated as no-through-traffic but that would involve more tricky heuristics.
      */
-    private static boolean isImpassable (Node node) {
+    private static boolean isImpassable (Node node, boolean requireStepFree) {
         // This code is hit millions of times so we want to bypass it as much as possible.
         if (node.hasNoTags()) {
             return false;
@@ -1128,6 +1136,11 @@ private static boolean isImpassable (Node node) {
             // Consider the node impassable only when all mode-specific exception tags are missing or clearly negative.
             return isNullOrNo(node.getTag("foot")) && isNullOrNo(node.getTag("bicycle"));
         }
+
+        if (requireStepFree && node.hasTag("kerb", "raised")) {
+            return true;
+        }
+
         // As a default, err on the side of returning false, which will maintain the preexisting code path.
         return false;
     }

src/test/java/com/conveyal/r5/labeling/TestPermissionsLabeler.java

@@ -1,5 +1,7 @@
 package com.conveyal.r5.labeling;
 
+import com.conveyal.r5.analyst.cluster.TransportNetworkConfig;
+
 /**
  * This is used for tests. It adds new highway tag highway=nobikenoped which forbids cycling and walking. But allows other things.
  * Created by mabu on 27.11.2015.
@@ -8,4 +10,8 @@ public class TestPermissionsLabeler extends USTraversalPermissionLabeler {
     static {
         addPermissions("highway=nobikenoped", "access=yes;bicycle=no;foot=no");
     }
+
+    public TestPermissionsLabeler () {
+        super(null);
+    }
 }