trajectopy 4.4.0__tar.gz → 5.0.0__tar.gz

{trajectopy-4.4.0 → trajectopy-5.0.0}/.gitattributes

@@ -1,3 +1,12 @@
 trajectopy/core/report/templates/*.html linguist-generated
 trajectopy/core/report/assets/*.css linguist-generated
 example_data/*.html linguist-generated
+
+# Never convert line endings in binary files
+*.png binary
+*.ico binary
+*.gif binary
+*.jpg binary
+*.jpeg binary
+*.pdf binary
+*.bag binary

trajectopy-5.0.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --group dev --extra gui  # GUI packages provide the type information for trajectopy.gui
+      - run: uv run ruff check trajectopy test example_scripts
+      - run: uv run ruff format --check trajectopy test example_scripts
+      - run: uv run mypy
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    env:
+      # plots and the GUI are tested without a display
+      QT_QPA_PLATFORM: offscreen
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y libegl1 libgl1 libxkbcommon0 libfontconfig1 libdbus-1-3
+      - run: uv sync --group dev --extra gui
+      - run: uv run pytest -q --cov=trajectopy --cov-report=term
+
+  core-only:
+    # the package must work without the optional plotting/GUI dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv sync --group dev
+      - run: uv run pytest -q

trajectopy-5.0.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.7.6
+    hooks:
+      - id: uv-lock
+      - id: uv-export
+
+  - repo: local
+    hooks:
+      - id: pytest
+        name: Run unit tests
+        entry: uv run pytest -q
+        language: system
+        pass_filenames: false
+        stages: [pre-commit]
+        always_run: true

{trajectopy-4.4.0 → trajectopy-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: trajectopy
-Version: 4.4.0
+Version: 5.0.0
 Summary: Trajectory Evaluation in Python
 Project-URL: Homepage, https://gereon-t.github.io/trajectopy/
 Project-URL: Documentation, https://gereon-t.github.io/trajectopy/
@@ -22,20 +22,18 @@ Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.10
 Requires-Dist: autograd>=1.8.0
-Requires-Dist: jinja2>=3.1.6
-Requires-Dist: matplotlib>=3.9.4
 Requires-Dist: numpy>=2.0.2
 Requires-Dist: pandas>=2.2.3
-Requires-Dist: plotly>=6.1.0
 Requires-Dist: pyproj>=3.6.1
-Requires-Dist: rich>=14.0.0
 Requires-Dist: rosbags>=0.9.23
 Requires-Dist: scipy>=1.13.1
 Provides-Extra: gui
-Requires-Dist: pyqtgraph; extra == 'gui'
-Requires-Dist: pyside6; extra == 'gui'
-Requires-Dist: pyvista; extra == 'gui'
-Requires-Dist: pyvistaqt; extra == 'gui'
+Requires-Dist: pyopengl>=3.1.7; extra == 'gui'
+Requires-Dist: pyqtgraph>=0.13.7; extra == 'gui'
+Requires-Dist: pyside6-essentials>=6.8; extra == 'gui'
+Provides-Extra: plot
+Requires-Dist: pyqtgraph>=0.13.7; extra == 'plot'
+Requires-Dist: pyside6-essentials>=6.8; extra == 'plot'
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -43,7 +41,7 @@ Description-Content-Type: text/markdown
     <a href="https://github.com/gereon-t/trajectopy/releases"><img src="https://img.shields.io/github/v/release/gereon-t/trajectopy?label=version" /></a>
     <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" /></a>
     <a href="https://github.com/gereon-t/trajectopy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gereon-t/trajectopy" /></a>
-    <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
+    <a href="https://github.com/astral-sh/ruff"><img alt="Code style: ruff" src="https://img.shields.io/badge/code%20style-ruff-000000.svg"></a>
     <br />
     <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Windows-0078D6?st&logo=windows&logoColor=white" /></a>
     <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black" /></a>
@@ -58,12 +56,6 @@ Description-Content-Type: text/markdown
   <img style="border-radius: 10px;" src="https://raw.githubusercontent.com/gereon-t/trajectopy/main/.images/trajectopy_gif_low_quality.gif">
 </p>
 
-Using [Mapbox](https://www.mapbox.com/), you can visualize your trajectories on a map:
-
-<p align="center">
-  <img style="border-radius: 10px;" src=".images/plot.png">
-</p>
-
 </div>
 
 ## Installation
@@ -74,6 +66,12 @@ Full version (with GUI):
 pip install "trajectopy[gui]"
 ```
 
+Python package with plotting (no GUI):
+
+```bash
+pip install "trajectopy[plot]"
+```
+
 Python package only:
 
 ```bash
@@ -92,7 +90,7 @@ Trajectopy offers a range of features, including:
 - __Alignment__: An advanced trajectory alignment algorithm that can be tailored to the specific application and supports a similarity transformation, a leverarm and a time shift estimation.
 - __Comparison__: Absolute and relative trajectory comparison metrics (__ATE and RPE__) that can be computed using various pose-matching methods.
 - __Data Import/Export__: Support for importing and exporting data, ensuring compatibility with your existing workflows.
-- __Customizable Visualization__: Powered by [Plotly](https://plotly.com/) or [Matplotlib](https://matplotlib.org/), trajectopy offers a range of interactive plots that can be customized to your needs. ([Demo](https://htmlpreview.github.io/?https://github.com/gereon-t/trajectopy/blob/main/example_data/report.html))
+- __Fast, Interactive Visualization__: Powered by [pyqtgraph](https://www.pyqtgraph.org/), the same plots are available in the GUI and in Python scripts, stay fluid for large trajectories, and can be exported to PNG, JPG or SVG. Georeferenced trajectories and ATE results can be exported to Google Earth, colored by speed, height or deviations, on the terrain or at their own heights, with playback.
 
 ## Web Application (Docker)
 

{trajectopy-4.4.0 → trajectopy-5.0.0}/README.md

@@ -1,75 +1,75 @@
-<div align="center">
-    <h1>Trajectopy - Trajectory Evaluation in Python</h1>
-    <a href="https://github.com/gereon-t/trajectopy/releases"><img src="https://img.shields.io/github/v/release/gereon-t/trajectopy?label=version" /></a>
-    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" /></a>
-    <a href="https://github.com/gereon-t/trajectopy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gereon-t/trajectopy" /></a>
-    <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
-    <br />
-    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Windows-0078D6?st&logo=windows&logoColor=white" /></a>
-    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black" /></a>
-    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/mac%20os-000000?&logo=apple&logoColor=white" /></a>
-    <div>
-      <img src=".images/uni_bonn.svg" height="50" />
-      <img src=".images/igg.gif" height="50" />
-    </div>
-<h4>Trajectopy is a Python package with an optional graphical user interface for empirical trajectory evaluation. </h4>
-
-<p align="center">
-  <img style="border-radius: 10px;" src="https://raw.githubusercontent.com/gereon-t/trajectopy/main/.images/trajectopy_gif_low_quality.gif">
-</p>
-
-Using [Mapbox](https://www.mapbox.com/), you can visualize your trajectories on a map:
-
-<p align="center">
-  <img style="border-radius: 10px;" src=".images/plot.png">
-</p>
-
-</div>
-
-## Installation
-
-Full version (with GUI):
-
-```bash
-pip install "trajectopy[gui]"
-```
-
-Python package only:
-
-```bash
-pip install trajectopy
-```
-
-## Documentation
-
-<a href="https://gereon-t.github.io/trajectopy/" target="_blank">https://gereon-t.github.io/trajectopy/</a>
-
-## Key Features
-
-Trajectopy offers a range of features, including:
-
-- __Interactive GUI__: A user-friendly interface that enables seamless interaction with your trajectory data, making it easy to visualize, align, and compare trajectories.
-- __Alignment__: An advanced trajectory alignment algorithm that can be tailored to the specific application and supports a similarity transformation, a leverarm and a time shift estimation.
-- __Comparison__: Absolute and relative trajectory comparison metrics (__ATE and RPE__) that can be computed using various pose-matching methods.
-- __Data Import/Export__: Support for importing and exporting data, ensuring compatibility with your existing workflows.
-- __Customizable Visualization__: Powered by [Plotly](https://plotly.com/) or [Matplotlib](https://matplotlib.org/), trajectopy offers a range of interactive plots that can be customized to your needs. ([Demo](https://htmlpreview.github.io/?https://github.com/gereon-t/trajectopy/blob/main/example_data/report.html))
-
-## Web Application (Docker)
-
-A simple web application is available at [gereon-t/trajectopy-web](https://github.com/gereon-t/trajectopy-web) that allows you to use the core functionality of Trajectopy using Docker.
-
-## Citation
-
-If you use this library for any academic work, please cite our original [paper](https://www.degruyter.com/document/doi/10.1515/jag-2024-0040/html).
-
-```bibtex
-@article{Tombrink2024,
-url = {https://doi.org/10.1515/jag-2024-0040},
-title = {Spatio-temporal trajectory alignment for trajectory evaluation},
-author = {Gereon Tombrink and Ansgar Dreier and Lasse Klingbeil and Heiner Kuhlmann},
-journal = {Journal of Applied Geodesy},
-doi = {doi:10.1515/jag-2024-0040},
-year = {2024},
-codeurl = {https://github.com/gereon-t/trajectopy},
-}
-```
+<div align="center">
+    <h1>Trajectopy - Trajectory Evaluation in Python</h1>
+    <a href="https://github.com/gereon-t/trajectopy/releases"><img src="https://img.shields.io/github/v/release/gereon-t/trajectopy?label=version" /></a>
+    <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.10+-blue.svg" /></a>
+    <a href="https://github.com/gereon-t/trajectopy/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gereon-t/trajectopy" /></a>
+    <a href="https://github.com/astral-sh/ruff"><img alt="Code style: ruff" src="https://img.shields.io/badge/code%20style-ruff-000000.svg"></a>
+    <br />
+    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Windows-0078D6?st&logo=windows&logoColor=white" /></a>
+    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=black" /></a>
+    <a href="https://github.com/gereon-t/trajectopy"><img src="https://img.shields.io/badge/mac%20os-000000?&logo=apple&logoColor=white" /></a>
+    <div>
+      <img src=".images/uni_bonn.svg" height="50" />
+      <img src=".images/igg.gif" height="50" />
+    </div>
+<h4>Trajectopy is a Python package with an optional graphical user interface for empirical trajectory evaluation. </h4>
+
+<p align="center">
+  <img style="border-radius: 10px;" src="https://raw.githubusercontent.com/gereon-t/trajectopy/main/.images/trajectopy_gif_low_quality.gif">
+</p>
+
+</div>
+
+## Installation
+
+Full version (with GUI):
+
+```bash
+pip install "trajectopy[gui]"
+```
+
+Python package with plotting (no GUI):
+
+```bash
+pip install "trajectopy[plot]"
+```
+
+Python package only:
+
+```bash
+pip install trajectopy
+```
+
+## Documentation
+
+<a href="https://gereon-t.github.io/trajectopy/" target="_blank">https://gereon-t.github.io/trajectopy/</a>
+
+## Key Features
+
+Trajectopy offers a range of features, including:
+
+- __Interactive GUI__: A user-friendly interface that enables seamless interaction with your trajectory data, making it easy to visualize, align, and compare trajectories.
+- __Alignment__: An advanced trajectory alignment algorithm that can be tailored to the specific application and supports a similarity transformation, a leverarm and a time shift estimation.
+- __Comparison__: Absolute and relative trajectory comparison metrics (__ATE and RPE__) that can be computed using various pose-matching methods.
+- __Data Import/Export__: Support for importing and exporting data, ensuring compatibility with your existing workflows.
+- __Fast, Interactive Visualization__: Powered by [pyqtgraph](https://www.pyqtgraph.org/), the same plots are available in the GUI and in Python scripts, stay fluid for large trajectories, and can be exported to PNG, JPG or SVG. Georeferenced trajectories and ATE results can be exported to Google Earth, colored by speed, height or deviations, on the terrain or at their own heights, with playback.
+
+## Web Application (Docker)
+
+A simple web application is available at [gereon-t/trajectopy-web](https://github.com/gereon-t/trajectopy-web) that allows you to use the core functionality of Trajectopy using Docker.
+
+## Citation
+
+If you use this library for any academic work, please cite our original [paper](https://www.degruyter.com/document/doi/10.1515/jag-2024-0040/html).
+
+```bibtex
+@article{Tombrink2024,
+url = {https://doi.org/10.1515/jag-2024-0040},
+title = {Spatio-temporal trajectory alignment for trajectory evaluation},
+author = {Gereon Tombrink and Ansgar Dreier and Lasse Klingbeil and Heiner Kuhlmann},
+journal = {Journal of Applied Geodesy},
+doi = {doi:10.1515/jag-2024-0040},
+year = {2024},
+codeurl = {https://github.com/gereon-t/trajectopy},
+}
+```

{trajectopy-4.4.0 → trajectopy-5.0.0}/example_scripts/align.py

@@ -1,7 +1,5 @@
-from matplotlib import pyplot as plt
-
 from trajectopy import Trajectory, align
-from trajectopy.visualization.mpl_plots import plot_positions
+from trajectopy import visualization as vis
 
 
 def main():
@@ -9,10 +7,9 @@ def main():
     est_traj = Trajectory.from_file("./example_data/KITTI_ORB.traj")
 
     est_traj_aligned = align(trajectory=est_traj, other=gt_traj, inplace=False)
-    est_traj_aligned.name += " (Aligned)"
+    est_traj_aligned.name += " (aligned)"
 
-    plot_positions(trajectories=[gt_traj, est_traj, est_traj_aligned])
-    plt.show()
+    vis.show(vis.positions_figure([gt_traj, est_traj, est_traj_aligned]))
 
 
 if __name__ == "__main__":

{trajectopy-4.4.0 → trajectopy-5.0.0}/example_scripts/alignment.py

@@ -1,7 +1,7 @@
 import logging
 
 from trajectopy import ProcessingSettings, Trajectory, estimate_alignment
-from trajectopy.visualization import plotly_reports
+from trajectopy import visualization as vis
 
 logging.basicConfig(level=logging.INFO)
 
@@ -21,11 +21,8 @@ def main():
         matching_settings=processing_settings.matching,
     )
 
-    report = plotly_reports.create_alignment_report(
-        alignment_parameters=alignment_result.position_parameters,
-        name=alignment_result.name,
-    )
-    plotly_reports.show_report(report_text=report, filepath="reports/report.html")
+    # covariance and correlation of the estimated parameters
+    vis.show(vis.alignment_figures(alignment_result.position_parameters), title=alignment_result.name)
 
 
 if __name__ == "__main__":

{trajectopy-4.4.0 → trajectopy-5.0.0}/example_scripts/ate.py

@@ -1,26 +1,11 @@
 import logging
 
-from rich.console import Console
-from rich.table import Table
-
 from trajectopy import ProcessingSettings, Trajectory, ate
 
 logging.basicConfig(level=logging.INFO)
 
 
-def dict_to_table(data: dict):
-    """Converts a dictionary to a rich table."""
-    table_data = Table(title="ATE Results")
-    table_data.add_column("Property")
-    table_data.add_column("Value")
-    for key, value in data.items():
-        table_data.add_row(key, str(value))
-    return table_data
-
-
 def main():
-    console = Console()
-
     # Import
     gt_traj = Trajectory.from_file("./example_data/KITTI_gt.traj")
     est_traj = Trajectory.from_file("./example_data/KITTI_ORB.traj")
@@ -30,7 +15,10 @@ def main():
 
     # align = True is the default, but can be disabled if you want to evaluate the unaligned trajectories
     ate_result = ate(other=gt_traj, trajectory=est_traj, processing_settings=processing_settings, align=True)
-    console.print(dict_to_table(ate_result.property_dict))
+
+    width = max(len(key) for key in ate_result.property_dict)
+    for key, value in ate_result.property_dict.items():
+        print(f"{key:<{width}}  {value}")
 
 
 if __name__ == "__main__":

trajectopy-5.0.0/example_scripts/deviation_plots.py

@@ -0,0 +1,36 @@
+import logging
+
+from trajectopy import PlotSettings, ProcessingSettings, Trajectory, ate, rpe
+from trajectopy import visualization as vis
+
+logging.basicConfig(level=logging.INFO)
+
+
+def main():
+    gt_traj = Trajectory.from_file("./example_data/KITTI_gt.traj")
+    orb_traj = Trajectory.from_file("./example_data/KITTI_ORB.traj")
+    sptam_traj = Trajectory.from_file("./example_data/KITTI_SPTAM.traj")
+
+    processing_settings = ProcessingSettings()
+    ate_results = [
+        ate(trajectory=orb_traj, other=gt_traj, processing_settings=processing_settings),
+        ate(trajectory=sptam_traj, other=gt_traj, processing_settings=processing_settings),
+    ]
+    rpe_results = [
+        rpe(trajectory=orb_traj, other=gt_traj, processing_settings=processing_settings),
+        rpe(trajectory=sptam_traj, other=gt_traj, processing_settings=processing_settings),
+    ]
+
+    # The same figures work for one or several results.
+    plot_settings = PlotSettings(ate_unit_is_mm=False, directed_ate=True)
+    figures = vis.deviation_figures(ate_results, rpe_results, settings=plot_settings)
+
+    # Write every figure (and every variant, e.g. each color-coded quantity) to image files ...
+    vis.export_figures(figures, "plots", export_format="png")
+
+    # ... and/or explore them interactively.
+    vis.show(figures, title="KITTI Evaluation")
+
+
+if __name__ == "__main__":
+    main()

trajectopy-5.0.0/example_scripts/rpe.py

@@ -0,0 +1,20 @@
+from trajectopy import ProcessingSettings, Trajectory, rpe
+
+
+def main():
+    # Import
+    gt_traj = Trajectory.from_file("./example_data/KITTI_gt.traj")
+    est_traj = Trajectory.from_file("./example_data/KITTI_ORB.traj")
+
+    # default settings
+    processing_settings = ProcessingSettings()
+
+    rpe_result = rpe(other=gt_traj, trajectory=est_traj, processing_settings=processing_settings)
+
+    width = max(len(key) for key in rpe_result.property_dict)
+    for key, value in rpe_result.property_dict.items():
+        print(f"{key:<{width}}  {value}")
+
+
+if __name__ == "__main__":
+    main()

trajectopy-5.0.0/example_scripts/trajectory_plot.py

@@ -0,0 +1,18 @@
+import logging
+
+from trajectopy import Trajectory
+from trajectopy import visualization as vis
+
+logging.basicConfig(level=logging.INFO)
+
+
+def main():
+    gt_traj = Trajectory.from_file("./example_data/KITTI_gt.traj")
+    est_traj = Trajectory.from_file("./example_data/KITTI_ORB.traj")
+
+    # positions, coordinates and orientations over time, and maps colored by velocity / height
+    vis.show(vis.trajectory_figures([gt_traj, est_traj]))
+
+
+if __name__ == "__main__":
+    main()

{trajectopy-4.4.0 → trajectopy-5.0.0}/pyproject.toml

@@ -47,20 +47,19 @@ dynamic = ["version"]
 readme = "README.md"
 dependencies = [
     "autograd>=1.8.0",
-    "jinja2>=3.1.6",
-    "matplotlib>=3.9.4",
     "numpy>=2.0.2",
     "pandas>=2.2.3",
-    "plotly>=6.1.0",
     "pyproj>=3.6.1",
-    "rich>=14.0.0",
     "rosbags>=0.9.23",
     "scipy>=1.13.1",
 ]
 
 
 [project.optional-dependencies]
-gui = ["PySide6", "pyvista", "pyvistaqt", "pyqtgraph"]
+# Plotting (trajectopy.visualization) is built on pyqtgraph and needs Qt.
+plot = ["PySide6-Essentials>=6.8", "pyqtgraph>=0.13.7"]
+# The GUI additionally renders the 3D playback with OpenGL.
+gui = ["trajectopy[plot]", "PyOpenGL>=3.1.7"]
 
 [project.urls]
 Homepage = "https://gereon-t.github.io/trajectopy/"
@@ -73,7 +72,6 @@ trajectopy = "trajectopy.cli.main:main"
 
 [dependency-groups]
 dev = [
-    "black>=25.11.0",
     "mkdocs-material>=9.6.14",
     "mkdocstrings[python]>=0.24.0",
     "pillow>=11.2.1",
@@ -81,4 +79,34 @@ dev = [
     "pyinstaller>=6.13.0",
     "pytest>=8.3.5",
     "pytest-cov>=4.1.0",
+    "ruff>=0.14.0",
+    "mypy>=1.18.2",
+    "pandas-stubs>=2.2.3",
 ]
+
+[tool.ruff]
+line-length = 119
+target-version = "py310"
+extend-exclude = ["trajectopy-docs"]
+
+[tool.ruff.lint]
+select = ["E4", "E7", "E9", "F", "I", "UP", "B"]
+ignore = [
+    "B905",  # zip() without strict=: arrays are validated upstream
+    "E741",  # single-letter names such as `l` are standard notation in the math code
+    "B024",  # abstract base classes without abstract methods are used as markers
+]
+
+[tool.ruff.lint.per-file-ignores]
+"trajectopy/gui/app.py" = ["E402"]  # logging must be configured before the GUI modules are imported
+"trajectopy/visualization/__init__.py" = ["F401"]  # re-exports for type checkers; loaded lazily at runtime
+
+[tool.pytest.ini_options]
+testpaths = ["test"]
+
+[tool.mypy]
+files = ["trajectopy"]
+python_version = "3.10"
+ignore_missing_imports = true
+check_untyped_defs = true
+warn_unused_ignores = true