Skip to main content

License PyPI version Python CI Paper

IMPACT-Synth logo

IMPACT-Synth-KonfAI

Fast and lightweight CLI for synthetic CT generation using IMPACT-Synth models within the KonfAI framework.


🧩 Overview

IMPACT-Synth-KonfAI is the command-line interface (CLI) for performing inference and uncertainty estimation with the IMPACT-Synth models.
It provides a streamlined way to generate synthetic CT (sCT) images from MR or CBCT scans, leveraging the KonfAI framework for efficient inference, test-time augmentation (TTA), model ensembling, and uncertainty quantification.

The underlying IMPACT-Synth models are a family of supervised convolutional neural networks (CNNs) dedicated to sCT generation. They build upon the research presented in “Why Registration Quality Matters: Enhancing sCT Synthesis with IMPACT-Based Registration” (Boussot et al., 2025).
These models are trained on carefully aligned MR–CT pairs, where alignment is optimized through the IMPACT-Reg loss to minimize spatial bias. Their training further integrates the IMPACT-Synth loss, a perceptual loss derived from semantic representations of segmentation networks. Together, precise spatial alignment and semantic perceptual supervision reinforce anatomical fidelity and realistic tissue contrast in the synthesized CT images.

The official IMPACT-Synth models are available on Hugging Face and can be executed directly through this CLI.


🚀 Installation

From PyPI:

python -m pip install impact-synth-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_synth

⚙️ Usage

The CLI is organised into sub-commands, mirroring the KonfAI Apps operations:

Sub-command Purpose
synthesize Generate the synthetic CT (inference).
eval Evaluate a synthetic CT against a reference CT.
uncertainty Estimate uncertainty (TTA / MC-dropout / ensemble spread).
pipeline Run synthesis, then evaluation and uncertainty in one command.

Generate a synthetic CT:

impact-synth-konfai synthesize MR -i path/to/input.nii.gz -o ./Output/

Evaluate against a reference CT, or run everything at once:

impact-synth-konfai eval MR -i input.nii.gz --gt reference_ct.nii.gz -o ./Output/
impact-synth-konfai pipeline CBCT -i patient01.nii.gz --gt ct.nii.gz -o patient01 --gpu 0 --tta 2 --ensemble 5 -uncertainty

Arguments

Flag Description Default
MODEL Model name on Hugging Face (MR, CBCT or MR_CBCT), which determines what is predicted required
-i, --inputs Input file(s) or a dataset directory required
-o, --output Output directory ./Output/
--ensemble Number of models to ensemble (synthesize / pipeline) 0
--tta Number of test-time augmentations (synthesize / pipeline) 0
--mc Monte Carlo dropout samples (synthesize / pipeline) 0
-uncertainty Also write the inference stack (synthesize / pipeline) False
--gt Reference CT(s): required by eval, optional in pipeline unset
--mask Evaluation mask(s) (eval / pipeline) unset
--gpu GPU id(s), e.g. 0 or 0 1 CPU if unset
--cpu Number of CPU worker processes unset
-q, --quiet Suppress console output False

🧠 Features

  • ⚡ Fast inference powered by KonfAI
  • 🤗 Automatic model download from Hugging Face
  • 🧩 Multi-model ensembling and test-time augmentation (TTA)
  • 🧠 Supports evaluation workflows with reference data, and uncertainty estimation without reference
  • 🧾 Multi-format compatibility: supports all major medical image formats handled by ITK

📚 References

If you use IMPACT-Synth-KonfAI in your work, please cite:

  • Boussot, V., Hémon, C., Nunes, J.-C., & Dillenseger, J.-L. (2025).
    Why Registration Quality Matters: Enhancing sCT Synthesis with IMPACT-Based Registration.
    arXiv preprint arXiv:2510.21358

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


⚡ Performance & VRAM

Benchmarked on a single NVIDIA RTX PRO 5000 (24 GB) with a real whole-body MR (295 × 259 × 219, 2 mm), patch [1, 512, 512]. The app auto-selects the batch size from your free GPU VRAM (vram_plan); override it in SlicerKonfAI (⚙ Advanced) or on the CLI with --patch-size / --batch-size.

Free VRAM Batch (auto) Peak VRAM Time / case
8 GB 16 ~7.6 GB n/a
16 GB 28 ~15 GB n/a
24 GB 32 ~16 GB ~24 s

Single-model sCT keeps system RAM ~2 GB. The plan leaves memory headroom: a larger batch saturates the card and slows inference (batch 48 → ~22 GB). A full 5-model ensemble runs in ~82 s. Inference scales with the case size.



Metadata

Release files for impact-synth-konfai 1.8.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for impact-synth-konfai 1.8.2
File Size Uploaded
impact_synth_konfai-1.8.2.tar.gz 741.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for impact-synth-konfai 1.8.2
File Interpreter ABI Platform
impact_synth_konfai-1.8.2-py3-none-any.whl Python 3 none any Details

Total release size: 755.3 kB

Release files / impact_synth_konfai-1.8.2.tar.gz

Download URL impact_synth_konfai-1.8.2.tar.gz
Size 741.1 kB
Tags Source
SHA-256 checksum
How to use checksums
75001df9347847d61fe97452ae98e7bce70b789bb6fcf31d51926918dbe12a66
BLAKE2b-256 checksum
How to use checksums
dcdcd9114153250eebfb459c329ea5097aa8a718f1cc578f368fb24083e86ee3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

Release files / impact_synth_konfai-1.8.2-py3-none-any.whl

Download URL impact_synth_konfai-1.8.2-py3-none-any.whl
Size 14.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7e22b2a58538f15e7917498997b69ae3b52fcc16f977bd7d8c9abfd5cdf964c3
BLAKE2b-256 checksum
How to use checksums
09c3aa7211e7a5b10b77d36c4258e86a4c55006099398bbf0a8217b90c15905a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

Release history Release notifications | RSS feed

1.8.7

2 release files

1.8.6

2 release files

1.8.5

2 release files

1.8.4

2 release files

1.8.3

2 release files

This release

1.8.2 This release

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.0

2 release files

1.5.9

2 release files

1.5.8

2 release files

1.5.7

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.9

2 release files

1.4.8

2 release files

1.4.7

2 release files

1.4.6

2 release files

1.4.5

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page