# bu-cisl/sv-fouriernet architecture

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

- Interactive diagram: https://gitdiagram.com/bu-cisl/sv-fouriernet
- Repository: https://github.com/bu-cisl/sv-fouriernet

## Overview

##### Project type and purpose
- SV-FourierNet is a research-focused, Python-based deep-learning application for computational microscopy.
- It implements a Fourier Neural Network to reconstruct wide-field, high-resolution images from multi-aperture miniature microscope measurements.
- Key use cases: training on physics-based simulated data, running inference (reconstruction) on test captures, and visualizing results.

##### File structure
- Root files:
- README.md – project description, dependencies, usage
- dataset.py – data loader / physics-based simulator interface
- model.py – SV-FourierNet architecture definition
- train.py – training loop, loss, optimizer, checkpointing, TensorBoardX logging
- test.py – inference script, loads model + pre-trained weights, runs reconstruction on test images
- utils.py – helper routines (e.g., metrics, image I/O, pre-/post-processing)
- Directories:
- test/ – sample measurement input (meas.tif) and possibly other test data

##### README for additional insights
- Architecture: novel multi-channel Fourier neural network with learned global receptive field
- Workflow:
a. Physics simulator generates training pairs
b. train.py trains model.py, logs via TensorBoardX
c. test.py loads pretrained weights, processes test/meas.tif, produces reconstructions
- Dependencies: Python 3.10, PyTorch 2.0, TensorBoardX, numpy, scikit-image, tifffile, pandas, pytorch_msssim
- External asset: Google Drive link for downloading pretrained weights

##### Main components and interactions
a. Data Preparation / Simulator
- Block: “Physics-based Simulator / dataset.py”
- Outputs synthetic measurement–ground-truth pairs
b. Training Pipeline
- Block: “train.py”
- Consumes simulator output, invokes model.py, computes losses, writes checkpoints & logs
- Connects to TensorBoardX for logging
- Saves weights (e.g., .pt) to root directory
c. Model Definition
- Block: “SV-FourierNet (model.py)”
- Shows internal modules (e.g., Fourier layers, global receptive field) if desired
d. Utilities
- Block: “utils.py”
- Shared services: data augmentation, PSNR/SSIM metrics, file I/O
e. Inference Pipeline
- Block: “test.py”
- Loads pretrained weights, reads test/meas.tif, runs forward pass, writes reconstructed images
f. External Storage & Visualization
- Block: “Google Drive (pretrained weights)”
- Block: “images/” for static assets and output snapshots
- Block: “TensorBoardX” for visualizing training curves

##### Architectural patterns and design principles
- Modular separation: data loader, model, training script, inference script, utilities
- Single-entry point scripts (train.py, test.py) controlling workflows
- Checkpointing and experiment tracking (TensorBoardX) for reproducibility
- Loose coupling via standard file formats (TIFF, PyTorch .pt, numpy arrays)

##### Detailed element checklist
- Module blocks: dataset.py, model.py, utils.py
- Workflow blocks: train.py, test.py
- Storage blocks: checkpoint files, test/meas.tif, images/ outputs
- External service blocks: TensorBoardX, Google Drive
- Simulator output → Training script
- Training script ↔ Model definition
- Training script → Checkpoint storage
- Inference script → Checkpoint loading
- Inference script → Output images
- Annotations for technologies: Python 3.10, PyTorch 2.0, numpy, etc.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Code Modules"
        dataset["dataset.py"]:::code
        model["model.py"]:::code
        utils["utils.py"]:::code
    end
    subgraph "Workflow Scripts"
        train["train.py"]:::script
        test["test.py"]:::script
    end
    checkpoints[(Checkpoints)]:::storage
    testdata[(meas.tif)]:::storage
    images[(Images/)]:::storage
    tensorboard["TensorBoardX"]:::external
    gdrive["Google Drive"]:::external
    readme["README.md"]:::doc

    dataset -->|"generates data"| train
    train -->|"uses model"| model
    train -->|"uses utils"| utils
    train -->|"logs to"| tensorboard
    train -->|"saves weights to"| checkpoints

    test -->|"loads weights from"| checkpoints
    test -->|"reads input"| testdata
    test -->|"uses model"| model
    test -->|"uses utils"| utils
    test -->|"writes output to"| images

    readme -.-> dataset
    readme -.-> model
    readme -.-> utils
    readme -.-> train
    readme -.-> test

    click dataset "https://github.com/bu-cisl/sv-fouriernet/blob/main/dataset.py"
    click model "https://github.com/bu-cisl/sv-fouriernet/blob/main/model.py"
    click utils "https://github.com/bu-cisl/sv-fouriernet/blob/main/utils.py"
    click train "https://github.com/bu-cisl/sv-fouriernet/blob/main/train.py"
    click test "https://github.com/bu-cisl/sv-fouriernet/blob/main/test.py"
    click images "https://github.com/bu-cisl/sv-fouriernet/tree/main/images/"
    click testdata "https://github.com/bu-cisl/sv-fouriernet/blob/main/test/meas.tif"
    click readme "https://github.com/bu-cisl/sv-fouriernet/blob/main/README.md"

    classDef code fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef script fill:#DFFFE0,stroke:#228B22,color:#228B22
    classDef storage fill:#FFF4C1,stroke:#DAA520,color:#DAA520
    classDef external fill:#FFE8D6,stroke:#FF8C00,color:#FF8C00
    classDef doc fill:#F0F0F0,stroke:#A9A9A9,color:#333
```
