# ivanwong9290/cmu_16833_slam architecture

> Architecture diagram of the GitHub repository ivanwong9290/cmu_16833_slam, 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/ivanwong9290/cmu_16833_slam
- Repository: https://github.com/ivanwong9290/cmu_16833_slam

## Overview

This repository is a collection of four SLAM coursework implementations, not one integrated application. Its principal workflows estimate robot pose and maps from motion and sensor data: particle-filter localization, EKF SLAM, linear/nonlinear graph-based SLAM, and dense RGB-D mapping with ICP and point-based fusion. The graph preserves these as separate product branches. Source evidence is uneven: EKF and some solver or particle-filter internals were not excerpted, so uncertain connections are omitted or marked unverified rather than inferred as certain.

Main entry points: [`icp_fusion/main.py`](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/main.py) (RGB-D mapping runner), [`particle_filter/code/main.py`](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/main.py) (Localization runner), [`icp_fusion/preprocess.py`](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/preprocess.py) (Pose and normal preprocessing), [`icp_fusion/transforms.py`](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/transforms.py) (Camera transforms)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_pf["Particle Filter"]
  node_pf_main["Localization runner<br/>[main.py]"]
  node_pf_map["Occupancy map<br/>[map_reader.py]"]
  node_pf_motion["Motion model<br/>[motion_model.py]"]
  node_pf_sensor["Laser sensor model<br/>[sensor_model.py]"]
  node_pf_resample["Particle resampling<br/>[resampling.py]"]
end

subgraph group_ekf["EKF SLAM"]
  node_ekf["EKF SLAM<br/>[ekf_slam.py]"]
end

subgraph group_solvers["SLAM Solvers"]
  node_linear["Linear SLAM<br/>[linear.py]"]
  node_nonlinear["Nonlinear SLAM<br/>[nonlinear.py]"]
  node_solver_methods["Sparse solver methods<br/>[solvers.py]"]
  node_solver_utils["State and plotting utilities<br/>[utils.py]"]
end

subgraph group_dense["Dense Mapping"]
  node_rgbd_runner["RGB-D mapping runner<br/>[main.py]"]
  node_pose_preprocess["Pose and normal preprocessing<br/>[preprocess.py]"]
  node_transforms["Camera transforms<br/>[transforms.py]"]
  node_icp["ICP alignment<br/>[icp.py]"]
  node_fusion[("Point-based fusion<br/>[fusion.py]")]
  node_o3d["Point-cloud utilities<br/>[o3d_utility.py]"]
end

node_pf_main -->|"scores scans"| node_pf_sensor
node_pf_main -->|"resamples particles"| node_pf_resample
node_pf_main -.->|"uses motion model"| node_pf_motion
node_pf_main -.->|"loads map"| node_pf_map
node_pf_sensor -->|"reads occupancy"| node_pf_map
node_linear -.->|"solves system"| node_solver_methods
node_linear -.->|"uses state utilities"| node_solver_utils
node_nonlinear -->|"selects solver"| node_solver_methods
node_nonlinear -->|"uses state utilities"| node_solver_utils
node_rgbd_runner -->|"loads poses"| node_pose_preprocess
node_rgbd_runner -->|"unprojects depth"| node_transforms
node_rgbd_runner -->|"aligns frames"| node_icp
node_rgbd_runner -->|"fuses frame"| node_fusion
node_rgbd_runner -->|"builds visualization"| node_o3d
node_pose_preprocess -->|"unprojects depth"| node_transforms
node_pose_preprocess -->|"estimates normals"| node_o3d
node_fusion -->|"projects points"| node_transforms
node_icp -->|"visualizes matches"| node_o3d

click node_pf_main "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/main.py"
click node_pf_map "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/map_reader.py"
click node_pf_motion "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/motion_model.py"
click node_pf_sensor "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/sensor_model.py"
click node_pf_resample "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/resampling.py"
click node_ekf "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/ekf_slam/code/ekf_slam.py"
click node_linear "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/linear.py"
click node_nonlinear "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/nonlinear.py"
click node_solver_methods "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/solvers.py"
click node_solver_utils "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/utils.py"
click node_rgbd_runner "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/main.py"
click node_pose_preprocess "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/preprocess.py"
click node_transforms "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/transforms.py"
click node_icp "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/icp.py"
click node_fusion "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/fusion.py"
click node_o3d "https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/o3d_utility.py"

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_pf_main,node_pf_map,node_pf_motion,node_pf_sensor,node_pf_resample toneBlue
class node_ekf toneAmber
class node_linear,node_nonlinear,node_solver_methods,node_solver_utils toneMint
class node_rgbd_runner,node_pose_preprocess,node_transforms,node_icp,node_fusion,node_o3d toneRose
```

## Components

### Particle Filter

- [Localization runner](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/main.py): `particle_filter/code/main.py`
- [Occupancy map](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/map_reader.py): `particle_filter/code/map_reader.py`
- [Motion model](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/motion_model.py): `particle_filter/code/motion_model.py`
- [Laser sensor model](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/sensor_model.py): `particle_filter/code/sensor_model.py`
- [Particle resampling](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/particle_filter/code/resampling.py): `particle_filter/code/resampling.py`

### EKF SLAM

- [EKF SLAM](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/ekf_slam/code/ekf_slam.py): `ekf_slam/code/ekf_slam.py`

### SLAM Solvers

- [Linear SLAM](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/linear.py): `slam_solvers/code/linear.py`
- [Nonlinear SLAM](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/nonlinear.py): `slam_solvers/code/nonlinear.py`
- [Sparse solver methods](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/solvers.py): `slam_solvers/code/solvers.py`
- [State and plotting utilities](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/slam_solvers/code/utils.py): `slam_solvers/code/utils.py`

### Dense Mapping

- [RGB-D mapping runner](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/main.py): `icp_fusion/main.py`
- [Pose and normal preprocessing](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/preprocess.py): `icp_fusion/preprocess.py`
- [Camera transforms](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/transforms.py): `icp_fusion/transforms.py`
- [ICP alignment](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/icp.py): `icp_fusion/icp.py`
- [Point-based fusion](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/fusion.py): `icp_fusion/fusion.py`
- [Point-cloud utilities](https://github.com/ivanwong9290/cmu_16833_slam/blob/main/icp_fusion/o3d_utility.py): `icp_fusion/o3d_utility.py`

## Connections

- Localization runner → Laser sensor model: scores scans (evidence: `particle_filter/code/main.py`)
- Localization runner → Particle resampling: resamples particles (evidence: `particle_filter/code/main.py`)
- Localization runner → Motion model: uses motion model (evidence: `particle_filter/code/main.py`)
- Localization runner → Occupancy map: loads map (evidence: `particle_filter/code/main.py`)
- Laser sensor model → Occupancy map: reads occupancy (evidence: `particle_filter/code/sensor_model.py`)
- Linear SLAM → Sparse solver methods: solves system (evidence: `slam_solvers/code/linear.py`)
- Linear SLAM → State and plotting utilities: uses state utilities (evidence: `slam_solvers/code/linear.py`)
- Nonlinear SLAM → Sparse solver methods: selects solver (evidence: `slam_solvers/code/nonlinear.py`)
- Nonlinear SLAM → State and plotting utilities: uses state utilities (evidence: `slam_solvers/code/nonlinear.py`)
- RGB-D mapping runner → Pose and normal preprocessing: loads poses (evidence: `icp_fusion/main.py`)
- RGB-D mapping runner → Camera transforms: unprojects depth (evidence: `icp_fusion/main.py`)
- RGB-D mapping runner → ICP alignment: aligns frames (evidence: `icp_fusion/main.py`)
- RGB-D mapping runner → Point-based fusion: fuses frame (evidence: `icp_fusion/main.py`)
- RGB-D mapping runner → Point-cloud utilities: builds visualization (evidence: `icp_fusion/main.py`)
- Pose and normal preprocessing → Camera transforms: unprojects depth (evidence: `icp_fusion/preprocess.py`)
- Pose and normal preprocessing → Point-cloud utilities: estimates normals (evidence: `icp_fusion/preprocess.py`)
- Point-based fusion → Camera transforms: projects points (evidence: `icp_fusion/fusion.py`)
- ICP alignment → Point-cloud utilities: visualizes matches (evidence: `icp_fusion/icp.py`)
