# anirudh-swaminathan/3d_euclidean_planning architecture

> Architecture diagram of the GitHub repository anirudh-swaminathan/3d_euclidean_planning, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/anirudh-swaminathan/3d_euclidean_planning
- Repository: https://github.com/anirudh-swaminathan/3d_euclidean_planning

## Overview

##### Project type and purpose
- This is a command-line motion-planning tool (not a web/full-stack app) written in Python for 3D continuous‐space path planning.
- It implements multiple planners (A*, greedy, greedy with collision checking, RRT* via OMPL) on predefined 3D maps with AABB obstacles, producing both visualization images and numeric path‐quality properties.

##### File structure
- Top‐level files:
- requirements.txt, README.md, LICENSE → project metadata & dependencies
- src/ → all source code, inputs, and outputs
- src/ contains:
- main_*.py files – entry points for each algorithm (main_astar.py, main_greedy.py, main_collision.py, main_ompl.py, plus final alias main.py)
- Planner.py – definitions of A*, greedy, and greedy‐collision planners
- OMPLPlanner.py – adapter for OMPL RRT* implementation
- maps/ – input environment definitions
- path_images/ – output images per algorithm/per map
- path_properties/ – numeric output (path lengths, node counts) per algorithm/per map

##### README for additional insights
- Confirms core algorithms and their organization
- Describes how inputs map → planner → outputs images + properties
- Notes external dependency on OMPL (Python bindings) and pyrr for collision checking

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Nodes
    subgraph "CLI Entry Points"
        direction TB
        CLI_main["main.py"]:::internal
        CLI_astar["main_astar.py"]:::internal
        CLI_greedy["main_greedy.py"]:::internal
        CLI_collision["main_collision.py"]:::internal
        CLI_ompl["main_ompl.py"]:::internal
        CLI_original["main_original.py"]:::internal
    end

    subgraph "Input Module"
        direction TB
        Maps["Maps Directory"]:::storage
    end

    subgraph "Planner Core"
        direction TB
        AStar["AStarPlanner"]:::internal
        Greedy["GreedyPlanner"]:::internal
        GreedyNoCollide["GreedyNoCollidePlanner"]:::internal
        CollisionChecker["Collision Checker"]:::internal
    end

    OMPLAdapter["RRTStarPlanner (OMPLPlanner.py)"]:::internal

    subgraph "Output Modules"
        direction TB
        ImageRenderer["Image Renderer"]:::internal
        MetricsWriter["Metrics Writer"]:::internal
    end

    subgraph "File System Storage"
        direction TB
        PathImages["path_images/"]:::storage
        PathProps["path_properties/"]:::storage
    end

    subgraph "External Libraries"
        direction TB
        OMPL["OMPL"]:::external
        Pyrr["pyrr"]:::external
        NumPy["numpy"]:::external
        Matplotlib["matplotlib/PIL"]:::external
    end

    %% Connections
    CLI_main -->|select algorithm| InputParser[/"Environment Parser"/]:::internal
    CLI_astar --> InputParser
    CLI_greedy --> InputParser
    CLI_collision --> InputParser
    CLI_ompl --> InputParser
    CLI_original --> InputParser

    Maps -->|load maps| InputParser
    InputParser -->|obstacles,start,end| AStar
    InputParser --> Greedy
    InputParser --> GreedyNoCollide
    InputParser --> OMPLAdapter

    AStar -->|path| ImageRenderer
    AStar --> MetricsWriter

    Greedy --> ImageRenderer
    Greedy --> MetricsWriter

    GreedyNoCollide --> CollisionChecker
    CollisionChecker -->|collision check| GreedyNoCollide
    GreedyNoCollide --> ImageRenderer
    GreedyNoCollide --> MetricsWriter

    OMPLAdapter --> OMPL
    OMPLAdapter --> ImageRenderer
    OMPLAdapter --> MetricsWriter

    ImageRenderer --> PathImages
    MetricsWriter --> PathProps

    %% External libs usage
    AStar --> NumPy
    Greedy --> NumPy
    GreedyNoCollide --> NumPy
    CollisionChecker --> Pyrr
    OMPLAdapter --> NumPy
    ImageRenderer --> Matplotlib

    %% Click events
    click CLI_main "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/main.py"
    click CLI_astar "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/main_astar.py"
    click CLI_greedy "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/main_greedy.py"
    click CLI_collision "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/main_collision.py"
    click CLI_ompl "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/main_ompl.py"
    click CLI_original "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/main_original.py"
    click Maps "https://github.com/anirudh-swaminathan/3d_euclidean_planning/tree/master/src/maps"
    click AStar "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/Planner.py"
    click Greedy "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/Planner.py"
    click GreedyNoCollide "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/Planner.py"
    click CollisionChecker "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/Planner.py"
    click OMPLAdapter "https://github.com/anirudh-swaminathan/3d_euclidean_planning/blob/master/src/OMPLPlanner.py"
    click PathImages "https://github.com/anirudh-swaminathan/3d_euclidean_planning/tree/master/src/path_images"
    click PathProps "https://github.com/anirudh-swaminathan/3d_euclidean_planning/tree/master/src/path_properties"

    %% Styles
    classDef internal fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef storage fill:#E6FFEA,stroke:#2C662D,color:#2C662D,stroke-width:2px,shape:cylinder;
    classDef external fill:#FFEFD5,stroke:#CC5500,color:#CC5500;
```
