How malichao/slam works
Project Type & Purpose
• This is an open-source robotics “toolkit” / research monorepo, not a single web or mobile app.
• It bundles:
– Core algorithm libraries (GraphSearch, Smooth, KalmanFilter, PID, Vehicle dynamic model)
– Two Qt-based visualization GUIs (QSLAM, XV11_LIDAR_Visualizer)
– Standalone test / demo programs (SLAM console, PID simulator, KalmanFilter test)
– Documentation & data assets (maps, snapshots, CSV, docs).
Top-Level Components
• “Core Algorithms” (reusable libraries)
• GraphSearch (BFS, A*, Dynamic Programming, RRT)
• Smooth (path smoothing post-processor)
• KalmanFilter (portable C module for sensor fusion)
• PID Controller & Twiddle (1D/2D vehicle simulation)
• Vehicle Dynamic Model (used by RRT and PID sim)
• “Data Assets”
• Bitmaps (under Search/GraphSearch/test & QSLAM resources)
• Sensor logs (e.g. CSV in KalmanFilter, LIDAR raw logs)
• “Applications / GUIs”
• QSLAM Qt GUI (uses GraphSearch + Smooth + resource bitmaps)
• XV11_LIDAR_Visualizer Qt GUI (sensor acquisition + filtering, pure viz)
• SLAM console/demo (command-line GraphSearch and SLAM tests)
• PID Simulator (console / plot output)
• KalmanFilter test harness (test.c)
• “Hardware Interface” (only for LIDAR)
• XV-11 serial parser → raw point data → filter → GUI
Inter-Component Relationships
– From “Data Assets” → GraphSearch library (map bitmaps feed search algos)
– GraphSearch → Smooth (search output fed into smoother)
– GraphSearch & Smooth → QSLAM GUI (for visualization & animation)
– Vehicle Dynamic Model & PID → PID Simulator (1D/2D sim)
– Gyro + Accel sensor data → KalmanFilter → KalmanFilter test harness
– LIDAR Hardware Interface → Data Filter → LIDAR GUI
• “Core Algorithms” as a shared services layer beneath the apps that consume them.
Architectural Patterns & Principles
• Layered Architecture:
– Hardware / Data Input layer (sensors, map files)
– Core Algorithm layer (search, smoothing, filtering, control)
– Application layer (GUI, console demos)
• Modularization: each algorithm lives in its own directory and builds as a separate library or .o files.
• Qt-based MVC-ish for GUIs: .ui files define Views (mainwindow.ui, settingsdialog.ui), Controllers in *.cpp, Models in core algorithm calls.
Technologies & Frameworks
• C & C++ (GCC/Eclipse CDT for some, Qt/.pro for QSLAM and LIDAR)
• Qt Widgets (mainwindow.ui, signal/slot in console.cpp, renderarea.cpp)
• Makefiles / managed CDT project files for build
• No external servers or cloud services