Project-MONAI / Project-MONAI/tutorials
Add introductory k-space basics tutorial for MRI reconstruction
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 2.5k
- Forks
- 803
- Merge medio
- 6 d 22 h
- PR fusionados (30 d)
- 3
Descripción
Summary
Adds a beginner-friendly introductory tutorial for MRI reconstruction using the fastMRI knee single-coil dataset and MONAI's reconstruction transforms.
Changes
- New notebook:
reconstruction/MRI_reconstruction/tutorials/01_kspace_basics_fastmri_knee.ipynb- Part 1: What is k-space (loading real data, inverse FFT)
- Part 2: Fourier transform connection (low vs. high frequencies)
- Part 3: Undersampling and aliasing artifacts (1x, 2x, 4x, 8x)
- Part 4: Random vs. equispaced masks using
RandomKspaceMaskd/EquispacedKspaceMaskd - Part 5: Full MONAI preprocessing pipeline (
FastMRIReader→CenterSpatialCropd→ReferenceBasedNormalizeIntensityd) - Part 6: Zero-filled reconstruction → deep learning connection
- New README:
reconstruction/MRI_reconstruction/tutorials/README.md - Updated
README.md: Added missing Reconstruction section listing this tutorial plus existingunet_demoandvarnet_demo - Updated
runner.sh: Added notebook todoesnt_contain_max_epochs(no training loop)
Dataset
- Uses fastMRI knee single-coil validation set (non-commercial license)
- Only one
.h5file (~300 MB) required — no need for the full ~1.5 TB brain multi-coil download - Added to
skip_run_papermillvia existing.*MRI_reconstruction.*pattern
Design decisions
- Bridges the gap between newcomers and production tutorials (
unet_demo,varnet_demo) - Uses
CenterSpatialCropdinstead ofReferenceBasedSpatialCropdto handle the k-space (640×368) vs ground truth (320×320) dimension mismatch - No training loop — purely educational, runs without GPU
Test plan
- Notebook runs end-to-end on Google Colab with real fastMRI knee data (
file1000000.h5) - All 5 matplotlib visualizations render correctly
- Pipeline output shapes:
kspace_masked_ifftandreconstruction_escboth(1, 320, 320) - PEP 8 passes via
./runner.sh -t reconstruction/MRI_reconstruction/tutorials/01_kspace_basics_fastmri_knee.ipynb --no-run - Copyright header present with correct formatting
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con reconstruction/MRI_reconstruction/tutorials/01_kspace_basics_fastmri_knee.ipynb y compáralo con los tutoriales unet_demo y varnet_demo existentes. Ejecuta ./runner.sh -t reconstruction/MRI_reconstruction/tutorials/01_kspace_basics_fastmri_knee.ipynb --no-run y, después, valida el notebook con el archivo fastMRI file1000000.h5 en Colab. Se considera terminado cuando las visualizaciones se renderizan, las formas de salida indicadas coinciden y se actualizan las entradas de README y runner.sh.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- jupyter-notebook, pytorch
- Área
- documentation, machine-learning
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 68/100