# zju-fast-lab/ego-planner architecture

> Architecture diagram of the GitHub repository zju-fast-lab/ego-planner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zju-fast-lab/ego-planner
- Repository: https://github.com/zju-fast-lab/ego-planner

## Overview

##### Project type and purpose
- This is a full-stack ROS (Robot Operating System) C++ catkin workspace for quadrotor planning and simulation.
- It provides:
- A gradient-based local planner (EGO-Planner) with submodules for B-spline optimization, path searching, environment modeling, trajectory utilities, and a planning manager node.
- A simulated UAV stack (uav_simulator) including sensor simulation (local_sensing, multi_map_server, mockamap), flight control (so3_control), and quadrotor dynamics simulation (so3_quadrotor_simulator).
- A modified RealSense ROS driver for depth and stereo capture.

##### File structure
- Top-level directories in src/:
- planner/ (bspline_opt, path_searching, plan_env, plan_manage, traj_utils)
- uav_simulator/Utils/ (common utilities, map server, visualization plugins, message definitions, waypoint generator)
- uav_simulator/local_sensing (sensor nodes using CPU/GPU)
- uav_simulator/map_generator (random forest based sensing)
- uav_simulator/mockamap (mock map generator)
- uav_simulator/so3_control (attitude controller nodelet)
- uav_simulator/so3_quadrotor_simulator (dynamics simulation node)
- Configuration & launch files under each package; messages defined in plan_manage/msg and multi_map_server/msg.

##### README for additional insights
- Describes ROS launch sequences: sensor → planner → simulator → rviz.
- States dependencies on Armadillo, librealsense2, CUDA.
- Emphasizes modular design: local_sensing selects depth vs pointcloud, planner manager node orchestrates sub-modules.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Sensor Layer"
        RS["Modified RealSense Driver"]:::sensing
        LS["local_sensing\n(depth_render, pcl_render)"]:::sensing
    end

    subgraph "Map Layer"
        MMS["multi_map_server\n(occupancy map)"]:::mapping
        MA["mockamap\n(map generator)"]:::mapping
        RF["random_forest_sensing"]:::mapping
    end

    subgraph "Planning Layer"
        subgraph "EGO-Planner"
            PM["ego_planner_node\n(Manager FSM)"]:::planning
            BSO["bspline_opt"]:::planning
            PS["path_searching"]:::planning
            PE["plan_env"]:::planning
            TU["traj_utils"]:::planning
        end
    end

    subgraph "Control Layer"
        SC["so3_control\n(nodelet)"]:::control
    end

    subgraph "Simulation Layer"
        SIM["so3_quadrotor_simulator"]:::simulation
    end

    subgraph "Visualization"
        RV["rviz_plugins"]:::visualization
    end

    subgraph "Utilities"
        UU["uav_utils"]:::utilities
        QM["quadrotor_msgs"]:::utilities
        WG["waypoint_generator"]:::utilities
        OV["odom_visualization"]:::utilities
        PU["pose_utils"]:::utilities
    end

    RS -->|"Image/Depth topics"| LS
    LS -->|"/pointcloud, /depth"| MMS
    LS -->|"/pointcloud, /depth"| MA
    LS -->|"/depth"| RF
    MMS -->|"/map"| PM
    MA -->|"/map"| PM
    RF -->|"/map"| PM
    SIM -->|"/odom"| PM
    PM -->|"/trajectory"| SC
    SC -->|"/cmd"| SIM
    SIM -->|"/odom"| OV
    SIM -->|"/odom"| PU
    PM -->|"/trajectory"| RV
    MMS -->|"/map"| RV

    click RS "https://github.com/zju-fast-lab/ego-planner/blob/master/modified_realsense2_camera.zip"
    click LS "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/local_sensing"
    click MMS "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/multi_map_server"
    click MA "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/mockamap"
    click RF "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/map_generator"
    click PM "https://github.com/zju-fast-lab/ego-planner/blob/master/src/planner/plan_manage/src/ego_planner_node.cpp"
    click BSO "https://github.com/zju-fast-lab/ego-planner/tree/master/src/planner/bspline_opt"
    click PS "https://github.com/zju-fast-lab/ego-planner/tree/master/src/planner/path_searching"
    click PE "https://github.com/zju-fast-lab/ego-planner/tree/master/src/planner/plan_env"
    click TU "https://github.com/zju-fast-lab/ego-planner/tree/master/src/planner/traj_utils"
    click SC "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/so3_control"
    click SIM "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/so3_quadrotor_simulator"
    click RV "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/rviz_plugins"
    click UU "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/uav_utils"
    click QM "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/quadrotor_msgs"
    click WG "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/waypoint_generator"
    click OV "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/odom_visualization"
    click PU "https://github.com/zju-fast-lab/ego-planner/tree/master/src/uav_simulator/Utils/pose_utils"

    classDef sensing fill:#ADD8E6,stroke:#000,stroke-width:1px;
    classDef mapping fill:#90EE90,stroke:#000,stroke-width:1px;
    classDef planning fill:#FFA500,stroke:#000,stroke-width:1px;
    classDef control fill:#FF4500,stroke:#000,stroke-width:1px;
    classDef simulation fill:#9370DB,stroke:#000,stroke-width:1px;
    classDef visualization fill:#D3D3D3,stroke:#000,stroke-width:1px;
    classDef utilities fill:#CCCCCC,stroke:#000,stroke-width:1px;
```
