Experimental
Computes batched multimodal OD costs and mode summaries between origin and destination point sets.
vector network multimodal od-matrix
| Name | Description | Required | Default |
|---|---|---|---|
input | Input line network layer. | Required | network.shp |
origins | Origin point layer. | Required | origins.shp |
destinations | Destination point layer. | Required | destinations.shp |
mode_field | Line attribute field that identifies travel mode per segment. | Required | MODE |
snap_tolerance | Optional node snapping tolerance for graph construction. | Optional | — |
max_snap_distance | Optional max distance from origin/destination points to nearest network node. | Optional | — |
default_mode_speed | Default mode speed in coordinate-units per time unit (default: 1). | Optional | 1.0 |
mode_speed_overrides | Optional comma-separated mode:speed overrides (for example: walk:1.4,drive:12,transit:8). | Optional | — |
allowed_modes | Optional comma-separated allow-list of modes to include in routing. | Optional | — |
transfer_penalty | Optional additive penalty applied each time the route changes mode. | Optional | 0.0 |
temporal_cost_profile | Optional CSV defining time-dependent edge costs (columns: edge_id,dow,start_minute,end_minute,value). | Optional | — |
temporal_edge_id_field | Optional network field used to match temporal_cost_profile edge_id values (default EDGE_ID). | Optional | — |
departure_time | Optional RFC3339 departure time used for temporal profile lookup. | Optional | — |
temporal_mode | Optional temporal interpretation mode: multiplier or absolute. | Optional | — |
temporal_fallback | Optional fallback when temporal row is missing: static_cost or error. | Optional | — |
temporal_profile_report | Optional JSON output path for temporal profile diagnostics when using direct temporal input. | Optional | — |
scenario_bundle_csv | Optional CSV listing named temporal scenarios for comparative multi-scenario OD output. | Optional | — |
output | Output CSV path. | Required | — |
Creates a multimodal OD matrix with route cost and mode-sequence summaries.
wbe.multimodal_od_cost_matrix(default_mode_speed=1.0, destinations='destinations.shp', input='network.shp', mode_field='MODE', mode_speed_overrides='walk:1.4,transit:8', origins='origins.shp', output='multimodal_od_matrix.csv', transfer_penalty=0.0)