Merge pull request #100 from NatLabRockies/yep/island-detection

Island detection algorithm

Author: yamilbknsu

configuration/bambam-omf/travel-mode-filter.json

@@ -39,5 +39,9 @@
         { "type": "access_mode", "modes": ["motor_vehicle", "car", "truck", "motorcycle"] }
       ]
     }
-  ]
+  ],
+  "island_algorithm_configuration": {
+    "min_distance": 2,
+    "distance_unit": "miles"
+  }
 }

rust/Cargo.toml

@@ -38,6 +38,7 @@ gtfs-structures = "0.43.0"
 h3o = { version = "0.8.0", features = ["serde", "geo"] }
 hex = "0.4.3"
 humantime = "2.3.0"
+indexmap = "2.12.0"
 inventory = { version = "0.3.21" }
 itertools = { version = "0.14.0" }
 jsonpath-rust = { version = "1.0.4" }

rust/bambam-omf/Cargo.toml

@@ -36,6 +36,7 @@ geozero = { workspace = true }
 hex = { workspace = true }
 itertools = { workspace = true }
 kdam = { workspace = true }
+indexmap = { workspace = true }
 log = { workspace = true }
 object_store = { workspace = true }
 opening-hours-syntax = { workspace = true }

rust/bambam-omf/src/app/network.rs

@@ -1,5 +1,6 @@
 use std::path::Path;
 
+use routee_compass_core::model::unit::DistanceUnit;
 use serde::{Deserialize, Serialize};
 
 use crate::{
@@ -17,6 +18,7 @@ use crate::{
 pub struct NetworkEdgeListConfiguration {
     pub mode: String,
     pub filter: Vec<TravelModeFilter>,
+    pub island_algorithm_config: Option<IslandDetectionAlgorithmConfiguration>,
 }
 
 impl From<&NetworkEdgeListConfiguration> for SegmentAccessRestrictionWhen {
@@ -33,13 +35,20 @@ impl From<&NetworkEdgeListConfiguration> for SegmentAccessRestrictionWhen {
     }
 }
 
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct IslandDetectionAlgorithmConfiguration {
+    pub min_distance: f64,
+    pub distance_unit: DistanceUnit,
+}
+
 /// runs an OMF network import using the provided configuration.
 pub fn run(
     bbox: Option<&CliBoundingBox>,
     modes: &[NetworkEdgeListConfiguration],
     output_directory: &Path,
     local_source: Option<&Path>,
     write_json: bool,
+    island_detection_configuration: Option<IslandDetectionAlgorithmConfiguration>,
 ) -> Result<(), OvertureMapsCollectionError> {
     let collection: TransportationCollection = match local_source {
         Some(src_path) => read_local(src_path),
@@ -51,7 +60,8 @@ pub fn run(
         collection.to_json(output_directory)?;
     }
 
-    let vectorized_graph = OmfGraphVectorized::new(&collection, modes)?;
+    let vectorized_graph =
+        OmfGraphVectorized::new(&collection, modes, island_detection_configuration)?;
     vectorized_graph.write_compass(output_directory, true)?;
 
     Ok(())

rust/bambam-omf/src/app/omf_app.rs

@@ -5,7 +5,11 @@ use config::{Config, File};
 use serde::{Deserialize, Serialize};
 
 use crate::{
-    app::{cli_bbox::parse_bbox, network::NetworkEdgeListConfiguration, CliBoundingBox},
+    app::{
+        cli_bbox::parse_bbox,
+        network::{IslandDetectionAlgorithmConfiguration, NetworkEdgeListConfiguration},
+        CliBoundingBox,
+    },
     collection::OvertureMapsCollectionError,
 };
 
@@ -73,12 +77,29 @@ impl OmfOperation {
                         );
                         OvertureMapsCollectionError::InvalidUserInput(msg)
                     })?;
+                let island_algorithm_configuration = config
+                    .get::<Option<IslandDetectionAlgorithmConfiguration>>(
+                        "island_algorithm_configuration",
+                    )
+                    .map_err(|e| {
+                        let msg = format!(
+                            "error reading 'island_algorithm_configuration' key in '{configuration_file}': {e}"
+                        );
+                        OvertureMapsCollectionError::InvalidUserInput(msg)
+                    })?;
                 let outdir = match output_directory {
                     Some(out) => Path::new(out),
                     None => Path::new(""),
                 };
                 let local = local_source.as_ref().map(Path::new);
-                crate::app::network::run(bbox.as_ref(), &network_config, outdir, local, *store_raw)
+                crate::app::network::run(
+                    bbox.as_ref(),
+                    &network_config,
+                    outdir,
+                    local,
+                    *store_raw,
+                    island_algorithm_configuration,
+                )
             }
         }
     }