# aevainc/doppler-icp architecture

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

- Interactive diagram: https://gitdiagram.com/aevainc/doppler-icp
- Repository: https://github.com/aevainc/doppler-icp

## Overview

##### Project type and purpose
- This is an open-source algorithmic tool (DICP: Doppler Iterative Closest Point) written in Python, built atop a custom fork of the Open3D library.

##### File structure
- Top-level:
- Open3D/        ← forked C++/Python library (submodule)
- dataset/       ← input point-cloud sequences + calibration + reference poses
- scripts/       ← Python entry points and modules
- images/        ← illustrations for README/poster
- requirements.txt, README.md, .gitmodules, etc.
- scripts/:
- run.py        ← CLI for running ICP (Doppler or point-to-plane)
- registration.py ← core Doppler-ICP and geometry-ICP implementations
- utils.py      ← I/O, file parsing, common routines
- Build/deploy:
- Open3D build (cmake → Python wheel)
- pip install -r requirements.txt
- git lfs pull for large dataset files

##### README for additional insights
- Describes algorithm purpose: joint optimization of Doppler and geometric objectives

##### Detail is key
- Build process of Open3D as a separate “build & install” component if desired
- File-format boundaries (.bin→PointCloud, JSON→calibration, TXT→poses)
- Versioning/branching only if relevant (e.g., git submodule pointer)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Python CLI Layer
    subgraph "Python CLI Layer"
        RunCLI["run.py"]:::python
        VisualCLI["visualize.py"]:::python
    end

    %% Core Algorithm Module
    subgraph "Core Algorithm Module"
        Registration["registration.py"]:::python
        Utils["utils.py"]:::python
    end

    %% Open3D Library
    subgraph "Open3D Library (custom fork)"
        Open3DSub["Open3D/"]:::library
    end

    %% Data Stores
    subgraph "Data Stores"
        Dataset["dataset/"]:::data
        Calibration["calibration.json"]:::data
        PointClouds["*.bin"]:::data
        RefPoses["ref_poses.txt"]:::data
        Outputs["OUTPUT_DIR"]:::data
    end

    %% External Tools and Build
    subgraph "External Tools & Build"
        GitLFS["Git LFS"]:::external
        CMake["CMake Build"]:::external
        Pip["pip install deps"]:::external
        Evo["evo_traj"]:::external
        GitModules[".gitmodules"]:::external
    end

    %% Documentation & Requirements
    subgraph "Project Docs & Requirements"
        Req["requirements.txt"]:::external
        Readme["README.md"]:::external
        Images["images/"]:::external
    end

    %% Relationships
    Dataset -->|provides point-clouds| RunCLI
    Calibration --> RunCLI
    PointClouds --> RunCLI
    RunCLI -->|calls| Utils
    RunCLI -->|calls| Registration
    Utils --> Registration
    Registration -->|uses APIs| Open3DSub
    RunCLI -->|writes results to| Outputs

    Dataset -->|loads data| VisualCLI
    Outputs -->|reads results| VisualCLI
    VisualCLI -->|uses APIs| Open3DSub

    Outputs -->|input| Evo

    GitModules --> Open3DSub
    Open3DSub --> CMake
    CMake -->|builds wheel| Pip
    Pip --> RunCLI
    Pip --> VisualCLI

    %% Click Events
    click RunCLI "https://github.com/aevainc/doppler-icp/blob/main/scripts/run.py"
    click VisualCLI "https://github.com/aevainc/doppler-icp/blob/main/scripts/visualize.py"
    click Registration "https://github.com/aevainc/doppler-icp/blob/main/scripts/registration.py"
    click Utils "https://github.com/aevainc/doppler-icp/blob/main/scripts/utils.py"
    click Open3DSub "https://github.com/aevainc/doppler-icp/tree/main/Open3D/"
    click Dataset "https://github.com/aevainc/doppler-icp/tree/main/dataset/"
    click Calibration "https://github.com/aevainc/doppler-icp/blob/main/dataset/sample/calibration.json"
    click PointClouds "https://github.com/aevainc/doppler-icp/tree/main/dataset/sample/point_clouds/"
    click RefPoses "https://github.com/aevainc/doppler-icp/blob/main/dataset/sample/ref_poses.txt"
    click Req "https://github.com/aevainc/doppler-icp/blob/main/requirements.txt"
    click Readme "https://github.com/aevainc/doppler-icp/blob/main/README.md"
    click GitModules "https://github.com/aevainc/doppler-icp/blob/main/.gitmodules"
    click Images "https://github.com/aevainc/doppler-icp/tree/main/images/"

    %% Styles
    classDef python fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef data fill:#90EE90,stroke:#000,stroke-width:1px
    classDef library fill:#D3D3D3,stroke:#000,stroke-width:1px
    classDef external fill:#FFA500,stroke:#000,stroke-width:1px
```
