# xiaoliangabc/lidar_camera_calibration architecture

> Architecture diagram of the GitHub repository xiaoliangabc/lidar_camera_calibration, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/xiaoliangabc/lidar_camera_calibration
- Repository: https://github.com/xiaoliangabc/lidar_camera_calibration

## Overview

##### Project Type and Purpose
- This is a ROS‐based calibration toolkit (“lidar_camera_calibration”) that performs both intrinsic (camera) and extrinsic (LiDAR‐camera) calibration using a chessboard target. It consists of multiple ROS nodes written in C++ (with optional MATLAB integration) and supporting configuration/visualization assets.

##### File Structure Analysis
- Top‐level:
- CMakeLists.txt, package.xml ⇒ ROS package boilerplate
- README.md ⇒ high‐level overview
- Directories:
- launch/ ⇒ ROS launch files for each calibration stage
- src/ ⇒ C++ node implementations:
– data_generate.cc
– camera_calibration.cc
– lidar_chessboard_detector.cc
– lidar_camera_calibration.cc
– manual_calibration.cc
– rviz_command_button.cc
- /lidar_camera_calibration/ ⇒ node headers & utility functions
- /cppoptlib/ ⇒ embedded optimization library (solvers)
- cfg/, param/ ⇒ dynamic‐reconfigure & YAML params
- rviz/, matlab/ ⇒ RViz layouts & MATLAB script for intrinsic calibration
- Key patterns:
- ROS publisher/subscriber + dynamic reconfigure
- Modular node per calibration stage
- Optimization library (cppoptlib) used for two‐stage extrinsic calibration

##### Main Components
- ROS Master
- Nodes:
1. data_generate (collects image + LiDAR cloud pairs)
2. camera_calibration (intrinsic; C++ wrapper or MATLAB script)
3. lidar_chessboard_detector (plane detection in point clouds)
4. lidar_camera_calibration (auto‐optimization of extrinsics)
5. manual_calibration (GUI‐assisted fine‐tuning via rqt_reconfigure)
6. rviz_command_button (custom RViz plugin for “Save”/“Next” buttons)
- Topics & Data Flows:
- /camera/image_raw ⇒ camera images
- /velodyne_points (or configured) ⇒ LiDAR clouds
- Custom “cloud+image” pairing channel to data_generate
- Detected chessboard models ⇒ files or parameters
- Final calibration parameters ⇒ saved to data/result
- Supporting Services:
- dynamic_reconfigure server for tuning parameters
- ROS parameter server (YAML files under param/)
- External Tools:
- MATLAB / MATLAB Runtime (for intrinsic calibration)
- RViz (visualization) & rqt_reconfigure (parameter tweaking)

##### Relationships and Interactions
- data_generate subscribes to image & cloud ⇒ publishes paired file paths
- camera_calibration reads images from disk or via launch ⇒ outputs intrinsics
- lidar_chessboard_detector subscribes to point clouds ⇒ publishes detected plane info & renders point sets in RViz
- lidar_camera_calibration reads both chessboard models (camera & LiDAR) ⇒ runs two‐stage optimization via cppoptlib ⇒ outputs extrinsics
- manual_calibration overlays point cloud on image in RViz ⇒ dynamic_reconfigure callback updates transform in real time

##### Architectural Patterns & Design Principles
- Loose coupling: each ROS node handles one stage
- Publisher/Subscriber for asynchronous data flow
- Parameterization via YAML + dynamic_reconfigure
- Reuse of a generic optimization library (cppoptlib) for solver algorithms
- Separation of concerns: visualization (RViz) vs. computation (nodes) vs. UI (rqt buttons)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Nodes
    subgraph "ROS Core"
        ROSMaster[/"ROS Master"/]:::rosmaster
    end

    %% Topics
    subgraph "Topics"
        camImg["/camera/image_raw"]:::topic
        lidarPts["/velodyne_points"]:::topic
        pairChan["cloud+image pairing"]:::topic
    end

    %% Computation Nodes
    subgraph "Computation Nodes"
        dataGen["data_generate\n(collect image+LiDAR)"]:::compute
        camCal["camera_calibration\n(intrinsic)"]:::compute
        lidarDetect["lidar_chessboard_detector\n(plane detection)"]:::compute
        extrinCal["lidar_camera_calibration\n(extrinsic opt)"]:::compute
        manualCal["manual_calibration\n(GUI fine-tune)"]:::compute
    end

    %% Visualization / UI
    subgraph "Visualization/UI Plugins"
        rvizBtn["rviz_command_button\n(Save/Next UI)"]:::ui
    end

    %% Configuration
    subgraph "Configuration"
        paramsYAML["param/*.yaml"]:::file
        dynReconf["cfg/*.cfg"]:::file
        launchFiles["launch/*.launch"]:::file
    end

    %% Visualization Assets
    subgraph "RViz Layouts"
        rvizDG["data_generate.rviz"]:::file
        rvizLD["lidar_chessboard_detector.rviz"]:::file
        rvizMC["manual_calibration.rviz"]:::file
    end

    %% External Tools
    subgraph "External Tools"
        MATLAB["MATLAB / Runtime"]:::external
        RVizApp["RViz Viewer"]:::external
        RQT["rqt_reconfigure"]:::external
    end

    %% Relationships
    ROSMaster --> camImg
    ROSMaster --> lidarPts

    camImg --> dataGen
    lidarPts --> dataGen
    dataGen --> pairChan

    pairChan --> lidarDetect
    pairChan --> camCal

    lidarDetect --> extrinCal
    camCal --> extrinCal

    extrinCal --> manualCal
    RQT --> manualCal
    RVizApp --> manualCal

    manualCal -->|"dynamic_reconfigure"| ROSMaster

    rvizBtn --> manualCal
    RVizApp --> rvizBtn

    %% File I/O
    dataGen -->|"writes pairs to disk"| paramsYAML
    extrinCal -->|"outputs extrinsics"| paramsYAML

    %% Visualization links
    dataGen --> rvizDG
    lidarDetect --> rvizLD
    manualCal --> rvizMC

    %% External integration
    camCal --> MATLAB
    rvizLD --> RVizApp
    rvizDG --> RVizApp
    rvizMC --> RVizApp

    %% Click Events
    click dataGen "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/src/data_generate.cc"
    click camCal "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/src/camera_calibration.cc"
    click lidarDetect "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/src/lidar_chessboard_detector.cc"
    click extrinCal "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/src/lidar_camera_calibration.cc"
    click manualCal "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/src/manual_calibration.cc"
    click rvizBtn "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/src/rviz_command_button.cc"

    click paramsYAML "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/param/parameters.yaml"
    click dynReconf "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/cfg/ChessboardDetector.cfg"
    click launchFiles "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/launch/data_generate.launch"
    click rvizDG "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/rviz/data_generate.rviz"
    click rvizLD "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/rviz/lidar_chessboard_detector.rviz"
    click rvizMC "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/rviz/manual_calibration.rviz"
    click MATLAB "https://github.com/xiaoliangabc/lidar_camera_calibration/blob/master/matlab/camera_calibration.m"

    %% Styles
    classDef compute fill:#D0E8FF,stroke:#003366,stroke-width:1px
    classDef ui fill:#FFE8CC,stroke:#CC6600,stroke-width:1px
    classDef external fill:#E6FFE6,stroke:#339933,stroke-width:1px
    classDef topic fill:#F0F0F0,stroke:#999999,stroke-width:1px,stroke-dasharray: 5 5
    classDef file fill:#F5F5F5,stroke:#AAAAAA,stroke-width:1px
    classDef rosmaster fill:#FFF2CC,stroke:#CC9900,stroke-width:2px,stroke-dasharray: 2 2
```
