trailgen-core 0.3.0

Typed trail graph, route scoring, loop search, and geospatial route I/O for adequate-trailgen.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
use crate::geo::{Coord, LineString};
use crate::hiking::HikingModel;
use crate::model::{Edge, GradeDistribution, Provenance, Terrain, TerrainEvidence, WalkGraph};
use crate::{Result, TrailgenError};
use serde::{Deserialize, Serialize};

#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
pub struct EnrichmentConfig {
    pub sample_spacing_m: f64,
    pub steep_grade_threshold: f64,
}

impl Default for EnrichmentConfig {
    fn default() -> Self {
        Self {
            sample_spacing_m: 25.0,
            steep_grade_threshold: 0.15,
        }
    }
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct ElevationSample {
    pub ele_m: f64,
    pub confidence: f64,
    pub provenance: Provenance,
}

pub trait ElevationSampler {
    fn sample(&self, coord: Coord) -> Option<ElevationSample>;
}

#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
pub struct ElevationMosaic<S> {
    samplers: Vec<S>,
}

impl<S> ElevationMosaic<S> {
    pub fn new(samplers: Vec<S>) -> Result<Self> {
        if samplers.is_empty() {
            return Err(TrailgenError::InvalidData(
                "elevation mosaic requires at least one sampler".to_owned(),
            ));
        }
        Ok(Self { samplers })
    }
}

impl<S: ElevationSampler> ElevationSampler for ElevationMosaic<S> {
    fn sample(&self, coord: Coord) -> Option<ElevationSample> {
        self.samplers
            .iter()
            .find_map(|sampler| sampler.sample(coord))
    }
}

#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct EmbeddedElevation;

impl ElevationSampler for EmbeddedElevation {
    fn sample(&self, coord: Coord) -> Option<ElevationSample> {
        Some(ElevationSample {
            ele_m: coord.ele?,
            confidence: 0.85,
            provenance: Provenance {
                source: "embedded-geometry-elevation".to_owned(),
                layer: None,
                source_id: None,
                license: None,
            },
        })
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Serialize, Deserialize)]
pub struct PlaneElevation {
    pub origin: Coord,
    pub origin_ele_m: f64,
    pub east_gain_m_per_degree: f64,
    pub north_gain_m_per_degree: f64,
    pub confidence: f64,
}

impl ElevationSampler for PlaneElevation {
    fn sample(&self, coord: Coord) -> Option<ElevationSample> {
        Some(ElevationSample {
            ele_m: self.north_gain_m_per_degree.mul_add(
                coord.lat - self.origin.lat,
                self.east_gain_m_per_degree
                    .mul_add(coord.lon - self.origin.lon, self.origin_ele_m),
            ),
            confidence: self.confidence,
            provenance: Provenance {
                source: "synthetic-plane-elevation".to_owned(),
                layer: Some("fixture".to_owned()),
                source_id: None,
                license: Some("CC0-fixture".to_owned()),
            },
        })
    }
}

pub fn enrich_graph<S: ElevationSampler>(
    graph: &mut WalkGraph,
    sampler: &S,
    config: EnrichmentConfig,
) -> Result<()> {
    if config.sample_spacing_m <= 0.0 {
        return Err(TrailgenError::InvalidData(
            "enrichment sample spacing must be positive".to_owned(),
        ));
    }
    for edge in &mut graph.edges {
        enrich_edge(edge, sampler, config)?;
    }
    Ok(())
}

fn enrich_edge<S: ElevationSampler>(
    edge: &mut Edge,
    sampler: &S,
    config: EnrichmentConfig,
) -> Result<()> {
    let (sampled_line, elevation_provenance, elevation_confidence) =
        densify_and_sample(&edge.geometry, sampler, config.sample_spacing_m)?;
    let profile = grade_profile(&sampled_line, config.steep_grade_threshold);
    edge.geometry = sampled_line;
    edge.attr.length_m = edge.geometry.length_m();
    edge.attr.ascent_m = profile.ascent_m;
    edge.attr.descent_m = profile.descent_m;
    edge.attr.grade_abs_mean = profile.grade_abs_mean;
    edge.attr.grade_abs_max = profile.grade_abs_max;
    edge.attr.sustained_steep_m = profile.sustained_steep_m;
    edge.attr.grade_distribution = profile.grade_distribution;
    edge.attr.hill_slope_deg = mean_hill_slope_deg(&edge.geometry, sampler);
    edge.attr.elevation_provenance = elevation_provenance;
    if elevation_confidence > 0.0 {
        edge.attr.confidence = edge.attr.confidence.min(elevation_confidence);
    }
    infer_terrain(edge, &profile);
    HikingModel.apply(edge);
    Ok(())
}

fn mean_hill_slope_deg<S: ElevationSampler>(line: &LineString, sampler: &S) -> Option<f64> {
    const RADIUS_M: f64 = 10.0;
    const METERS_PER_LATITUDE_DEGREE: f64 = 111_195.0;
    let mut weighted_slope = 0.0;
    let mut measured_m = 0.0;
    for segment in line.points.windows(2) {
        let distance_m = segment[0].haversine_m(segment[1]);
        if distance_m <= f64::EPSILON {
            continue;
        }
        let center = segment[0].lerp(segment[1], 0.5);
        let latitude_delta = RADIUS_M / METERS_PER_LATITUDE_DEGREE;
        let longitude_delta =
            RADIUS_M / (METERS_PER_LATITUDE_DEGREE * center.lat.to_radians().cos().max(0.01));
        let [Some(west), Some(east), Some(south), Some(north)] = [
            sampler.sample(Coord::new(center.lon - longitude_delta, center.lat)),
            sampler.sample(Coord::new(center.lon + longitude_delta, center.lat)),
            sampler.sample(Coord::new(center.lon, center.lat - latitude_delta)),
            sampler.sample(Coord::new(center.lon, center.lat + latitude_delta)),
        ] else {
            continue;
        };
        let east_grade = (east.ele_m - west.ele_m) / (2.0 * RADIUS_M);
        let north_grade = (north.ele_m - south.ele_m) / (2.0 * RADIUS_M);
        let slope_deg = east_grade.hypot(north_grade).atan().to_degrees();
        weighted_slope = slope_deg.mul_add(distance_m, weighted_slope);
        measured_m += distance_m;
    }
    (measured_m > 0.0).then_some(weighted_slope / measured_m)
}

fn densify_and_sample<S: ElevationSampler>(
    line: &LineString,
    sampler: &S,
    spacing_m: f64,
) -> Result<(LineString, Vec<Provenance>, f64)> {
    let mut points = Vec::new();
    let mut provenance = Vec::new();
    let mut confidence = 1.0;
    let mut sample_count = 0u32;
    let mut sample_attempts = 0u32;
    for segment in line.points.windows(2) {
        let a = segment[0];
        let b = segment[1];
        if points.is_empty() {
            points.push(sample_coord(
                a,
                sampler,
                &mut provenance,
                &mut confidence,
                &mut sample_count,
                &mut sample_attempts,
            ));
        }
        let length_m = a.haversine_m(b);
        for distance_m in std::iter::successors(Some(spacing_m), move |d| Some(d + spacing_m))
            .take_while(|d| *d < length_m)
        {
            points.push(sample_coord(
                a.lerp(b, distance_m / length_m),
                sampler,
                &mut provenance,
                &mut confidence,
                &mut sample_count,
                &mut sample_attempts,
            ));
        }
        points.push(sample_coord(
            b,
            sampler,
            &mut provenance,
            &mut confidence,
            &mut sample_count,
            &mut sample_attempts,
        ));
    }
    if sample_count == 0 {
        return Ok((line.clone(), Vec::new(), 0.0));
    }
    if sample_count > 0 && sample_count < sample_attempts {
        confidence = confidence.min(f64::from(sample_count) / f64::from(sample_attempts));
    }
    Ok((LineString::new(points)?, provenance, confidence))
}

fn sample_coord<S: ElevationSampler>(
    coord: Coord,
    sampler: &S,
    provenance: &mut Vec<Provenance>,
    confidence: &mut f64,
    sample_count: &mut u32,
    sample_attempts: &mut u32,
) -> Coord {
    *sample_attempts += 1;
    sampler
        .sample(coord)
        .map_or(Coord { ele: None, ..coord }, |sample| {
            *sample_count += 1;
            *confidence = confidence.min(sample.confidence);
            if !provenance.contains(&sample.provenance) {
                provenance.push(sample.provenance);
            }
            Coord {
                ele: Some(sample.ele_m),
                ..coord
            }
        })
}

#[derive(Clone, Copy)]
struct GradeProfile {
    ascent_m: f64,
    descent_m: f64,
    grade_abs_mean: f64,
    grade_abs_max: f64,
    sustained_steep_m: f64,
    grade_distribution: GradeDistribution,
}

fn grade_profile(line: &LineString, steep_grade_threshold: f64) -> GradeProfile {
    let mut ascent_m = 0.0;
    let mut descent_m = 0.0;
    let mut graded_m = 0.0;
    let mut weighted_abs_grade = 0.0;
    let mut grade_abs_max = 0.0;
    let mut sustained_steep_m = 0.0;
    let mut grade_distribution = GradeDistribution::default();

    for segment in line.points.windows(2) {
        let a = segment[0];
        let b = segment[1];
        let distance = a.haversine_m(b);
        let Some(ele_a) = a.ele else {
            continue;
        };
        let Some(ele_b) = b.ele else {
            continue;
        };
        let rise = ele_b - ele_a;
        if rise >= 0.0 {
            ascent_m += rise;
        } else {
            descent_m -= rise;
        }
        if distance > 0.0 {
            let abs_grade = (rise / distance).abs();
            graded_m += distance;
            weighted_abs_grade = abs_grade.mul_add(distance, weighted_abs_grade);
            if abs_grade > grade_abs_max {
                grade_abs_max = abs_grade;
            }
            if abs_grade >= steep_grade_threshold {
                sustained_steep_m += distance;
            }
            grade_distribution = grade_distribution.add_segment(distance, abs_grade);
        }
    }

    GradeProfile {
        ascent_m,
        descent_m,
        grade_abs_mean: weighted_abs_grade / graded_m.max(1.0),
        grade_abs_max,
        sustained_steep_m,
        grade_distribution,
    }
}

struct TerrainInference {
    terrain: Terrain,
    confidence: f64,
    rationale: String,
    provenance: Option<Provenance>,
}

fn infer_terrain(edge: &mut Edge, profile: &GradeProfile) {
    let evicted_enrichment_evidence = evict_enrichment_terrain_evidence(edge);
    if evicted_enrichment_evidence
        && edge.attr.terrain_confidence < 0.85
        && !edge
            .attr
            .terrain_evidence
            .iter()
            .any(|e| e.terrain == edge.attr.terrain)
    {
        edge.attr.terrain = Terrain::Unknown;
        edge.attr.terrain_confidence = 0.0;
    }

    let terrain = edge.attr.terrain;
    let explicit_confidence = edge.attr.terrain_confidence;
    if terrain != Terrain::Unknown && explicit_confidence >= 0.85 {
        if !edge
            .attr
            .terrain_evidence
            .iter()
            .any(|e| e.terrain == terrain)
        {
            upsert_terrain_evidence(
                edge,
                TerrainEvidence {
                    terrain,
                    confidence: explicit_confidence,
                    rationale: "explicit source terrain tag".to_owned(),
                    provenance: edge.attr.provenance.first().cloned(),
                },
            );
        }
        edge.attr.terrain_confidence = edge.attr.terrain_confidence.max(explicit_confidence);
        return;
    }

    let inference = terrain_inference(edge, profile);
    if inference.confidence < edge.attr.terrain_confidence {
        return;
    }
    edge.attr.terrain = inference.terrain;
    edge.attr.terrain_confidence = inference.confidence;
    edge.attr.confidence = edge
        .attr
        .confidence
        .min(inference.confidence.mul_add(0.35, 0.65));
    upsert_terrain_evidence(
        edge,
        TerrainEvidence {
            terrain: inference.terrain,
            confidence: inference.confidence,
            rationale: inference.rationale,
            provenance: inference.provenance,
        },
    );
}

fn terrain_inference(edge: &Edge, profile: &GradeProfile) -> TerrainInference {
    let grade_basis = grade_basis(edge, profile);
    let edge_provenance = edge.attr.provenance.first().cloned();
    if edge.attr.road_exposure >= 0.75 {
        TerrainInference {
            terrain: Terrain::Road,
            confidence: 0.70,
            rationale: format!(
                "inferred from road exposure {:.0}% with {grade_basis}",
                edge.attr.road_exposure * 100.0
            ),
            provenance: edge
                .attr
                .crossings
                .iter()
                .find(|x| x.kind == crate::model::CrossingKind::Road)
                .map(|x| x.provenance.clone())
                .or(edge_provenance),
        }
    } else if profile.grade_abs_max >= 0.32 {
        TerrainInference {
            terrain: Terrain::Scramble,
            confidence: 0.52,
            rationale: format!("inferred from savage sampled grade: {grade_basis}"),
            provenance: edge
                .attr
                .elevation_provenance
                .first()
                .cloned()
                .or(edge_provenance),
        }
    } else if profile.grade_abs_max >= 0.22 {
        TerrainInference {
            terrain: Terrain::Talus,
            confidence: 0.45,
            rationale: format!("inferred from steep sampled grade: {grade_basis}"),
            provenance: edge
                .attr
                .elevation_provenance
                .first()
                .cloned()
                .or(edge_provenance),
        }
    } else if edge.attr.way_kind.pathless() {
        TerrainInference {
            terrain: Terrain::Unknown,
            confidence: 0.0,
            rationale: format!("no surrounding-terrain evidence for pathless route: {grade_basis}"),
            provenance: edge_provenance,
        }
    } else {
        TerrainInference {
            terrain: Terrain::Trail,
            confidence: 0.35,
            rationale: format!("inferred default hiking surface: {grade_basis}"),
            provenance: edge_provenance,
        }
    }
}

fn grade_basis(edge: &Edge, profile: &GradeProfile) -> String {
    if edge.attr.elevation_provenance.is_empty() {
        format!(
            "no sampled elevation source; road exposure {:.0}%",
            edge.attr.road_exposure * 100.0
        )
    } else {
        let bins = profile.grade_distribution;
        let total = bins.total_m().max(1.0);
        format!(
            "max grade {:.1}%, mean grade {:.1}%, steep {:.0}%, savage {:.0}%",
            profile.grade_abs_max * 100.0,
            profile.grade_abs_mean * 100.0,
            bins.steep_m / total * 100.0,
            bins.savage_m / total * 100.0
        )
    }
}

fn evict_enrichment_terrain_evidence(edge: &mut Edge) -> bool {
    let old_len = edge.attr.terrain_evidence.len();
    edge.attr.terrain_evidence.retain(|e| {
        !(e.rationale.starts_with("inferred ")
            || matches!(
                e.rationale.as_str(),
                "high road-exposure fraction"
                    | "very steep sampled grade"
                    | "steep sampled grade"
                    | "default low-confidence hiking surface"
            ))
    });
    edge.attr.terrain_evidence.len() != old_len
}

fn upsert_terrain_evidence(edge: &mut Edge, evidence: TerrainEvidence) {
    if let Some(existing) = edge.attr.terrain_evidence.iter_mut().find(|e| {
        e.terrain == evidence.terrain
            && e.rationale == evidence.rationale
            && e.provenance == evidence.provenance
    }) {
        existing.confidence = existing.confidence.max(evidence.confidence);
    } else {
        edge.attr.terrain_evidence.push(evidence);
    }
}