gpx_doctor 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ba71f5752f36af3efd9f3b12de47d843a85b3ecd7fbcabd7468a2eef43355e
-  data.tar.gz: b58cb9eb1f207c3ec26f127b615ba43f70efe741904c6e73aa2c4ab059a7b710
+  metadata.gz: acb87257e118bff8499cfa14686bd88d04c6b89beb02b0f5c50bff087a73fd8e
+  data.tar.gz: 6ecc166553da8067c1970fd22452aae97384ebdd36363f661ccbf8cf54cea5bd
 SHA512:
-  metadata.gz: 053df672b67de8623f4749e7a5d0e8419667abd7227e31a8937d2434ebad3a0af73d04ae54af95112ecffe1e7824314634316cc1bc1793863d5c9289057cf4bd
-  data.tar.gz: 2376c74be6339f8aeeb535e8f79dbd9dd876bca7526713f9be8e09da3793718eaba4e285a455e4a07e1f182768affcf206c6ae7ba81483e37c6468e59bf96e27
+  metadata.gz: 61092aea3f7b2b2995289ada84eead6566b24ede417b0d916802c18ec9f463fd9b444d0515610bb73bb9c05e80f012be50111927e72b081721e927fa139993c5
+  data.tar.gz: 00d4010f2c0f85d1fc3773d5e6da614944205f8278099370dd2f846a471bf06c9a7cafb689f75ddd12d0c74b56b0de27fc99410769de4370b35e07dc7b224fae

data/README.md

@@ -89,7 +89,9 @@ result = GpxDoctor::Parser.parse("path/to/file.gpx", params: {
   max_points:         500,           # reduce each segment to at most this many points
   segment_statistics: true,          # compute distance_to_next, elevation_change, direction for each point
   cumulative_distance: true,         # add cumulative distance from start of each segment/route
-  enhance_elevation:  true           # fetch missing elevations from the configured elevation server
+  label_interval:     1.0,           # insert an interpolated, labelled point at every interval mark (kilometres or miles based on unit_system)
+  enhance_elevation:  true,          # fetch missing elevations from the configured elevation server
+  full_poi_data:      true           # populate result.pois with start/finish boundary data for the whole GPX and each track segment
 })
 ```
 
@@ -99,12 +101,18 @@ Processing is applied in the following order:
 2. `max_points` — point reduction
 3. `segment_statistics` — per-point statistics (distance, bearing, elevation change)
 4. `cumulative_distance` — cumulative distance from the start of each segment/route
-5. `enhance_elevation` — elevation lookup via the elevation server
+5. `label_interval` — labelled point insertion
+6. `enhance_elevation` — elevation lookup via the elevation server
+7. `full_poi_data` — POI boundary extraction (start, finish, and per-segment boundaries)
 
 `enhance_elevation: true` requires the elevation server to be configured (see **Configuration** above). It only fills in points that have no elevation value; existing elevations are left unchanged.
 
 `cumulative_distance: true` adds a `cumulative_distance` field to each point, representing the cumulative distance in kilometers from the start of its segment or route. For tracks with multiple segments, each segment's cumulative distance starts at 0.0 (gaps between segments are not included in the calculation).
 
+`label_interval: 1.0` walks each route/segment and inserts an interpolated point at every multiple of the given interval (measured as cumulative distance from the start, in kilometres for `:metric` or miles for `:imperial` — see **Unit System** above), setting the new point's `label` field to that distance (e.g. `1.0` for the point at the 1.0 km/mi mark). A mark falling on an existing point (within a small tolerance) is skipped rather than duplicated. `label_interval` runs after `cumulative_distance`, reusing its `cumulative_distance` values instead of recalculating them when `cumulative_distance: true` is also given. **Because `label_interval` is applied after `max_points`, the resulting number of points may exceed `max_points`.**
+
+`full_poi_data: true` populates `result.pois` with the first and last geographic point of the entire GPX (across all routes and track segments), plus optional per-segment boundary data. Distances within each segment start at 0.0 and reflect that segment's length only. The `ele` key is omitted for points that have no elevation value. The global `finish` distance is the sum of all individual collection lengths. See **`result.pois`** below for the output shape.
+
 ## Accessing data
 
 ```ruby
@@ -113,6 +121,7 @@ result.waypoints # => [#<Waypoint …>]  (top-level <wpt> elements only)
 result.routes    # => [#<Route …>]
 result.tracks    # => [#<Track …>]
 result.metadata  # => #<Metadata …>  (or nil)
+result.pois      # => Hash (only when parsed with full_poi_data: true, otherwise nil)
 ```
 
 `result.points` is a flat array containing **all** geographic points from:
@@ -120,6 +129,31 @@ result.metadata  # => #<Metadata …>  (or nil)
 - `<rtept>` elements inside each `<rte>`
 - `<trkpt>` elements inside each `<trkseg>` inside each `<trk>`
 
+### `result.pois`
+
+When parsed with `full_poi_data: true`, `result.pois` contains boundary data for the entire GPX and each track segment:
+
+```ruby
+result = GpxDoctor::Parser.parse("route.gpx", params: { full_poi_data: true })
+result.pois
+# =>
+# {
+#   start:  { lon: 16.38, lat: 48.23, ele: 170.0, distance: 0.0 },
+#   finish: { lon: 16.39, lat: 48.24, ele: 175.0, distance: 1.42 },
+#   segments: [
+#     {
+#       start:  { lon: 16.38, lat: 48.23, ele: 170.0, distance: 0.0 },
+#       finish: { lon: 16.39, lat: 48.24, ele: 175.0, distance: 1.42 }
+#     }
+#   ]
+# }
+```
+
+- **`start`** / **`finish`** — first and last geographic point across all routes and track segments, each with `lon`, `lat`, `distance` (and `ele` when present). `start` always has `distance: 0.0`; `finish` distance is the sum of all individual route/segment lengths.
+- **`segments`** — present only when the GPX contains track segments. Each entry is `{start:, finish:}` for one `<trkseg>`, with distances measured from the beginning of that segment (`start` is always `distance: 0.0`).
+- The `ele` key is omitted for points that have no elevation value.
+- Distance values respect the configured `unit_system` (kilometres for `:metric`, miles for `:imperial`).
+
 ## Building GPX files
 
 The `GpxDoctor::Builder` class generates GPX 1.1 XML from a `Result` object (the same structure returned by the parser).
@@ -265,6 +299,7 @@ GpxDoctor::Builder.build_file(result, 'output.gpx')
 | `elevation_change` | Float | Elevation change to next point (metres or feet based on `unit_system`) — set by `segment_statistics: true` |
 | `direction` | Float | Bearing to next point (0–360°) — set by `segment_statistics: true` |
 | `cumulative_distance` | Float | Cumulative distance from segment/route start (kilometres or miles based on `unit_system`) — set by `cumulative_distance: true` |
+| `label` | Float | Cumulative distance mark for a point inserted by `label_interval` (kilometres or miles based on `unit_system`); `nil` for points not created for labelling — set by `label_interval` |
 
 `Waypoint#to_h` returns a hash of all non-nil fields.
 

data/lib/gpx_doctor/models/waypoint.rb

@@ -8,7 +8,7 @@ module GpxDoctor
         sym type fix sat hdop vdop pdop ageofdgpsdata dgpsid
       ].freeze
 
-      STATISTICS_FIELDS = %i[distance_to_next elevation_change direction cumulative_distance].freeze
+      STATISTICS_FIELDS = %i[distance_to_next elevation_change direction cumulative_distance label].freeze
 
       attr_accessor(*STATISTICS_FIELDS)
 

data/lib/gpx_doctor/parser.rb

@@ -7,7 +7,7 @@ module GpxDoctor
   class Parser
     GPX_NS = 'http://www.topografix.com/GPX/1/1'
 
-    Result = Struct.new(:waypoints, :routes, :tracks, :metadata, keyword_init: true) do
+    Result = Struct.new(:waypoints, :routes, :tracks, :metadata, :pois, keyword_init: true) do
       def points
         waypoints + routes.flat_map(&:points) + tracks.flat_map(&:points)
       end
@@ -54,7 +54,9 @@ module GpxDoctor
       select_max_points(result) if @params[:max_points]
       enhance_statistics(result) if @params[:segment_statistics]
       enhance_cumulative_distance(result) if @params[:cumulative_distance]
+      label_points(result) if @params[:label_interval]
       enhance_elevations(result) if @params[:enhance_elevation]
+      result.pois = build_pois(result) if @params[:full_poi_data]
 
       result
     end
@@ -276,5 +278,60 @@ module GpxDoctor
         track.segments.each { |seg| enhancer.enhance(seg.points) }
       end
     end
+
+    def label_points(result)
+      labeler = PointLabeler.new
+      interval = @params[:label_interval]
+      result.routes.each { |route| route.points = labeler.label(route.points, interval) }
+      result.tracks.each do |track|
+        track.segments.each { |seg| seg.points = labeler.label(seg.points, interval) }
+      end
+    end
+
+    def point_to_poi(point, distance)
+      poi = { lon: point.lon, lat: point.lat }
+      poi[:ele] = point.ele if point.ele
+      poi[:distance] = distance
+      poi
+    end
+
+    def build_pois(result)
+      collections = result.routes.map(&:points) +
+                    result.tracks.flat_map { |t| t.segments.map(&:points) }
+      non_empty = collections.reject(&:empty?)
+
+      return {} if non_empty.empty?
+
+      total_distance = non_empty.sum { |pts| collection_distance(pts) }
+
+      pois = {
+        start: point_to_poi(non_empty.first.first, 0.0),
+        finish: point_to_poi(non_empty.last.last, total_distance)
+      }
+
+      segments_pois = result.tracks.flat_map do |track|
+        track.segments.filter_map do |seg|
+          next if seg.points.empty?
+
+          {
+            start: point_to_poi(seg.points.first, 0.0),
+            finish: point_to_poi(seg.points.last, collection_distance(seg.points))
+          }
+        end
+      end
+
+      pois[:segments] = segments_pois unless segments_pois.empty?
+      pois
+    end
+
+    def collection_distance(points)
+      return 0.0 if points.length < 2
+
+      unit_system = GpxDoctor.configuration.unit_system
+      points.each_cons(2).sum do |a, b|
+        dist_km = DistanceCalculator.distance(a, b) / 1000.0
+        UnitConverter.convert_cumulative_distance(dist_km, unit_system)
+      end
+    end
   end
 end

data/lib/gpx_doctor/point_labeler.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module GpxDoctor
+  class PointLabeler
+    # Tolerance (in the configured distance unit) used to decide whether a
+    # label distance coincides with an existing point, to avoid inserting a
+    # near-duplicate point right next to it.
+    EPSILON = 1e-9
+
+    # Inserts an interpolated point at every multiple of +label_interval+
+    # measured as cumulative distance from the start of +points+ (kilometres
+    # for :metric, miles for :imperial — see GpxDoctor.configuration.unit_system).
+    #
+    # When +points+ already carry a +cumulative_distance+ (set by
+    # GpxDoctor::CumulativeDistanceEnhancer), those values are reused instead
+    # of being recalculated. Otherwise cumulative distance is computed from
+    # scratch.
+    #
+    # Existing points are left untouched. A new point is inserted between the
+    # two existing points that bracket each label distance, with lat/lon
+    # always interpolated, and ele/time interpolated only when both endpoints
+    # have values. The new point's +label+ field is set to the target
+    # distance (e.g. 1.0 for the point at the 1.0 km/mi mark).
+    #
+    # A label distance that falls (within a small tolerance) on an existing
+    # point is skipped — no duplicate point is inserted.
+    #
+    # Returns a new array; the original is not mutated. When +points+ has
+    # fewer than 2 elements, or +label_interval+ is nil, zero or negative,
+    # the original array is returned unchanged.
+    def label(points, label_interval)
+      return points if points.nil? || points.size < 2 || label_interval.nil? || label_interval <= 0
+
+      cumulative = cumulative_distances(points)
+
+      result = [points.first]
+      target = label_interval
+
+      points.each_cons(2).with_index do |(a, b), i|
+        start_dist = cumulative[i]
+        end_dist = cumulative[i + 1]
+
+        while target <= end_dist + EPSILON
+          if target > start_dist + EPSILON && target < end_dist - EPSILON
+            result << interpolate(a, b, start_dist, end_dist, target)
+          end
+          target += label_interval
+        end
+
+        result << b
+      end
+
+      result
+    end
+
+    private
+
+    # Returns the cumulative distance of every point, reusing each point's
+    # already-computed +cumulative_distance+ (see CumulativeDistanceEnhancer)
+    # when available, to avoid walking the points and recalculating distances
+    # a second time.
+    def cumulative_distances(points)
+      return points.map(&:cumulative_distance) if precomputed?(points)
+
+      unit_system = GpxDoctor.configuration.unit_system
+
+      cumulative = [0.0]
+      points.each_cons(2) do |a, b|
+        distance_km = DistanceCalculator.distance(a, b) / 1000.0
+        distance_converted = UnitConverter.convert_cumulative_distance(distance_km, unit_system)
+        cumulative << cumulative.last + distance_converted
+      end
+      cumulative
+    end
+
+    def precomputed?(points)
+      points.all? { |p| p.respond_to?(:cumulative_distance) && !p.cumulative_distance.nil? }
+    end
+
+    def interpolate(a, b, start_dist, end_dist, target)
+      fraction = (target - start_dist) / (end_dist - start_dist)
+      ele  = a.ele  && b.ele  ? a.ele  + fraction * (b.ele  - a.ele)  : nil
+      time = a.time && b.time ? a.time + fraction * (b.time - a.time) : nil
+
+      Models::Waypoint.new(
+        lat:   a.lat + fraction * (b.lat - a.lat),
+        lon:   a.lon + fraction * (b.lon - a.lon),
+        ele:   ele,
+        time:  time,
+        label: target
+      )
+    end
+  end
+end

data/lib/gpx_doctor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GpxDoctor
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/lib/gpx_doctor.rb

@@ -21,6 +21,7 @@ require 'gpx_doctor/statistics_enhancer'
 require 'gpx_doctor/cumulative_distance_enhancer'
 require 'gpx_doctor/segment_splitter'
 require 'gpx_doctor/point_selector'
+require 'gpx_doctor/point_labeler'
 require 'gpx_doctor/parser'
 require 'gpx_doctor/builder'
 require 'gpx_doctor/geojson_builder'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpx_doctor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Poltrax
@@ -63,6 +63,7 @@ files:
 - lib/gpx_doctor/models/track_segment.rb
 - lib/gpx_doctor/models/waypoint.rb
 - lib/gpx_doctor/parser.rb
+- lib/gpx_doctor/point_labeler.rb
 - lib/gpx_doctor/point_selector.rb
 - lib/gpx_doctor/segment_splitter.rb
 - lib/gpx_doctor/statistics_enhancer.rb