feat: merge 001-bike-impedance-column add bike impedance support

Author: knu2xs

CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## Unreleased
+
+### Breaking Changes
+
+- **`AddWalkImpedanceColumn` toolbox tool removed** — The `AddWalkImpedanceColumn` ArcGIS Pro toolbox tool has been removed and replaced by `AddImpedanceColumn`. Any `.aprx` project or ArcGIS Catalog reference to `AddWalkImpedanceColumn` will no longer resolve. Update references to use `AddImpedanceColumn` instead, selecting `"walk"` as the modality.
+
+- **`add_impedance_column` requires explicit `modality_prefix`** — The `modality_prefix` parameter of `add_impedance_column()` no longer has a default value. Callers that previously relied on the `"walk"` default must now pass `modality_prefix="walk"` explicitly:
+
+  ```python
+  # Before (no longer works)
+  add_impedance_column(edge_features)
+
+  # After
+  add_impedance_column(edge_features, modality_prefix="walk")
+  ```
+
+### New Features
+
+- **`bike_impedance` column** — `add_impedance_column()` now supports `modality_prefix="bike"`, adding a `bike_impedance` field populated from `IMPEDANCE_TYPE_COEFFICIENTS_BIKE`.
+
+- **`modalities` parameter on `create_network_dataset()`** — The function now accepts an optional `modalities` list (default `["walk", "bike"]`). Both `walk_impedance` and `bike_impedance` are added to segment features by default. Pass `modalities=["walk"]` to restrict to walk-only as before.
+
+- **`AddImpedanceColumn` toolbox tool** — New ArcGIS Pro toolbox tool replacing `AddWalkImpedanceColumn`. Features a modality combo-box (predefined options: walk, bike; custom names supported) and an editable coefficient table that pre-populates when a predefined modality is selected.
+
+- **`SUPPORTED_MODALITIES`** — New public constant (`list[str]`) exported from `overture_to_arcgis.utils._arcgis_routing` listing all registered modality names.
+
+- **`_IMPEDANCE_REGISTRY`** — New private module-level dict mapping modality name → coefficient table, serving as the single source of truth for impedance lookups.

arcgis/overture_to_arcgis.AddImpedanceColumn.pyt.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata xml:lang="en"><Esri><CreaDate>20260320</CreaDate><CreaTime>00000000</CreaTime><ArcGISFormat>1.0</ArcGISFormat><SyncOnce>TRUE</SyncOnce><ModDate>20260320</ModDate><ModTime>000000</ModTime></Esri><tool name="AddImpedanceColumn" displayname="Add Impedance Column (Segments)" toolboxalias="overture_to_arcgis" category="Add Parsed Fields"><summary>Calculate an impedance cost multiplier for each segment feature based on its road class and subtype for a chosen routing modality (e.g. walk or bike). Values below 1.0 indicate modality-friendly segments; values above 1.0 penalise segments less suitable for that modality. A value of -1 marks segments where the chosen modality is prohibited (e.g. water, rail). Replaces the removed AddWalkImpedanceColumn tool — any existing references to AddWalkImpedanceColumn must be updated to use this tool instead.</summary><usage><bullet_item>The input features must contain class and subtype text fields, typically present on Overture segment features.</bullet_item><bullet_item>Select a predefined modality (walk or bike) from the Modality dropdown. The Coefficients table is pre-populated with the default values for that modality and can be edited before running.</bullet_item><bullet_item>Type a custom modality name to define a new impedance field (e.g. &quot;horse&quot; produces a horse_impedance field). Supply all coefficient rows manually when using a custom modality.</bullet_item><bullet_item>The tool adds or overwrites a &lt;modality&gt;_impedance float field. The value acts as a multiplier on segment length when computing routing costs for that modality.</bullet_item><bullet_item>Segments whose class and subtype do not match any coefficient row receive a default impedance of 1.0 (neutral cost).</bullet_item></usage><parameters><param name="input_features" displayname="Input Features" type="Required" direction="Input" datatype="GPFeatureLayer"><dialogReference>The segment feature layer or feature class to which the impedance field will be added.</dialogReference></param><param name="modality" displayname="Modality" type="Required" direction="Input" datatype="GPString"><dialogReference>The routing modality for which the impedance column is calculated. Predefined options are walk and bike. Selecting a predefined modality pre-populates the Coefficients table with default values. A custom modality name can be typed to create a new impedance field with user-supplied coefficients.</dialogReference></param><param name="coefficients" displayname="Coefficients" type="Required" direction="Input" datatype="GPValueTable"><dialogReference>A table of impedance multiplier rules. Each row contains three values: Field Name (either class or subtype), Value (the field value to match, e.g. cycleway), and Multiplier (the numeric cost multiplier for matching features). Rows are pre-populated when a predefined modality is selected and can be edited. At least one row is required to run the tool.</dialogReference></param></parameters></tool></metadata>

arcgis/overture_to_arcgis.AddWalkImpedanceColumn.pyt.xml

@@ -60,7 +60,7 @@ class Toolbox:
             SplitSegmentsIntoSubclassFeatures,
             SplitSegmentsIntoLevelFeatures,
             SplitSegmentsAtConnectors,
-            AddWalkImpedanceColumn,
+            AddImpedanceColumn,
             CreateNetworkDataset
         ]
 
@@ -828,38 +828,94 @@ class SplitSegmentsIntoLevelFeatures:
         return
 
 
-class AddWalkImpedanceColumn:
-    """Tool to add walk impedance column to a feature class."""
+class AddImpedanceColumn:
+    """Tool to add an impedance cost-multiplier field to edge features for a chosen routing modality."""
+
     def __init__(self):
-        self.label = "Add Walk Impedance Column (Segments)"
+        self.label = "Add Impedance Column (Segments)"
         self.description = (
-            "Add walk impedance column to a feature class to using features for walk network routing."
+            "Add an impedance cost-multiplier field to edge features for a chosen routing modality. "
+            "Supports predefined modalities (walk, bike) with editable coefficients and custom "
+            "modality names."
         )
         self.category = "Add Parsed Fields"
 
     def getParameterInfo(self):
 
-        # create a parameter to set the input feature layer
         input_features = arcpy.Parameter(
             displayName="Input Features",
             name="input_features",
             datatype="GPFeatureLayer",
             parameterType="Required",
-            direction="Input"
+            direction="Input",
         )
 
-        params = [input_features]
+        modality = arcpy.Parameter(
+            displayName="Modality",
+            name="modality",
+            datatype="GPString",
+            parameterType="Required",
+            direction="Input",
+        )
+        modality.filter.type = "ValueList"
+        modality.filter.list = overture_to_arcgis.utils._arcgis_routing.SUPPORTED_MODALITIES
+        modality.value = "walk"
+
+        coefficients = arcpy.Parameter(
+            displayName="Coefficients",
+            name="coefficients",
+            datatype="GPValueTable",
+            parameterType="Required",
+            direction="Input",
+        )
+        coefficients.columns = [
+            ["GPString", "Field Name"],
+            ["GPString", "Value"],
+            ["GPDouble", "Multiplier"],
+        ]
 
-        return params
+        return [input_features, modality, coefficients]
+
+    def updateParameters(self, parameters):
+        """Pre-populate the coefficient table when the modality selection changes."""
+        if parameters[1].altered:
+            from overture_to_arcgis.utils._core import slugify
+            mod = slugify(parameters[1].valueAsText or "")
+            registry = overture_to_arcgis.utils._arcgis_routing._IMPEDANCE_REGISTRY
+            if mod in registry:
+                rows = []
+                for field_name, mapping in registry[mod].items():
+                    for value, multiplier in mapping.items():
+                        rows.append([field_name, value, multiplier])
+                parameters[2].value = rows
+            else:
+                parameters[2].value = None
+
+    def updateMessages(self, parameters):
+        """Block execution when the coefficient table is empty."""
+        if parameters[2].value is None or len(parameters[2].values or []) == 0:
+            parameters[2].setErrorMessage(
+                "Coefficients table must have at least one row before running."
+            )
 
     def execute(self, parameters, messages):
         """The source code of the tool."""
-
-        # retrieve the data directory path from parameters
         input_features = parameters[0].valueAsText
+        modality = parameters[1].valueAsText
 
-        # add walk impedance column
-        overture_to_arcgis.utils.add_impedance_column(input_features, modality_prefix="walk")
+        # reconstruct the nested coefficients dict from the GPValueTable rows
+        coefficients = {}
+        for row in parameters[2].values:
+            field_name = str(row[0])
+            value = str(row[1])
+            multiplier = float(row[2])
+            coefficients.setdefault(field_name, {})[value] = multiplier
+
+        overture_to_arcgis.utils.add_impedance_column(
+            input_features,
+            modality_prefix=modality,
+            coefficients=coefficients,
+        )
 
         return