# kcsumesh25/cloud_masking architecture

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

- Interactive diagram: https://gitdiagram.com/kcsumesh25/cloud_masking
- Repository: https://github.com/kcsumesh25/cloud_masking

## Overview

This repository is a small tutorial collection for OmniCloudMask, not the library implementation: it contains three notebooks and a README. The documented product workflow is to prepare imagery with Red, Green, and NIR bands, run cloud and shadow inference, and obtain a four-class segmentation mask, optionally with confidence output. Notebook names identify Sentinel-2, WorldView, and DEA Sentinel-2 examples, but their contents were not available, so their internal steps and calls cannot be verified. Product capabilities below are documented in the README; implementation links are omitted where evidence is absent.

Main entry points: [`01_s2_cloud_shadows_masking.ipynb`](https://github.com/kcsumesh25/cloud_masking/blob/main/01_s2_cloud_shadows_masking.ipynb) (Sentinel-2 example), [`02_wv_cloud_shadows_masking.ipynb`](https://github.com/kcsumesh25/cloud_masking/blob/main/02_wv_cloud_shadows_masking.ipynb) (WorldView example), [`03_s2_dea_cloud_shadows_masking.ipynb`](https://github.com/kcsumesh25/cloud_masking/blob/main/03_s2_dea_cloud_shadows_masking.ipynb) (DEA Sentinel-2)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tutorials["Tutorial notebooks"]
  node_s2_example["Sentinel-2 example"]
  node_wv_example["WorldView example"]
  node_dea_example["DEA Sentinel-2"]
end

subgraph group_product["Masking product"]
  node_library["OmniCloudMask"]
  node_segmentation["Four-class mask"]
  node_confidence["Confidence map"]
end

node_analyst(("Imagery analyst"))
node_imagery["Satellite imagery"]
node_inference["Inference hardware"]

node_analyst -.->|"opens example"| node_s2_example
node_analyst -.->|"opens example"| node_wv_example
node_analyst -.->|"opens example"| node_dea_example
node_imagery -.->|"input bands"| node_library
node_library -->|"produces mask"| node_segmentation
node_library -->|"optionally exports"| node_confidence
node_inference -->|"supports execution"| node_library

click node_s2_example "https://github.com/kcsumesh25/cloud_masking/blob/main/01_s2_cloud_shadows_masking.ipynb"
click node_wv_example "https://github.com/kcsumesh25/cloud_masking/blob/main/02_wv_cloud_shadows_masking.ipynb"
click node_dea_example "https://github.com/kcsumesh25/cloud_masking/blob/main/03_s2_dea_cloud_shadows_masking.ipynb"

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_s2_example,node_wv_example,node_dea_example toneBlue
class node_library,node_segmentation,node_confidence toneAmber
class node_analyst,node_imagery,node_inference toneIndigo
```

## Components

### Tutorial notebooks

- [Sentinel-2 example](https://github.com/kcsumesh25/cloud_masking/blob/main/01_s2_cloud_shadows_masking.ipynb): `01_s2_cloud_shadows_masking.ipynb`
- [WorldView example](https://github.com/kcsumesh25/cloud_masking/blob/main/02_wv_cloud_shadows_masking.ipynb): `02_wv_cloud_shadows_masking.ipynb`
- [DEA Sentinel-2](https://github.com/kcsumesh25/cloud_masking/blob/main/03_s2_dea_cloud_shadows_masking.ipynb): `03_s2_dea_cloud_shadows_masking.ipynb`

### Masking product

- **OmniCloudMask**
- **Four-class mask**
- **Confidence map**

### Other components

- **Imagery analyst**
- **Satellite imagery**
- **Inference hardware**

## Connections

- Imagery analyst → Sentinel-2 example: opens example
- Imagery analyst → WorldView example: opens example
- Imagery analyst → DEA Sentinel-2: opens example
- Satellite imagery → OmniCloudMask: input bands
- OmniCloudMask → Four-class mask: produces mask (evidence: `README.md`)
- OmniCloudMask → Confidence map: optionally exports (evidence: `README.md`)
- Inference hardware → OmniCloudMask: supports execution (evidence: `README.md`)
