Project-MONAI / Project-MONAI/tutorials
Add introductory k-space basics tutorial for MRI reconstruction
オープン
まだ誰も着手していません。
- 主要言語
- Jupyter Notebook
- スター
- 2.5k
- フォーク
- 803
- 平均マージ
- 6日 22時間
- マージ済み PR(30日)
- 3
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
reconstruction/MRI_reconstruction/tutorials/01_kspace_basics_fastmri_knee.ipynb から始め、既存の unet_demo および varnet_demo チュートリアルと比較します。./runner.sh -t reconstruction/MRI_reconstruction/tutorials/01_kspace_basics_fastmri_knee.ipynb --no-run を実行し、その後 Colab で fastMRI のファイル file1000000.h5 を使って notebook を検証します。視覚化がレンダリングされ、記載された出力形状が一致し、README と runner.sh のエントリが更新されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- jupyter-notebook, pytorch
- 領域
- documentation, machine-learning
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 68/100