# itsakasht/sim_denoising architecture

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

- Interactive diagram: https://gitdiagram.com/itsakasht/sim_denoising
- Repository: https://github.com/itsakasht/sim_denoising

## Overview

##### Project type and purpose
- This is a scientific image-processing pipeline written in Python, focused on simulating Structured Illumination Microscopy (SIM), injecting noise, applying filters, reconstructing images, and evaluating filter performance.
- There is no client/server or UI. It’s a batch/offline data pipeline orchestrated via Python scripts and Jupyter notebooks.

##### File structure
- Top-level Python modules: noise.py, optics.py, denoising.ipynb, denoising_parts.ipynb, filter_evaluation.ipynb, frc_visualization.ipynb, color_bar.ipynb, visualization.ipynb.
- Supporting pipeline scripts (implied by README): denoising.py, denoising_parts.py, filter_evaluation.py, frc_visualization.py, color_bar.py (not present as .py, but code is in notebooks).
- Data directories:
- source_images (ground-truth TIFFs)
- output_images (subfolders by noise type & intensity, CSV filter results, final TIFFs)
- No network/config files, no database—pure file-based workflow.

##### Key architecture notes from README
- Modules:
- noise: adds Gaussian, Poisson, salt-pepper, mixed noise.
- optics: generates structured illumination, applies OTF, normalization, spatial/frequency display.
- denoising/denoising_parts: pipelines that apply illumination, add noise, apply filters, reconstruct SIM images. denoising_parts breaks data into patches for parameter tuning then stitches back.
- filter_evaluation: compares outputs from different filters, generates plots.
- frc_visualization: Fourier Ring Correlation analysis.
- color_bar: histogram/range visualizations.

##### Main components
a. Data sources
- “Ground Truth Images” (source_images folder)
b. Core processing modules
- Illumination Generator (optics module)
- Noise Adder (noise module)
- OTF Applier (optics)
- Filter Executor (denoising and denoising_parts)
- SIM Reconstructor (could be part of denoising scripts)
c. Evaluation & Visualization
- Filter Evaluation (filter_evaluation)
- Fourier Ring Correlation (frc_visualization)
d. Data sinks
- output_images folder (TIFFs, CSVs, plots)

##### Relationships and data flow
1) Start: Ground Truth Images → Illumination Generator
2) → produce 9 phase‐angle images → pass to Noise Adder
3) → noisy images → pass to OTF Applier → noisy+OTF images
4) → pass to Filter Executor
- denoising.py applies global filters
- denoising_parts.py applies patch‐wise filters + stitching
5) → output: reconstructed SIM images (noise vs. noise-free)
6) → pass outputs to Evaluation modules
- filter_evaluation compares metrics, plots PSNR, SSIM
- frc_visualization computes FRC curves
- color_bar generates histograms/range bars
7) → all results written to output_images/<noise_type>/<intensity>/

##### Architectural patterns and design principles
- Modular, single-responsibility modules: noise vs. optics vs. evaluation.
- Pipeline orchestration: Jupyter notebooks (denoising.ipynb, etc.) act as high-level workflows.
- File-based I/O: no in-memory service bus.
- Patch-wise vs. global processing (denoising_parts vs. denoising) as two interchangeable strategies.

##### Technologies and frameworks
- Python (core modules)
- Jupyter notebooks (workflows & visualization)
- NumPy/SciPy for arrays, FFTs
- Matplotlib/Seaborn for plots
- TIFF I/O (via pillow or tifffile)
- CSV generation for metrics

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Sources
    DS1(["Ground Truth Images\n(source_images/)"]):::datastore
    click DS1 "https://github.com/itsakasht/sim_denoising/tree/main/source_images/"

    %% Simulation Stage
    subgraph "Simulation"
        Illum(["Illumination Generator"]):::processing
        click Illum "https://github.com/itsakasht/sim_denoising/blob/main/optics.py"

        Noise(["Noise Adder"]):::processing
        click Noise "https://github.com/itsakasht/sim_denoising/blob/main/noise.py"

        OTFPlot(["OTF Applier & Visualization"]):::processing
        click OTFPlot "https://github.com/itsakasht/sim_denoising/blob/main/otf_plot.py"
    end

    %% Filtering Stage
    subgraph "Filtering"
        Global(["Global Filtering & SIM Reconstruction\n(denoising.ipynb)"]):::notebook
        click Global "https://github.com/itsakasht/sim_denoising/blob/main/denoising.ipynb"

        Patch(["Patch-wise Filtering & Stitching\n(denoising_parts.ipynb)"]):::notebook
        click Patch "https://github.com/itsakasht/sim_denoising/blob/main/denoising_parts.ipynb"
    end

    %% Evaluation & Visualization Stage
    subgraph "Evaluation & Visualization"
        FEval(["Filter Evaluation\n(filter_evaluation.ipynb)"]):::notebook
        click FEval "https://github.com/itsakasht/sim_denoising/blob/main/filter_evaluation.ipynb"

        FRC(["Fourier Ring Correlation\n(frc_visualization.ipynb)"]):::notebook
        click FRC "https://github.com/itsakasht/sim_denoising/blob/main/frc_visualization.ipynb"

        CBar(["Color Bar & Range Visuals\n(color_bar.ipynb)"]):::notebook
        click CBar "https://github.com/itsakasht/sim_denoising/blob/main/color_bar.ipynb"

        Viz(["General Visualization\n(visualization.ipynb)"]):::notebook
        click Viz "https://github.com/itsakasht/sim_denoising/blob/main/visualization.ipynb"
    end

    %% Data Sink
    DS2(["Simulation & Output Data Store\n(output_images/)"]):::datastore
    click DS2 "https://github.com/itsakasht/sim_denoising/tree/main/output_images/"

    %% Flow Connections
    DS1 -->|"TIFF images"| Illum
    Illum -->|"phase-angle images"| Noise
    Noise -->|"noisy images"| OTFPlot
    OTFPlot -->|"noisy+OTF images"| Global
    OTFPlot -->|"noisy+OTF images"| Patch

    Global -->|"reconstructed SIM TIFFs"| DS2
    Patch -->|"reconstructed SIM TIFFs"| DS2

    DS2 -->|"SIM images"| FEval
    FEval -->|"metrics CSVs & plots"| DS2

    DS2 -->|"SIM images"| FRC
    FRC -->|"FRC plots"| DS2

    DS2 -->|"SIM images"| CBar
    CBar -->|"histograms/range bars"| DS2

    DS2 -->|"data"| Viz
    Viz -->|"misc plots"| DS2

    %% Styles
    classDef datastore fill:#BBDEFB,stroke:#0D47A1,color:#0D47A1
    classDef processing fill:#C8E6C9,stroke:#1B5E20,color:#1B5E20
    classDef notebook fill:#E1BEE7,stroke:#4A148C,color:#4A148C
    classDef evaluation fill:#FFE0B2,stroke:#E65100,color:#E65100
```
