# amiruthavallii/fetal-diffusion-mri architecture

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

- Interactive diagram: https://gitdiagram.com/amiruthavallii/fetal-diffusion-mri
- Repository: https://github.com/amiruthavallii/fetal-diffusion-mri

## Overview

##### Project Type and Purpose
- This is an analysis pipeline (not a full‐stack web app) composed of BASH wrappers and Python/Jupyter modules.
- Purpose: Preprocess fetal T2/DWI images, extract ROI features, compute summary statistics, and run regression/z‐score analyses.

##### File Structure and Workflow
- batch_transform_all.sh: Aligns DWI → T2 (pre‐processing step 1)
- batch_mask.sh: Strips non‐brain areas from T2 (pre‐processing step 2)
- Jupyter notebooks (Extract_regions, Calculate_average_values, Polynomial_ridge_regression(.ipynb), VM_zscore(.ipynb)): Python processing modules
- Supporting notebooks (e.g., Polynomial_regression.ipynb) for exploratory or modified workflows
- No external server or database—inputs and outputs are file‐based

##### Architecture Components
a. Data Inputs
- Raw T2‐weighted (T2w) and Diffusion‐Weighted (DWI) MRI scans (file storage or DICOM/NIfTI folder)
b. Preprocessing Modules
- batch_transform_all.sh (BASH)
- batch_mask.sh (BASH)
c. Feature Extraction Module
- Extract_regions.ipynb (Python + NiBabel/numpy)
d. Statistical & Modeling Modules
- Calculate_average_values.ipynb (pandas, openpyxl)
- Polynomial_ridge_regression.ipynb (scikit-learn)
- VM_zscore.ipynb (scipy/numpy)
e. Outputs
- Aligned/masked image files (NIfTI)
- Excel spreadsheets of mean intensities
- Regression model results (plots, metrics)
- Z‐score reports

##### Relationships and Data Flow
- Raw Data → (batch_transform_all.sh) → Aligned DWI→ (batch_mask.sh) → Masked T2/DWI
- Masked images → (Extract_regions.ipynb) → ROI feature files (CSV/NumPy arrays)
- ROI features → (Calculate_average_values.ipynb) → Summary statistics (Excel)
- Summary stats → (Polynomial_ridge_regression.ipynb) → Model outputs
- Subject group stats → (VM_zscore.ipynb) → Z‐score tables/plots

##### Important Patterns and Technologies
- Modular pipeline with sequential stages
- BASH orchestration calling Python notebooks/scripts
- File‐based I/O rather than networked services
- Use of standard scientific Python stack (NiBabel, NumPy, pandas, scikit-learn)

##### Detail
- File formats at each handoff (e.g., NIfTI → CSV → XLSX)
- Parallel/iterative loops if any (e.g., batching over subject directories)
- External dependencies (e.g., shell environment, Python version)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Inputs
    subgraph "Data Inputs"
        RawData[(Raw T2w & DWI Data)]:::datastore
    end

    %% Preprocessing Stage
    subgraph "Preprocessing"
        batch_transform["batch_transform_all.sh\n(BASH)"]:::bash
        intermediate1[(Aligned DWI NIfTI)]:::datastore
        batch_mask["batch_mask.sh\n(BASH)"]:::bash
        intermediate2[(Masked T2 & DWI NIfTI)]:::datastore
    end

    %% Feature Extraction Stage
    subgraph "Feature Extraction"
        extract["Extract_regions.ipynb\n(NiBabel, NumPy)"]:::python
        features[(ROI Features CSV/NumPy Arrays)]:::datastore
    end

    %% Statistics & Modeling Stage
    subgraph "Statistics & Modeling"
        stats["Calculate_average_values.ipynb\n(pandas, openpyxl)"]:::python
        summary[(Summary Statistics XLSX)]:::datastore
        regression["Polynomial_ridge_regression.ipynb\n(scikit-learn)"]:::python
        modelout[(Regression Model Outputs)]:::datastore
        zscore["VM_zscore.ipynb\n(scipy, NumPy)"]:::python
        zoutput[(Z-score Tables/Plots)]:::datastore
    end

    %% Data Flow
    RawData -->|"NIfTI files"| batch_transform
    batch_transform -->|"Aligned NIfTI"| intermediate1
    intermediate1 -->|"Input for masking"| batch_mask
    batch_mask -->|"Masked NIfTI"| intermediate2
    intermediate2 -->|"Masked images"| extract
    extract -->|"ROI CSV/NumPy"| features
    features -->|"Feature tables"| stats
    stats -->|"XLSX stats"| summary
    summary -->|"Input features"| regression
    regression -->|"Model plots & metrics"| modelout
    modelout -->|"Group stats"| zscore
    zscore -->|"Z-score tables/plots"| zoutput

    %% Click Events
    click batch_transform "https://github.com/amiruthavallii/fetal-diffusion-mri/blob/main/./batch_transform_all.sh"
    click batch_mask "https://github.com/amiruthavallii/fetal-diffusion-mri/blob/main/./batch_mask.sh"
    click extract "https://github.com/amiruthavallii/fetal-diffusion-mri/blob/main/./Extract_regions.ipynb"
    click stats "https://github.com/amiruthavallii/fetal-diffusion-mri/blob/main/./Calculate_average_values.ipynb"
    click regression "https://github.com/amiruthavallii/fetal-diffusion-mri/blob/main/./Polynomial_ridge_regression.ipynb"
    click zscore "https://github.com/amiruthavallii/fetal-diffusion-mri/blob/main/./VM_zscore.ipynb"

    %% Styles
    classDef bash fill:#add8e6,stroke:#000,stroke-width:1px;
    classDef python fill:#90ee90,stroke:#000,stroke-width:1px;
    classDef datastore fill:#ffff99,stroke:#000,stroke-width:1px;
    class batch_transform,batch_mask bash
    class extract,stats,regression,zscore python
    class RawData,intermediate1,intermediate2,features,summary,modelout,zoutput datastore
```
