Merge pull request #5774 from ibi-group/sidewalk-naming

Namer for applying street names to nearby sidewalks
opentripplanner · May 17, 2024 · dbc10f3 · dbc10f3
2 parents c3147f5 + 60c4ee9
commit dbc10f3
Show file tree

Hide file tree

Showing 29 changed files with 783 additions and 138 deletions.
diff --git a/doc-templates/BuildConfiguration.md b/doc-templates/BuildConfiguration.md
@@ -140,22 +140,6 @@ The mechanism is that for any two identical tags, OTP will use the first one.
 }
 ```
 
-### Custom naming
-
-You can define a custom naming scheme for elements drawn from OSM by defining an `osmNaming` field
-in `build-config.json`, such as:
-
-```JSON
-// build-config.json
-{
-  "osmNaming": "portland"
-}
-```
-
-There is currently only one custom naming module called `portland` (which has no parameters).
-
-
-
 ## Elevation data
 
 OpenTripPlanner can "drape" the OSM street network over a digital elevation model (DEM). This allows

diff --git a/docs/BuildConfiguration.md b/docs/BuildConfiguration.md
@@ -35,7 +35,7 @@ Sections follow that describe particular settings in more depth.
 | maxTransferDuration                                                      |  `duration` | Transfers up to this duration with the default walk speed value will be pre-calculated and included in the Graph.                                              | *Optional* | `"PT30M"`                         |  2.1  |
 | [multiThreadElevationCalculations](#multiThreadElevationCalculations)    |  `boolean`  | Configuring multi-threading during elevation calculations.                                                                                                     | *Optional* | `false`                           |  2.0  |
 | [osmCacheDataInMem](#osmCacheDataInMem)                                  |  `boolean`  | If OSM data should be cached in memory during processing.                                                                                                      | *Optional* | `false`                           |  2.0  |
-| osmNaming                                                                |   `string`  | A custom OSM namer to use.                                                                                                                                     | *Optional* |                                   |  2.0  |
+| [osmNaming](#osmNaming)                                                  |    `enum`   | A custom OSM namer to use.                                                                                                                                     | *Optional* | `"default"`                       |  1.5  |
 | platformEntriesLinking                                                   |  `boolean`  | Link unconnected entries to public transport platforms.                                                                                                        | *Optional* | `false`                           |  2.0  |
 | [readCachedElevations](#readCachedElevations)                            |  `boolean`  | Whether to read cached elevation data.                                                                                                                         | *Optional* | `true`                            |  2.0  |
 | staticBikeParkAndRide                                                    |  `boolean`  | Whether we should create bike P+R stations from OSM data.                                                                                                      | *Optional* | `false`                           |  1.5  |
@@ -238,22 +238,6 @@ The mechanism is that for any two identical tags, OTP will use the first one.
 }
 ```
 
-### Custom naming
-
-You can define a custom naming scheme for elements drawn from OSM by defining an `osmNaming` field
-in `build-config.json`, such as:
-
-```JSON
-// build-config.json
-{
-  "osmNaming": "portland"
-}
-```
-
-There is currently only one custom naming module called `portland` (which has no parameters).
-
-
-
 ## Elevation data
 
 OpenTripPlanner can "drape" the OSM street network over a digital elevation model (DEM). This allows
@@ -536,6 +520,14 @@ deployment depending on your infrastructure. Set the parameter to `true` to cach
 data, and to `false` to read the stream from the source each time.
 
 
+<h3 id="osmNaming">osmNaming</h3>
+
+**Since version:** `1.5` ∙ **Type:** `enum` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"default"`   
+**Path:** /   
+**Enum values:** `default` | `portland` | `sidewalks`
+
+A custom OSM namer to use.
+
 <h3 id="readCachedElevations">readCachedElevations</h3>
 
 **Since version:** `2.0` ∙ **Type:** `boolean` ∙ **Cardinality:** `Optional` ∙ **Default value:** `true`   

diff --git a/src/main/java/org/opentripplanner/apis/gtfs/GraphQLScalars.java b/src/main/java/org/opentripplanner/apis/gtfs/GraphQLScalars.java
@@ -1,6 +1,5 @@
 package org.opentripplanner.apis.gtfs;
 
-import com.bedatadriven.jackson.datatype.jts.JtsModule;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import graphql.language.StringValue;
@@ -16,15 +15,15 @@
 import java.time.format.DateTimeFormatter;
 import javax.annotation.Nonnull;
 import org.locationtech.jts.geom.Geometry;
-import org.opentripplanner.framework.geometry.GeometryUtils;
 import org.opentripplanner.framework.graphql.scalar.DurationScalarFactory;
+import org.opentripplanner.framework.json.ObjectMappers;
 import org.opentripplanner.framework.model.Grams;
 import org.opentripplanner.framework.time.OffsetDateTimeParser;
 
 public class GraphQLScalars {
 
-  private static final ObjectMapper geoJsonMapper = new ObjectMapper()
-    .registerModule(new JtsModule(GeometryUtils.getGeometryFactory()));
+  private static final ObjectMapper geoJsonMapper = ObjectMappers.geoJson();
+
   public static GraphQLScalarType DURATION_SCALAR = DurationScalarFactory.createDurationScalar();
 
   public static final GraphQLScalarType POLYLINE_SCALAR = GraphQLScalarType

diff --git a/src/main/java/org/opentripplanner/apis/vectortiles/DebugStyleSpec.java b/src/main/java/org/opentripplanner/apis/vectortiles/DebugStyleSpec.java
@@ -13,6 +13,7 @@
 import org.opentripplanner.service.vehiclerental.street.StreetVehicleRentalLink;
 import org.opentripplanner.street.model.edge.AreaEdge;
 import org.opentripplanner.street.model.edge.BoardingLocationToStopLink;
+import org.opentripplanner.street.model.edge.Edge;
 import org.opentripplanner.street.model.edge.ElevatorHopEdge;
 import org.opentripplanner.street.model.edge.EscalatorEdge;
 import org.opentripplanner.street.model.edge.PathwayEdge;
@@ -49,6 +50,15 @@ public class DebugStyleSpec {
     1,
     List.of(new ZoomStop(15, 0.2f), new ZoomStop(MAX_ZOOM, 3))
   );
+  private static final Class<Edge>[] EDGES_TO_DISPLAY = new Class[] {
+    StreetEdge.class,
+    AreaEdge.class,
+    EscalatorEdge.class,
+    PathwayEdge.class,
+    ElevatorHopEdge.class,
+    TemporaryPartialStreetEdge.class,
+    TemporaryFreeEdge.class,
+  };
 
   static StyleSpec build(
     VectorSourceLayer regularStops,
@@ -73,19 +83,20 @@ static StyleSpec build(
           .typeLine()
           .vectorSourceLayer(edges)
           .lineColor(MAGENTA)
-          .edgeFilter(
-            StreetEdge.class,
-            AreaEdge.class,
-            EscalatorEdge.class,
-            PathwayEdge.class,
-            ElevatorHopEdge.class,
-            TemporaryPartialStreetEdge.class,
-            TemporaryFreeEdge.class
-          )
+          .edgeFilter(EDGES_TO_DISPLAY)
           .lineWidth(LINE_WIDTH)
           .minZoom(13)
           .maxZoom(MAX_ZOOM)
           .intiallyHidden(),
+        StyleBuilder
+          .ofId("edge-name")
+          .typeSymbol()
+          .lineText("name")
+          .vectorSourceLayer(edges)
+          .edgeFilter(EDGES_TO_DISPLAY)
+          .minZoom(17)
+          .maxZoom(MAX_ZOOM)
+          .intiallyHidden(),
         StyleBuilder
           .ofId("link")
           .typeLine()

diff --git a/src/main/java/org/opentripplanner/apis/vectortiles/model/StyleBuilder.java b/src/main/java/org/opentripplanner/apis/vectortiles/model/StyleBuilder.java
@@ -8,6 +8,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.stream.Stream;
+import org.opentripplanner.apis.vectortiles.model.ZoomDependentNumber.ZoomStop;
 import org.opentripplanner.framework.collection.ListUtils;
 import org.opentripplanner.framework.json.ObjectMappers;
 import org.opentripplanner.street.model.edge.Edge;
@@ -41,6 +42,7 @@ public enum LayerType {
     Line,
     Raster,
     Fill,
+    Symbol,
   }
 
   private StyleBuilder(String id) {
@@ -94,11 +96,35 @@ public StyleBuilder typeFill() {
     return this;
   }
 
+  public StyleBuilder typeSymbol() {
+    type(LayerType.Symbol);
+    return this;
+  }
+
   private StyleBuilder type(LayerType type) {
     props.put(TYPE, type.name().toLowerCase());
     return this;
   }
 
+  public StyleBuilder lineText(String name) {
+    layout.put("symbol-placement", "line");
+    layout.put("symbol-spacing", 500);
+    layout.put("text-field", "{%s}".formatted(name));
+    layout.put("text-font", List.of("KlokanTech Noto Sans Regular"));
+    layout.put(
+      "text-size",
+      new ZoomDependentNumber(14, List.of(new ZoomStop(14, 12), new ZoomStop(20, 14))).toJson()
+    );
+    layout.put("text-max-width", 5);
+    layout.put("text-keep-upright", true);
+    layout.put("text-rotation-alignment", "map");
+    paint.put("text-color", "#000");
+    paint.put("text-halo-color", "#fff");
+    paint.put("text-halo-blur", 4);
+    paint.put("text-halo-width", 3);
+    return this;
+  }
+
   public StyleBuilder circleColor(String color) {
     paint.put("circle-color", validateColor(color));
     return this;

diff --git a/src/main/java/org/opentripplanner/apis/vectortiles/model/StyleSpec.java b/src/main/java/org/opentripplanner/apis/vectortiles/model/StyleSpec.java
@@ -46,4 +46,9 @@ public Map<String, TileSource> sources() {
   public List<JsonNode> layers() {
     return layers;
   }
+
+  @JsonSerialize
+  public String glyphs() {
+    return "https://cdn.jsdelivr.net/gh/klokantech/klokantech-gl-fonts@master/{fontstack}/{range}.pbf";
+  }
 }
diff --git a/src/main/java/org/opentripplanner/framework/geometry/GeometryUtils.java b/src/main/java/org/opentripplanner/framework/geometry/GeometryUtils.java
@@ -244,7 +244,7 @@ public static Geometry convertGeoJsonToJtsGeometry(GeoJsonObject geoJsonGeom)
   }
 
   /**
-   * Extract individual line string from a mult-line string.
+   * Extract individual line strings from a multi-line string.
    */
   public static List<LineString> getLineStrings(MultiLineString mls) {
     var ret = new ArrayList<LineString>();

diff --git a/src/main/java/org/opentripplanner/framework/geometry/SphericalDistanceLibrary.java b/src/main/java/org/opentripplanner/framework/geometry/SphericalDistanceLibrary.java
@@ -30,10 +30,16 @@ public static double distance(Coordinate from, Coordinate to) {
     return distance(from.y, from.x, to.y, to.x);
   }
 
+  /**
+   * @see SphericalDistanceLibrary#fastDistance(double, double, double, double)
+   */
   public static double fastDistance(Coordinate from, Coordinate to) {
     return fastDistance(from.y, from.x, to.y, to.x);
   }
 
+  /**
+   * @see SphericalDistanceLibrary#fastDistance(double, double, double, double)
+   */
   public static double fastDistance(Coordinate from, Coordinate to, double cosLat) {
     double dLat = toRadians(from.y - to.y);
     double dLon = toRadians(from.x - to.x) * cosLat;
@@ -105,8 +111,8 @@ public static double distance(double lat1, double lon1, double lat2, double lon2
   }
 
   /**
-   * Compute an (approximated) distance between two points, with a known cos(lat). Be careful, this
-   * is approximated and never check for the validity of input cos(lat).
+   * Compute an (approximated) distance in meters between two points, with a known cos(lat).
+   * Be careful, this is approximated and never checks for the validity of input cos(lat).
    */
   public static double fastDistance(double lat1, double lon1, double lat2, double lon2) {
     return fastDistance(lat1, lon1, lat2, lon2, RADIUS_OF_EARTH_IN_M);
@@ -131,8 +137,8 @@ public static double distance(double lat1, double lon1, double lat2, double lon2
   }
 
   /**
-   * Approximated, fast and under-estimated equirectangular distance between two points. Works only
-   * for small delta lat/lon, fall-back on exact distance if not the case. See:
+   * Approximated, fast and under-estimated equirectangular distance in meters between two points.
+   * Works only for small delta lat/lon, fall-back on exact distance if not the case. See:
    * http://www.movable-type.co.uk/scripts/latlong.html
    */
   public static double fastDistance(

diff --git a/src/main/java/org/opentripplanner/framework/json/ObjectMappers.java b/src/main/java/org/opentripplanner/framework/json/ObjectMappers.java
@@ -1,7 +1,9 @@
 package org.opentripplanner.framework.json;
 
+import com.bedatadriven.jackson.datatype.jts.JtsModule;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.opentripplanner.framework.geometry.GeometryUtils;
 
 public class ObjectMappers {
 
@@ -13,4 +15,11 @@ public static ObjectMapper ignoringExtraFields() {
     mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
     return mapper;
   }
+
+  /**
+   * Returns a mapper that can serialize JTS geometries into GeoJSON.
+   */
+  public static ObjectMapper geoJson() {
+    return new ObjectMapper().registerModule(new JtsModule(GeometryUtils.getGeometryFactory()));
+  }
 }
diff --git a/src/main/java/org/opentripplanner/graph_builder/module/osm/DisjointSet.java b/src/main/java/org/opentripplanner/graph_builder/module/osm/DisjointSet.java
@@ -12,7 +12,7 @@
 import org.opentripplanner.framework.collection.MapUtils;
 
 /** Basic union-find data structure with path compression */
-public class DisjointSet<T> {
+class DisjointSet<T> {
 
   TIntList sets = new TIntArrayList();
 

diff --git a/src/main/java/org/opentripplanner/graph_builder/module/osm/OsmModule.java b/src/main/java/org/opentripplanner/graph_builder/module/osm/OsmModule.java
@@ -113,8 +113,6 @@ public Map<Vertex, Double> elevationDataOutput() {
     return elevationData;
   }
 
-  private record StreetEdgePair(StreetEdge main, StreetEdge back) {}
-
   private void build() {
     var parkingProcessor = new ParkingProcessor(
       graph,
@@ -390,8 +388,10 @@ private void buildBasicGraph() {
             geometry
           );
 
-          StreetEdge street = streets.main;
-          StreetEdge backStreet = streets.back;
+          params.edgeNamer().recordEdges(way, streets);
+
+          StreetEdge street = streets.main();
+          StreetEdge backStreet = streets.back();
           normalizer.applyWayProperties(street, backStreet, wayData, way);
 
           applyEdgesToTurnRestrictions(way, startNode, endNode, street, backStreet);
@@ -541,16 +541,10 @@ private StreetEdge getEdgeForStreet(
       .withRoundabout(way.isRoundabout())
       .withSlopeOverride(way.getOsmProvider().getWayPropertySet().getSlopeOverride(way))
       .withStairs(way.isSteps())
-      .withWheelchairAccessible(way.isWheelchairAccessible());
-
-    if (!way.hasTag("name") && !way.hasTag("ref")) {
-      seb.withBogusName(true);
-    }
-
-    StreetEdge street = seb.buildAndConnect();
-    params.edgeNamer().recordEdge(way, street);
+      .withWheelchairAccessible(way.isWheelchairAccessible())
+      .withBogusName(way.hasNoName());
 
-    return street;
+    return seb.buildAndConnect();
   }
 
   private float getMaxCarSpeed() {

diff --git a/src/main/java/org/opentripplanner/graph_builder/module/osm/Ring.java b/src/main/java/org/opentripplanner/graph_builder/module/osm/Ring.java
@@ -19,7 +19,7 @@
 import org.opentripplanner.framework.geometry.GeometryUtils;
 import org.opentripplanner.openstreetmap.model.OSMNode;
 
-public class Ring {
+class Ring {
 
   private final LinearRing shell;
   private final List<Ring> holes = new ArrayList<>();

diff --git a/src/main/java/org/opentripplanner/graph_builder/module/osm/StreetEdgePair.java b/src/main/java/org/opentripplanner/graph_builder/module/osm/StreetEdgePair.java
@@ -0,0 +1,35 @@
+package org.opentripplanner.graph_builder.module.osm;
+
+import java.util.ArrayList;
+import org.opentripplanner.street.model.edge.StreetEdge;
+
+public record StreetEdgePair(StreetEdge main, StreetEdge back) {
+  /**
+   * Return the non-null elements of this pair as an Iterable.
+   */
+  public Iterable<StreetEdge> asIterable() {
+    var ret = new ArrayList<StreetEdge>(2);
+    if (main != null) {
+      ret.add(main);
+    }
+    if (back != null) {
+      ret.add(back);
+    }
+    return ret;
+  }
+
+  /**
+   * Select one of the edges contained in this pair that is not null. No particular algorithm is
+   * guaranteed, and it may change in the future.
+   */
+  public StreetEdge pickAny() {
+    if (main != null) {
+      return main;
+    } else if (back != null) {
+      return back;
+    }
+    throw new IllegalStateException(
+      "%s must not contain two null elements".formatted(getClass().getSimpleName())
+    );
+  }
+}