# wuyi2121/scan-planner architecture

> Architecture diagram of the GitHub repository wuyi2121/scan-planner, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wuyi2121/scan-planner
- Repository: https://github.com/wuyi2121/scan-planner

## Overview

SCAN-Planner is a ROS local planner for route-guided quadruped navigation. A user selects a navigation mode and sensing source; the planning node manages replanning, produces a collision-aware trajectory, and a controller executes it. The repository also includes grid mapping, local path search, simulator sensing and map generation, visualization, and robot-motion simulation. The principal planning links are partly inferred from module roles: several implementation files were not excerpted, so those relationships are shown as unverified rather than asserted as source-proven calls.

Main entry points: [`src/planner/plan_manage/src/planner_manager.cpp`](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/planner_manager.cpp) (Planner Manager), [`src/planner/plan_env/src/grid_map.cpp`](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_env/src/grid_map.cpp) (Grid Map), [`src/simulator/local_sensing/src/pointcloud_render_node.cpp`](https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/src/pointcloud_render_node.cpp) (Local Sensing), [`src/planner/bspline_opt/src/bspline_optimizer.cpp`](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/bspline_optimizer.cpp) (B-spline Optimizer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_planning["Planning"]
  node_scan_node["Planning Node"]
  node_replan_fsm["Replanning FSM"]
  node_planner_manager["Planner Manager"]
  node_astar["Dynamic A*<br/>[dyn_a_star.cpp]"]
  node_bspline_opt["B-spline Optimizer"]
  node_gradient_opt["Gradient Optimizer"]
  node_uniform_bspline["Uniform B-splines"]
end

subgraph group_mapping["Mapping"]
  node_grid_map[("Grid Map<br/>[grid_map.cpp]")]
  node_raycast["Raycasting<br/>[raycast.cpp]"]
end

subgraph group_execution["Execution"]
  node_closed_controller["Closed-loop Control"]
  node_open_controller["Open-loop Simulation"]
  node_visualization["Planning Visualization"]
  node_trajectory_utils["Trajectory Utilities"]
end

subgraph group_simulation["Simulation"]
  node_local_sensing["Local Sensing"]
  node_fov_checker["Field-of-view Checker<br/>[FOV_Checker.cpp]"]
  node_map_generator["Map Generator<br/>[maps.cpp]"]
  node_waypoint_generator["Waypoint Generator"]
  node_go2_sim["Go2 Kinematic Sim"]
  node_ikd_tree[("Incremental KD-tree<br/>[ikd_Tree.cpp]")]
end

subgraph group_math["Math Support"]
  node_glm["GLM Math"]
end

node_operator(("Navigation User"))
node_sensor(("Robot Sensors"))

node_operator -->|"selects mode"| node_scan_node
node_sensor -.->|"supplies observations"| node_grid_map
node_scan_node -.->|"starts replanning"| node_replan_fsm
node_replan_fsm -.->|"requests plans"| node_planner_manager
node_planner_manager -.->|"searches path"| node_astar
node_planner_manager -.->|"optimizes trajectory"| node_bspline_opt
node_bspline_opt -->|"uses optimizer"| node_gradient_opt
node_bspline_opt -->|"checks occupancy"| node_grid_map
node_planner_manager -.->|"generates trajectory"| node_uniform_bspline
node_grid_map -->|"updates occupancy"| node_raycast
node_planner_manager -.->|"publishes trajectory"| node_closed_controller
node_planner_manager -.->|"publishes trajectory"| node_open_controller
node_closed_controller -->|"evaluates trajectory"| node_uniform_bspline
node_open_controller -->|"evaluates trajectory"| node_uniform_bspline
node_planner_manager -.->|"visualizes plans"| node_visualization
node_planner_manager -.->|"uses trajectory types"| node_trajectory_utils
node_local_sensing -->|"checks field of view"| node_fov_checker
node_local_sensing -.->|"uses spatial index"| node_ikd_tree
node_map_generator -.->|"supplies simulated maps"| node_grid_map
node_waypoint_generator -.->|"provides waypoints"| node_operator
node_go2_sim -.->|"simulates motion"| node_open_controller
node_local_sensing -.->|"uses math types"| node_glm

click node_scan_node "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/scan_planner_node.cpp"
click node_replan_fsm "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/scan_replan_fsm.cpp"
click node_planner_manager "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/planner_manager.cpp"
click node_astar "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/path_searching/src/dyn_a_star.cpp"
click node_bspline_opt "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/bspline_optimizer.cpp"
click node_gradient_opt "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/gradient_descent_optimizer.cpp"
click node_uniform_bspline "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/uniform_bspline.cpp"
click node_grid_map "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_env/src/grid_map.cpp"
click node_raycast "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_env/src/raycast.cpp"
click node_closed_controller "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/closed_loop_controller.cpp"
click node_open_controller "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/open_loop_controller.cpp"
click node_visualization "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/traj_utils/src/planning_visualization.cpp"
click node_trajectory_utils "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/traj_utils/src/polynomial_traj.cpp"
click node_local_sensing "https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/src/pointcloud_render_node.cpp"
click node_fov_checker "https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/include/FOV_Checker/FOV_Checker.cpp"
click node_map_generator "https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/mockamap/src/maps.cpp"
click node_waypoint_generator "https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/Utils/waypoint_generator/src/waypoint_generator.cpp"
click node_go2_sim "https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/go2_kinematic_sim.cpp"
click node_ikd_tree "https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/include/ikd-Tree/ikd_Tree.cpp"
click node_glm "https://github.com/wuyi2121/scan-planner/tree/main/src/simulator/local_sensing/include/glm"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_scan_node,node_replan_fsm,node_planner_manager,node_astar,node_bspline_opt,node_gradient_opt,node_uniform_bspline,node_operator toneBlue
class node_grid_map,node_raycast toneAmber
class node_closed_controller,node_open_controller,node_visualization,node_trajectory_utils toneMint
class node_local_sensing,node_fov_checker,node_map_generator,node_waypoint_generator,node_go2_sim,node_ikd_tree toneRose
class node_glm,node_sensor toneIndigo
```

## Components

### Planning

- [Planning Node](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/scan_planner_node.cpp): `src/planner/plan_manage/src/scan_planner_node.cpp`
- [Replanning FSM](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/scan_replan_fsm.cpp): `src/planner/plan_manage/src/scan_replan_fsm.cpp`
- [Planner Manager](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/planner_manager.cpp): `src/planner/plan_manage/src/planner_manager.cpp`
- [Dynamic A*](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/path_searching/src/dyn_a_star.cpp): `src/planner/path_searching/src/dyn_a_star.cpp`
- [B-spline Optimizer](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/bspline_optimizer.cpp): `src/planner/bspline_opt/src/bspline_optimizer.cpp`
- [Gradient Optimizer](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/gradient_descent_optimizer.cpp): `src/planner/bspline_opt/src/gradient_descent_optimizer.cpp`
- [Uniform B-splines](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/bspline_opt/src/uniform_bspline.cpp): `src/planner/bspline_opt/src/uniform_bspline.cpp`

### Mapping

- [Grid Map](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_env/src/grid_map.cpp): `src/planner/plan_env/src/grid_map.cpp`
- [Raycasting](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_env/src/raycast.cpp): `src/planner/plan_env/src/raycast.cpp`

### Execution

- [Closed-loop Control](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/closed_loop_controller.cpp): `src/planner/plan_manage/src/closed_loop_controller.cpp`
- [Open-loop Simulation](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/open_loop_controller.cpp): `src/planner/plan_manage/src/open_loop_controller.cpp`
- [Planning Visualization](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/traj_utils/src/planning_visualization.cpp): `src/planner/traj_utils/src/planning_visualization.cpp`
- [Trajectory Utilities](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/traj_utils/src/polynomial_traj.cpp): `src/planner/traj_utils/src/polynomial_traj.cpp`

### Simulation

- [Local Sensing](https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/src/pointcloud_render_node.cpp): `src/simulator/local_sensing/src/pointcloud_render_node.cpp`
- [Field-of-view Checker](https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/include/FOV_Checker/FOV_Checker.cpp): `src/simulator/local_sensing/include/FOV_Checker/FOV_Checker.cpp`
- [Map Generator](https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/mockamap/src/maps.cpp): `src/simulator/mockamap/src/maps.cpp`
- [Waypoint Generator](https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/Utils/waypoint_generator/src/waypoint_generator.cpp): `src/simulator/Utils/waypoint_generator/src/waypoint_generator.cpp`
- [Go2 Kinematic Sim](https://github.com/wuyi2121/scan-planner/blob/main/src/planner/plan_manage/src/go2_kinematic_sim.cpp): `src/planner/plan_manage/src/go2_kinematic_sim.cpp`
- [Incremental KD-tree](https://github.com/wuyi2121/scan-planner/blob/main/src/simulator/local_sensing/include/ikd-Tree/ikd_Tree.cpp): `src/simulator/local_sensing/include/ikd-Tree/ikd_Tree.cpp`

### Math Support

- [GLM Math](https://github.com/wuyi2121/scan-planner/tree/main/src/simulator/local_sensing/include/glm): `src/simulator/local_sensing/include/glm`

### Other components

- **Navigation User**
- **Robot Sensors**

## Connections

- Navigation User → Planning Node: selects mode
- Robot Sensors → Grid Map: supplies observations
- Planning Node → Replanning FSM: starts replanning
- Replanning FSM → Planner Manager: requests plans
- Planner Manager → Dynamic A*: searches path
- Planner Manager → B-spline Optimizer: optimizes trajectory
- B-spline Optimizer → Gradient Optimizer: uses optimizer (evidence: `src/planner/bspline_opt/src/bspline_optimizer.cpp`)
- B-spline Optimizer → Grid Map: checks occupancy (evidence: `src/planner/bspline_opt/src/bspline_optimizer.cpp`)
- Planner Manager → Uniform B-splines: generates trajectory
- Grid Map → Raycasting: updates occupancy (evidence: `src/planner/plan_env/src/grid_map.cpp`)
- Planner Manager → Closed-loop Control: publishes trajectory
- Planner Manager → Open-loop Simulation: publishes trajectory
- Closed-loop Control → Uniform B-splines: evaluates trajectory (evidence: `src/planner/plan_manage/src/closed_loop_controller.cpp`)
- Open-loop Simulation → Uniform B-splines: evaluates trajectory (evidence: `src/planner/plan_manage/src/open_loop_controller.cpp`)
- Planner Manager → Planning Visualization: visualizes plans
- Planner Manager → Trajectory Utilities: uses trajectory types
- Local Sensing → Field-of-view Checker: checks field of view (evidence: `src/simulator/local_sensing/src/pointcloud_render_node.cpp`)
- Local Sensing → Incremental KD-tree: uses spatial index
- Map Generator → Grid Map: supplies simulated maps
- Waypoint Generator → Navigation User: provides waypoints
- Go2 Kinematic Sim → Open-loop Simulation: simulates motion
- Local Sensing → GLM Math: uses math types
