Skip to main content

License PyPI version Python CI Paper

IMPACT-Reg logo

IMPACT-Reg-KonfAI

Fast and lightweight CLI for multimodal medical image registration using IMPACT-Reg presets within the KonfAI framework.


🧩 Overview

IMPACT-Reg-KonfAI is the command-line interface (CLI) for running IMPACT-Reg registration presets published in the VBoussot/ImpactReg Hugging Face repository, through the KonfAI deep learning framework.

IMPACT-Reg introduces a semantic similarity metric for multimodal registration, driven by deep features extracted from large pretrained segmentation and foundation models (MIND, TotalSegmentator, MRSegmentator). It plugs into an Elastix-based multi-resolution deformable pipeline to achieve robust cross-modality alignment while keeping deformations smooth and physically plausible.

A registration run combines:

  • fixed and moving images
  • one or more registration presets resolved from the published preset database (each preset is a KonfAI app)
  • optional image, segmentation, or landmark references (with an optional mask) for evaluation

🧠 Features

  • Fast registration powered by KonfAI
  • 🤗 Automatic preset, parameter-map, and model download from Hugging Face
  • 🧩 Multi-preset ensembling (transforms averaged into a single displacement field)
  • 🧠 Semantic IMPACT metric on deep features from pretrained segmentation / foundation models
  • 📐 Evaluation workflows against image, segmentation, and landmark references
  • 🧾 Multi-format compatibility: supports all major medical image formats handled by ITK

🗂️ Available presets

Presets are resolved dynamically from the published preset database (PresetDatabase.json) and passed as the first positional argument(s). Current presets include generic rigid / rigid + BSpline strategies and IMPACT-driven deformable presets tuned per modality pair (MR/CT, CBCT/CT) and anatomy (generic, head & neck).

List the presets exposed by your installation with:

impact-reg-konfai register --help

🚀 Installation

From PyPI:

python -m pip install impact-reg-konfai

From source:

git clone https://github.com/fideus-labs/KonfAI.git
cd KonfAI
# konfai and konfai-apps must come from the same checkout: this app pins both to its own
# setuptools_scm version, which only exists on PyPI at a release tag.
python -m pip install -e . -e konfai-apps -e apps/impact_reg

⚙️ Usage

The CLI is organised into sub-commands, matching the registration workflow:

Sub-command Purpose
register Register a moving image onto a fixed image with one or more presets. Several presets are ensembled (their displacement fields are averaged). Writes the transform under the name and in the form the preset declared, the moved image derived from it, and, with --uncertainty, the per-preset fields (kept under Ensemble/ for uncertainty).
eval Evaluate a registration on any subset of modalities: image (MAE), segmentation (Dice), landmarks (TRE). At least one modality is required.
uncertainty Voxel-wise spread map from an ensemble of displacement fields.

Register a moving image onto a fixed image (ensemble several presets by listing them):

impact-reg-konfai register <PRESET> [<PRESET_2> ...] -f fixed.nii.gz -m moving.nii.gz -o ./Output --gpu 0

Evaluate a registration on any subset of modalities; the transform comes from a prior register:

impact-reg-konfai eval \
  --transform ./Output/P000/DVF.mha \
  -f fixed.nii.gz -m moving.nii.gz --mask roi.nii.gz \
  --gt-fixed-seg fixed_seg.nii.gz --gt-moving-seg moving_seg.nii.gz \
  --gt-fixed-fid fixed.fcsv --gt-moving-fid moving.fcsv \
  -o ./Output --gpu 0

Estimate uncertainty from the per-preset displacement fields written by register:

impact-reg-konfai uncertainty --dvf ./Output/P000/Ensemble/*.mha -o ./Output/P000

register arguments

Flag Description Default
PRESET One or more presets from the published preset database (several are ensembled) required
-f, --fixed-images Fixed image(s), or a dataset directory required
-m, --moving-images Moving image(s), or a dataset directory required
--fixed-mask, --moving-mask Optional masks restricting the metric region unset
-o, --output Output directory ./Output/
--tta Test-time-augmentation draws per preset 0
--uncertainty Keep the per-preset fields under Ensemble/ for a later uncertainty run False
--fields-only Write the transforms and stop; skip deriving the moved images False
--set NAME=VALUE Override a preset parameter (repeatable, forwarded to konfai-apps infer) unset
--tmp-dir Where the intermediates are staged system temp
--gpu / --cpu GPU id(s) / CPU worker processes CPU if unset
-q, --quiet Suppress console output False

eval arguments (at least one modality required)

Flag Description Default
--transform Transform(s) from a prior register (identity if omitted) unset
-f, -m Fixed / moving images: image modality (MAE) unset
--gt-fixed-seg, --gt-moving-seg Fixed / moving segmentations: seg modality (Dice) unset
--gt-fixed-fid, --gt-moving-fid Fixed / moving landmarks: fid modality (TRE) unset
--mask Evaluation mask(s) for the image modality unset
--preset Preset providing the evaluation configs first available

uncertainty arguments

Flag Description Default
--dvf Two or more ensemble displacement fields (e.g. the per-preset fields from register) required
-o, --output Output directory ./Output/

See the full help of any sub-command with:

impact-reg-konfai register --help

📦 Notes

  • Available presets are resolved dynamically from the published IMPACT-Reg preset database.
  • Multiple presets can be provided in one command; their displacement fields are averaged into a single field.
  • The wrapper orchestrates the preset KonfAI apps (model inference), then ensembles, evaluates, and estimates uncertainty on their outputs.

📚 References

If you use IMPACT-Reg-KonfAI in your work, please cite KonfAI and the IMPACT-Reg paper.

  • Boussot, V., Hémon, C., Nunes, J.-C., Dowling, J., Rouzé, S., Lafond, C., Barateau, A., & Dillenseger, J.-L. IMPACT-Reg: A Generic Semantic Loss for Multimodal Medical Image Registration.

  • Boussot, V., & Dillenseger, J.-L. (2025). KonfAI: A Modular and Fully Configurable Framework for Deep Learning in Medical Imaging. arXiv preprint arXiv:2508.09823


🔗 Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

impact_reg_konfai-1.8.0.tar.gz (925.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

impact_reg_konfai-1.8.0-py3-none-any.whl (74.0 kB view details)

Uploaded Python 3

File details

Details for the file impact_reg_konfai-1.8.0.tar.gz.

File metadata

  • Download URL: impact_reg_konfai-1.8.0.tar.gz
  • Upload date:
  • Size: 925.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for impact_reg_konfai-1.8.0.tar.gz
Algorithm Hash digest
SHA256 9b8e9087b61f8abea371db6eb91355b98e0cf732988b72af5aa69f5ca6140b2b
MD5 70e864b39ae6a026761eb6e2272c4727
BLAKE2b-256 bb56f4b32e9fd326b4d449badf1cfa80f421c68fc6a921811a197be673c5e546

See more details on using hashes here.

Provenance

The following attestation bundles were made for impact_reg_konfai-1.8.0.tar.gz:

Publisher: publish.yml on fideus-labs/KonfAI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file impact_reg_konfai-1.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for impact_reg_konfai-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d736da987468a886f15d3d816db066e601f074afcc80ba41f38638403379802c
MD5 fe86902dccf3700ec49c7a551337dc48
BLAKE2b-256 2f455b896287ad7a84e8a61ea5c880c8e6fdb36101e7ece92969e456e3b836e3

See more details on using hashes here.

Provenance

The following attestation bundles were made for impact_reg_konfai-1.8.0-py3-none-any.whl:

Publisher: publish.yml on fideus-labs/KonfAI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page