blockmatchingw¶

Pythonic wrapper for Klab-BlockMatching, providing a modern CLI and Python API for block matching-based image registration.

Klab-BlockMatching is a suite of tools for block matching-based image registration developed by the MORPHEME team at INRIA.

Features¶

• Modern CLI — Typer-based CLI with descriptive option names for all 16 BlockMatching tools
• Python API — Call registration tools directly from Python with typed arguments
• Structured logging — Loguru-based logging with tool output classification
• Easy installation — Install via pip or uv, with automatic binary download

Quick start¶

pip install blockmatchingw
blockmatchingw blockmatching \
  --reference ref.nii.gz \
  --floating flo.nii.gz \
  --result-transformation trsf.txt

from blockmatchingw import blockmatching

blockmatching(
    reference="ref.nii.gz",
    floating="flo.nii.gz",
    result_transformation="trsf.txt",
)