EPICA Documentation
epica is a trajectory alignment and evaluation toolkit. The package installs the command-line entrypoints epa and epica, which are interchangeable. It is built for reproducible benchmarking, practical analysis, and scalable experiment comparison.
Rerun demo: follow-view inspection of Ground truth and Estimation trajectories.
Features
- End-to-end trajectory alignment from time synchronization to final world-frame evaluation
- Command-line tools for single-run analysis, plotting, metric inspection, and cross-run comparison
- Reusable configuration defaults to keep repeated workflows consistent
- Reproducible figure generation through serialized plot specs and offline re-rendering
- Optional Rerun-based visualization for trajectory inspection and intermediate-stage debugging
- Batch benchmark workflows for large-scale evaluation, summary plots, and report generation
Supported Input Formats
The epa / epica command supports these trajectory and log formats:
autofor automatic format detection when possiblecsv/euroctumkittibag(ROS1)bag2/mcap(ROS2)
For ROS log formats (bag, bag2, mcap), install ROS support first:
python -m pip install "epica[ros]"
Main Commands
You may start with these commands:
epaorepica: run the full alignment and evaluation pipeline on one reference-estimation pairepa_all: run the single-case workflow in one command, including plots and packaged outputs
Trajectory and metric tools:
epa_traj: inspect, synchronize, align, and plot trajectoriesepa_ape: compute absolute pose error metricsepa_rpe: compute relative pose error metricsepa_res: compare multiple runs, result bundles, or metric outputs
Benchmark tools:
epa_bench: run multi-case benchmarks across many prepared casesepa_benchall: run the full benchmark workflow, including summary plots and LaTeX tables
Advanced utilities such as epa_config, epa_fig, epa_plot_summary, and epa_metric_res are documented in the CLI Reference.
Typical Workflow
- Prepare one reference trajectory and one estimated trajectory
- Run
epa(orepica) to align them and generate a run directory with metrics and plots - Use
epa_traj,epa_ape, orepa_rpewhen you want more focused inspection - Use
epa_resto compare multiple runs - Move to
epa_benchorepa_benchallwhen you need batch evaluation
Next Pages
- Quick Start: run your first example end to end
- CLI Reference: look up commands and frequently used options
- Error Metrics: understand ATE, RPE, drift rate, and drift-valid metrics
- Benchmark Workflow: run batch evaluation and generate summary artifacts
- Troubleshooting: resolve common setup and runtime issues
- Architecture: understand the pipeline internals and module layout