pysnapping 0.2.1__tar.gz → 0.2.2__tar.gz

{pysnapping-0.2.1 → pysnapping-0.2.2}/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: registry.geops.de/build/bullseye-python:latest
+image: registry.geops.com/geops/gitlab-ci-dockerfiles/bullseye-python:latest
 
 variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.pip-cache"

{pysnapping-0.2.1 → pysnapping-0.2.2}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 fail_fast: false
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v5.0.0
   hooks:
     - id: no-commit-to-branch
     - id: check-merge-conflict
@@ -13,11 +13,20 @@ repos:
     - id: check-case-conflict
     - id: check-docstring-first
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.1.14
+  rev: v0.9.9
   hooks:
     - id: ruff
       args: [ --fix ]
     - id: ruff-format
+- repo: https://github.com/astral-sh/uv-pre-commit
+  rev: 0.6.3
+  hooks:
+    - id: pip-compile
+      args: [pyproject.toml, -o, requirements.txt, -p, "3.9"]
+      files: ^(pyproject.toml|requirements.txt)$
+    - id: pip-compile
+      args: [dev-requirements.in, -o, dev-requirements.txt, -p, "3.9"]
+      files: ^(dev\-)?requirements.(txt|in)$
 - repo: local
   hooks:
     - id: mypy
@@ -27,15 +36,3 @@ repos:
       pass_filenames: false
       always_run: true
       args: ["-p", "pysnapping"]
-    - id: pip-compile
-      name: pip-compile
-      entry: pip-compile pyproject.toml
-      language: python
-      pass_filenames: false
-      files: 'pyproject\.toml|requirements\.txt'
-    - id: pip-compile-dev-requirements
-      name: pip-compile-dev-requirements
-      entry: pip-compile dev-requirements.in
-      language: python
-      pass_filenames: false
-      files: '(dev-)?requirements\.(in|txt)'

{pysnapping-0.2.1 → pysnapping-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pysnapping
-Version: 0.2.1
+Version: 0.2.2
 Summary: Snap points to a line string keeping a given order or spacing intact
 Author-email: Alexander Held | geOps <alexander.held@geops.com>
 Maintainer-email: Alexander Held | geOps <alexander.held@geops.com>
@@ -40,7 +40,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: shapely
-Requires-Dist: numpy
+Requires-Dist: numpy<2
 Requires-Dist: pyproj>=3.2.0
 
 # PySnapping
@@ -85,9 +85,14 @@ The `pysnapping.util` module contains common helper functions used in other part
 
 ### Snapping
 
-The `pysanpping.snap` module is the main entry point for users of the `pysnapping` library and
+The `pysnapping.snap` module is the main entry point for users of the `pysnapping` library and
 provides the classes needed to use the library.
 
+### Statistics
+
+The `pysnapping.stats` module provides tools to aggregate statistics about snapping
+failures and the methods used in case of success.
+
 ## Usage
 
 The typical usage pattern is to create a `pysnapping.snap.DubiousTrajectory` instance which represents

{pysnapping-0.2.1 → pysnapping-0.2.2}/README.md

@@ -40,9 +40,14 @@ The `pysnapping.util` module contains common helper functions used in other part
 
 ### Snapping
 
-The `pysanpping.snap` module is the main entry point for users of the `pysnapping` library and
+The `pysnapping.snap` module is the main entry point for users of the `pysnapping` library and
 provides the classes needed to use the library.
 
+### Statistics
+
+The `pysnapping.stats` module provides tools to aggregate statistics about snapping
+failures and the methods used in case of success.
+
 ## Usage
 
 The typical usage pattern is to create a `pysnapping.snap.DubiousTrajectory` instance which represents

{pysnapping-0.2.1 → pysnapping-0.2.2}/dev-requirements.txt

@@ -1,19 +1,13 @@
-#
-# This file is autogenerated by pip-compile with Python 3.9
-# by the following command:
-#
-#    pip-compile dev-requirements.in
-#
+# This file was autogenerated by uv via the following command:
+#    uv pip compile dev-requirements.in -o dev-requirements.txt -p 3.9
 build==1.0.3
     # via pip-tools
 cfgv==3.4.0
     # via pre-commit
 click==8.1.7
     # via pip-tools
-coverage[toml]==7.4.1
-    # via
-    #   coverage
-    #   pytest-cov
+coverage==7.4.1
+    # via pytest-cov
 distlib==0.3.8
     # via virtualenv
 exceptiongroup==1.2.0
@@ -32,7 +26,7 @@ mypy-extensions==1.0.0
     # via mypy
 nodeenv==1.8.0
     # via pre-commit
-numpy==1.26.3
+numpy==1.26.4
     # via
     #   -c requirements.txt
     #   -r dev-requirements.in
@@ -40,6 +34,8 @@ packaging==23.2
     # via
     #   build
     #   pytest
+pip==25.0.1
+    # via pip-tools
 pip-tools==7.3.0
     # via -r dev-requirements.in
 platformdirs==4.1.0
@@ -58,6 +54,10 @@ pytest-cov==4.1.0
     # via -r dev-requirements.in
 pyyaml==6.0.1
     # via pre-commit
+setuptools==75.8.2
+    # via
+    #   nodeenv
+    #   pip-tools
 tomli==2.0.1
     # via
     #   build
@@ -74,7 +74,3 @@ wheel==0.42.0
     # via pip-tools
 zipp==3.17.0
     # via importlib-metadata
-
-# The following packages are considered to be unsafe in a requirements file:
-# pip
-# setuptools

{pysnapping-0.2.1 → pysnapping-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ description = "Snap points to a line string keeping a given order or spacing int
 readme = "README.md"
 dependencies = [
   "shapely",
-  "numpy",
+  "numpy<2",
   "pyproj>=3.2.0",  # for defining custom CRS
 ]
 requires-python = ">=3.9"
@@ -47,7 +47,7 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools.packages.find]
 include = ["pysnapping", "pysnapping.*"]
 
-[tool.ruff]
+[tool.ruff.lint]
 select = [
     "F", # pyflakes
     "E",  # pycodestyle

{pysnapping-0.2.1 → pysnapping-0.2.2}/pysnapping/linear_referencing.py

@@ -622,15 +622,15 @@ class SlicedLineFractions:
             right_fractions = np.linspace(
                 self.closest_fractions[i], self.max_fractions[i], n_right_samples[i]
             )
-            locations.from_vertices[
-                index_offset : index_offset + n_samples[i]
-            ] = self.segment_indices[i]
+            locations.from_vertices[index_offset : index_offset + n_samples[i]] = (
+                self.segment_indices[i]
+            )
             locations.to_vertices[index_offset : index_offset + n_samples[i]] = (
                 self.segment_indices[i] + 1
             )
-            locations.fractions[
-                index_offset : index_offset + n_left_samples[i]
-            ] = left_fractions
+            locations.fractions[index_offset : index_offset + n_left_samples[i]] = (
+                left_fractions
+            )
             # 1 sample overlap thus - 1
             locations.fractions[
                 index_offset + n_left_samples[i] - 1 : index_offset + n_samples[i]

{pysnapping-0.2.1 → pysnapping-0.2.2}/pysnapping/snap.py

@@ -140,21 +140,26 @@ class SnappingParams(typing.NamedTuple):
 
         values_arr = np.asarray(values, dtype=float)
 
-        min_spacing = self.min_spacing
+        nan_min_spacing = self.min_spacing
         if consider_sampling_accuracy:
-            min_spacing += 2.01 * self.sampling_step
+            # extra spacing for numerical solution for untrusted points
+            nan_min_spacing += 2.01 * self.sampling_step
 
         # padding to treat NaNs at the boundary, d_min, d_max and min_spacing in an
         # elegant way
         padded_values = np.empty(len(values_arr) + 2)
-        padded_values[0] = d_min - min_spacing
+        padded_values[0] = d_min
         padded_values[1:-1] = values_arr
-        padded_values[-1] = d_max + min_spacing
+        padded_values[-1] = d_max
         del values_arr  # prevent accidental usage
 
         non_nan_indices = np.nonzero(np.logical_not(np.isnan(padded_values)))[0]
-        min_spacing_arr = np.diff(non_nan_indices).astype(float)
-        min_spacing_arr *= min_spacing
+        index_diffs = np.diff(non_nan_indices)
+        index_diffs[0] -= 1
+        index_diffs[-1] -= 1
+        min_spacing_arr = index_diffs.astype(float) * np.where(
+            index_diffs > 1, nan_min_spacing, self.min_spacing
+        )
 
         # bool to ensure builtin bool (and not numpy bool)
         return bool(np.all(np.diff(padded_values[non_nan_indices]) >= min_spacing_arr))
@@ -578,7 +583,14 @@ class TrajectoryTrip(XYZDMixin):
                 )
                 ppoints_list[i_global] = ppoints
         else:
-            logger.debug("spacing of distances is not OK, untrusting all distances")
+            logger.debug(
+                "spacing of distances %s is not OK (d_min=%s, d_max=%s, "
+                "min_spacing=%s), untrusting all distances",
+                self.dists,
+                self.trajectory.d_min,
+                self.trajectory.d_max,
+                params.min_spacing,
+            )
             # if the spacing was not ok, it can still be bad after untrusting all points
             # since the total length can be too short for the points
             untrusted_dists = np.full_like(self.dists, np.NaN)

pysnapping-0.2.2/pysnapping/stats.py

@@ -0,0 +1,132 @@
+from dataclasses import dataclass, field
+from enum import Enum
+import typing
+from collections import Counter
+import logging
+
+from pysnapping import SnappingError, SnappingMethod
+
+if typing.TYPE_CHECKING:
+    from pysnapping.snap import SnappedTripPoints, TrajectoryTrip
+
+
+logger = logging.getLogger(__name__)
+
+
+class AggregatedSnappingMethod(Enum):
+    failed = "failed"
+    all_trusted = "all_trusted"
+    all_routed = "all_routed"
+    all_fallback = "all_fallback"
+    mixed = "mixed"
+    total = "total"
+
+
+@dataclass
+class SnappingStats:
+    method_counters: list[Counter[SnappingMethod]] = field(default_factory=list)
+    aggregated_counter: Counter[AggregatedSnappingMethod] = field(
+        default_factory=Counter
+    )
+
+    def reset(self) -> None:
+        self.method_counters.clear()
+        self.aggregated_counter.clear()
+
+    def process_result(
+        self, result: "SnappedTripPoints"
+    ) -> tuple[Counter[SnappingMethod], AggregatedSnappingMethod]:
+        counter = Counter(result.methods)
+        self.method_counters.append(counter)
+        agg_method = self.aggregate_methods(counter)
+        self.aggregated_counter[agg_method] += 1
+        self.aggregated_counter[AggregatedSnappingMethod.total] += 1
+        return counter, agg_method
+
+    def aggregate_methods(
+        self, counter: Counter[SnappingMethod]
+    ) -> AggregatedSnappingMethod:
+        n_total = sum(v for v in counter.values())
+        if counter[SnappingMethod.trusted] == n_total:
+            return AggregatedSnappingMethod.all_trusted
+        elif counter[SnappingMethod.routed] == n_total:
+            return AggregatedSnappingMethod.all_routed
+        elif counter[SnappingMethod.fallback] == n_total:
+            return AggregatedSnappingMethod.all_fallback
+        else:
+            return AggregatedSnappingMethod.mixed
+
+    def process_failure(self) -> None:
+        agg_method = AggregatedSnappingMethod.failed
+        self.aggregated_counter[agg_method] += 1
+        self.aggregated_counter[AggregatedSnappingMethod.total] += 1
+        logger.debug("snapping failed")
+
+    @typing.overload
+    def snap_trip_points(
+        self,
+        ttrip: "TrajectoryTrip",
+        *args,
+        log_failed: bool = False,
+        raise_failed: typing.Literal[True] = ...,
+        **kwargs,
+    ) -> "SnappedTripPoints": ...
+
+    @typing.overload
+    def snap_trip_points(
+        self,
+        ttrip: "TrajectoryTrip",
+        *args,
+        log_failed: bool = False,
+        raise_failed: typing.Literal[False],
+        **kwargs,
+    ) -> typing.Optional["SnappedTripPoints"]: ...
+
+    def snap_trip_points(
+        self,
+        ttrip: "TrajectoryTrip",
+        *args,
+        log_failed: bool = False,
+        raise_failed: bool = True,
+        **kwargs,
+    ) -> typing.Optional["SnappedTripPoints"]:
+        """Wrapper for `TrajectoryTrip.snap_trip_points` that updates the statistics.
+
+        Snapping statistics and failures are aggregated and logged at level DEBUG. Apart
+        from that, by default, snapping errors are raised and not logged. By setting
+        `raise_failed` and/or `log_failed` you can choose whether to raise and/or log
+        failures at level ERROR (with traceback).
+
+        If you need more custom logging, you should either raise, catch and log or not
+        use this wrapper and use `process_result` and `process_failure` instead for even
+        more control.
+        """
+        try:
+            result = ttrip.snap_trip_points(*args, **kwargs)
+        except SnappingError as error:
+            self.process_failure()
+            (logger.exception if log_failed else logger.debug)(
+                "snapping %r failed: %s",
+                ttrip,
+                error,
+            )
+            if raise_failed:
+                raise
+            else:
+                return None
+        else:
+            counter, agg_method = self.process_result(result)
+            logger.debug(
+                "snapping %r succeeded with methods %s aggregated to %s",
+                ttrip,
+                {k.value: v for k, v in counter.items()},
+                agg_method.value,
+            )
+            return result
+
+    def log_aggregated(self, prefix: str = "") -> None:
+        logger.info(
+            "%s%s",
+            prefix,
+            {k.value: v for k, v in self.aggregated_counter.items()},
+        )

{pysnapping-0.2.1 → pysnapping-0.2.2}/pysnapping/test/test_snap.py

@@ -15,6 +15,7 @@ from pysnapping.snap import (
     SnappingParams,
 )
 from pysnapping.linear_referencing import locate, interpolate, resample
+from pysnapping.stats import SnappingStats
 from pysnapping.util import get_trafo, transform_coords
 from pysnapping import EPSG4326, EPSG4978
 
@@ -52,27 +53,40 @@ def segment_lengths_to_dists(segment_lengths, start=0):
 
 
 @pytest.mark.parametrize(
-    "values,d_min,d_max,min_spacing,ok",
+    "values,d_min,d_max,min_spacing,consider_sampling_accuracy,ok",
     [
-        ([], 0, 0, 10, True),
-        ([np.NaN], 0, 0, 10, True),
-        ([0], 0, 0, 10, True),
-        ([1], 0, 1, 10, True),
-        ([1], 0, 1 - 1e-6, 10, False),
-        ([np.NaN, 1, np.NaN], 0, 2, 1 - 1e-6, True),
-        ([np.NaN, 1, np.NaN], 0, 1.9, 1, False),
-        ([-1, np.NaN, np.NaN, 0], -10, 10, 1, False),
-        ([-1, np.NaN, np.NaN, 0], -10, 10, 0.5, False),
-        ([-1, np.NaN, np.NaN, 0], -10, 10, 1 / 3 - 1e-6, True),
-        ([np.NaN, np.NaN, np.NaN], -100, 0, 50 - 1e-6, True),
-        ([np.NaN, np.NaN, np.NaN], -100, 0, 50 + 1e-6, False),
+        ([], 0, 0, 10, False, True),
+        ([np.NaN], 0, 0, 10, False, True),
+        ([0], 0, 0, 10, False, True),
+        ([1], 0, 1, 10, False, True),
+        ([1], 0, 1 - 1e-6, 10, False, False),
+        ([np.NaN, 1, np.NaN], 0, 2, 1 - 1e-6, False, True),
+        ([np.NaN, 1, np.NaN], 0, 1.9, 1, False, False),
+        ([-1, np.NaN, np.NaN, 0], -10, 10, 1, False, False),
+        ([-1, np.NaN, np.NaN, 0], -10, 10, 0.5, False, False),
+        ([-1, np.NaN, np.NaN, 0], -10, 10, 1 / 3 - 1e-6, False, True),
+        ([np.NaN, np.NaN, np.NaN], -100, 0, 50 - 1e-6, False, True),
+        ([np.NaN, np.NaN, np.NaN], -100, 0, 50 + 1e-6, False, False),
+        ([0, 0, 1, 1, 1.001, 1.001, 10, 10], 0, 10, 0, False, True),
+        ([0, 0, 1, 1, 1.001, 1.001, 10, 10], 0, 10, 0, True, True),
+        ([0, 0, 1, np.NaN, 1, 1.001, 1.001, 10, 10], 0, 10, 0, False, True),
+        ([0, 0, 1, np.NaN, 1, 1.001, 1.001, 10, 10], 0, 10, 0, True, False),
+        ([-1e9, 1e9], -1e9, 1e9, 0, False, True),
+        ([-1e9, 1e9], -1e9, 1e9, 0, True, True),
+        ([-1e9, 1e9], -1e9, 1e9, 2.01 * 5.0, False, True),
+        ([-1e9, 1e9], -1e9, 1e9, 2.01 * 5.0, True, True),
     ],
 )
 def test_spacing_ok(
-    values: "ArrayLike", d_min: float, d_max: float, min_spacing: float, ok: bool
+    values: "ArrayLike",
+    d_min: float,
+    d_max: float,
+    min_spacing: float,
+    consider_sampling_accuracy: bool,
+    ok: bool,
 ) -> None:
     params = SnappingParams(min_spacing=min_spacing)
-    assert params.spacing_ok(values, d_min, d_max) == ok
+    assert params.spacing_ok(values, d_min, d_max, consider_sampling_accuracy) == ok
 
 
 # test around the entire earth with different orientations
@@ -276,6 +290,9 @@ def test_short_trajectory_and_random_garbage(seed):
         atol_snap=float("inf"),
     )
 
+    # just to get code coverage of stats module
+    stats = SnappingStats()
+
     rng = np.random.default_rng(seed=seed)
 
     if seed == 0:
@@ -312,7 +329,9 @@ def test_short_trajectory_and_random_garbage(seed):
 
     dtrip = DubiousTrajectoryTrip(dtraj, trip_xyzd)
     trip = dtrip.to_trajectory_trip()
-    snapped = trip.snap_trip_points(params)
+    snapped = stats.snap_trip_points(trip, params)
+    stats.log_aggregated(prefix=f"seed {seed}: ")
+    stats.reset()
     min_spacing = min(params.min_spacing, trip.trajectory.length / (n_points - 1))
     for split_segment in snapped.get_inter_point_ls_lon_lat_in_travel_direction():
         assert (
@@ -350,11 +369,12 @@ def test_complex_trip():
 
 
 # 25 is default min_spacing and 5 is default sampling_step.
-# The cutoff is at 25 + 2.01 * 5 thus 35 should be too close but 36 should be good.
+# The cutoff is at 25 thus 24.9 should be too close but 25.1 should be good.
 @pytest.mark.parametrize(
-    "spacing,method", ((35, SnappingMethod.routed), (36, SnappingMethod.trusted))
+    "spacing,method", ((24.9, SnappingMethod.routed), (25.1, SnappingMethod.trusted))
 )
 def test_untrust_bad_spacing(spacing: float, method: SnappingMethod) -> None:
+    params = SnappingParams(atol_trusted=1e3)
     length = 50
     dtraj = make_dubious_traj(
         [length],
@@ -370,7 +390,7 @@ def test_untrust_bad_spacing(spacing: float, method: SnappingMethod) -> None:
         xyzd=trip_xyzd,
     )
     trip = dtrip.to_trajectory_trip()
-    snapped = trip.snap_trip_points()
+    snapped = trip.snap_trip_points(params)
     assert not snapped.reverse_order
     assert np.all(snapped.methods == method)
 

{pysnapping-0.2.1 → pysnapping-0.2.2}/pysnapping.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pysnapping
-Version: 0.2.1
+Version: 0.2.2
 Summary: Snap points to a line string keeping a given order or spacing intact
 Author-email: Alexander Held | geOps <alexander.held@geops.com>
 Maintainer-email: Alexander Held | geOps <alexander.held@geops.com>
@@ -40,7 +40,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: shapely
-Requires-Dist: numpy
+Requires-Dist: numpy<2
 Requires-Dist: pyproj>=3.2.0
 
 # PySnapping
@@ -85,9 +85,14 @@ The `pysnapping.util` module contains common helper functions used in other part
 
 ### Snapping
 
-The `pysanpping.snap` module is the main entry point for users of the `pysnapping` library and
+The `pysnapping.snap` module is the main entry point for users of the `pysnapping` library and
 provides the classes needed to use the library.
 
+### Statistics
+
+The `pysnapping.stats` module provides tools to aggregate statistics about snapping
+failures and the methods used in case of success.
+
 ## Usage
 
 The typical usage pattern is to create a `pysnapping.snap.DubiousTrajectory` instance which represents

{pysnapping-0.2.1 → pysnapping-0.2.2}/pysnapping.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ pysnapping/__init__.py
 pysnapping/linear_referencing.py
 pysnapping/py.typed
 pysnapping/snap.py
+pysnapping/stats.py
 pysnapping/util.py
 pysnapping.egg-info/PKG-INFO
 pysnapping.egg-info/SOURCES.txt

{pysnapping-0.2.1 → pysnapping-0.2.2}/pysnapping.egg-info/requires.txt

@@ -1,3 +1,3 @@
 shapely
-numpy
+numpy<2
 pyproj>=3.2.0

pysnapping-0.2.2/requirements.txt

@@ -0,0 +1,12 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml -o requirements.txt -p 3.9
+certifi==2025.1.31
+    # via pyproj
+numpy==1.26.4
+    # via
+    #   pysnapping (pyproject.toml)
+    #   shapely
+pyproj==3.6.1
+    # via pysnapping (pyproject.toml)
+shapely==2.0.7
+    # via pysnapping (pyproject.toml)

pysnapping-0.2.1/requirements.txt

@@ -1,16 +0,0 @@
-#
-# This file is autogenerated by pip-compile with Python 3.9
-# by the following command:
-#
-#    pip-compile pyproject.toml
-#
-certifi==2023.11.17
-    # via pyproj
-numpy==1.26.3
-    # via
-    #   pysnapping (pyproject.toml)
-    #   shapely
-pyproj==3.6.1
-    # via pysnapping (pyproject.toml)
-shapely==2.0.2
-    # via pysnapping (pyproject.toml)