How gongsta/vslam-py works
Project Type and Purpose
• This is a research-oriented, Python-based Visual Odometry (VO) and Visual SLAM system.
• It supports both monocular and stereo modes and benchmarks against standard datasets (KITTI, TUM).
• It is structured as a collection of scripts for different modes (VO vs. SLAM, monocular vs. stereo) plus core processing modules, helpers, evaluation, and visualization components.
High-Level Component Identification
a. Data Input & Dataset Management
• Scripts: main_kitti.py, main_tum.py, main_mono_vo.py, main_stereo_vo.py, main_stereo_slam.py
• Data folders: KITTI_sequence_1/, eval/groundtruth.txt
• Helpers: helpers/play.py, helpers/record_zed.py
b. Core Processing
• vo.py: frame-to-frame odometry (feature detection, matching, PnP)
• slam.py: stereo SLAM pipeline (keyframe selection, local mapping)
• optimizer.py: graph optimization (g2o bindings)
• loop_closure.py: place recognition & global pose‐graph updates
c. Utilities & Support
• utils.py: camera calibration, timestamp management, data structures
• visualization.py: Pangolin (real-time 3D) + Matplotlib fallback
d. Evaluation & Benchmarking
• eval/associate.py, eval/evaluate_ate.py: align estimated vs. ground-truth poses
• results/: logged pose outputs for tracking improvements
e. Third-Party Dependencies
• OpenCV (feature extraction, matching)
• g2o-python (optimizer)
• Pangolin (3D visualization)
• third_party/opencv_vpi (optional hardware acceleration)
Relationships & Data Flow
1. Dataset Loader →
2. Frame Preprocessing (undistort, rectify) →
3. Feature Detection & Matching (vo.py) →
4. Pose Estimation
• Monocular VO: PnP + epipolar geometry
• Stereo SLAM: keyframe insertion, local BA
5. Loop Closure (loop_closure.py) → pose-graph updates via optimizer.py
6. Visualization (visualization.py / Pangolin)
7. Logging & Evaluation (save poses → eval/evaluate_ate.py)
Architectural Patterns
• Modular pipeline: clear separation of concerns (VO vs. SLAM vs. optimization)
• Data-flow architecture: each major step outputs data for the next stage
• Optional hardware acceleration: plug-in folder for OpenCV VPI
• Script-based entry points: distinct mains for each mode