qmrpy 0.8.0

Python toolkit for quantitative MRI modeling, fitting, and simulation.

qmrpy

Python toolkit for quantitative MRI (qMRI) modeling, fitting, and simulation.

Installation

pip install qmrpy
# or
uv add qmrpy

Quickstart

import numpy as np
from qmrpy.models import MonoT2

# Define model
model = MonoT2(te_ms=[10, 20, 40, 80])

# Simulate signal
signal = model.forward(m0=1000, t2_ms=80)

# Fit single voxel
fit = model.fit(signal)
print(fit)  # {'m0': 1000.0, 't2_ms': 80.0}

# Fit image with auto-masking and parallel processing
result = model.fit_image(image_data, mask="otsu", n_jobs=-1)

Features

• Models: T1 (VFA, IR), T2 (mono-exp, EPG, multi-component), B1, QSM, denoising
• Parallel fitting: n_jobs=-1 for multi-core acceleration
• Auto-masking: mask="otsu" for automatic thresholding
• I/O: save_tiff() / load_tiff() for uncompressed TIFF export

API

from qmrpy.models import MonoT2, EpgT2, VfaT1, InversionRecovery
from qmrpy import save_tiff, load_tiff

# All models follow the same pattern:
model = Model(acquisition_params)
signal = model.forward(**tissue_params)
fit = model.fit(signal)
result = model.fit_image(image, mask="otsu", n_jobs=-1)

License

MIT

---

qmrpy（日本語）

定量MRI（qMRI）のモデリング・フィッティング・シミュレーション用Pythonツールキット。

インストール

pip install qmrpy
# または
uv add qmrpy

クイックスタート

import numpy as np
from qmrpy.models import MonoT2

# モデル定義
model = MonoT2(te_ms=[10, 20, 40, 80])

# 信号シミュレーション
signal = model.forward(m0=1000, t2_ms=80)

# 単一ボクセルのフィッティング
fit = model.fit(signal)
print(fit)  # {'m0': 1000.0, 't2_ms': 80.0}

# 画像フィッティング（自動マスク＋並列処理）
result = model.fit_image(image_data, mask="otsu", n_jobs=-1)

主な機能

• モデル: T1（VFA, IR）、T2（単指数、EPG、多成分）、B1、QSM、ノイズ除去
• 並列フィッティング: n_jobs=-1でマルチコア高速化
• 自動マスク: mask="otsu"でOtsu二値化
• I/O: save_tiff() / load_tiff()で非圧縮TIFF保存

ライセンス

MIT