Skip to main content

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

Project description

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/vboussot/KonfAI.git
python -m pip install -e apps/impact_synth

⚙️ Usage

Perform image-to-sCT synthesis:

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

Optional arguments

Flag Description Default
MODEL Input modality / model name on Hugging Face MR or CBCT
-i, --input Path to the input file required
-o, --output Path to save the synthetic CT ./Output/
--gt Path to reference CT (ground truth), if available (enables evaluation workflows) unset
--mask Path to region-of-interest mask used for evaluation and uncertainty analysis unset
--tta Number of test-time augmentations (TTA) 2
--ensemble Number of models to ensemble 5
--mc Monte Carlo dropout samples for uncertainty 1
-uncertainty Save uncertainty maps False
--gpu GPU list (e.g. 0 or 0,1) CPU if unset
--cpu Number of CPU cores (if no GPU) 1
-q, --quiet Suppress console output False

Example

impact-synth-konfai CBCT -i patient01.nii.gz -o patient01 --gpu 0 --tta 2 --ensemble 5 -uncertainty

🧠 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


🔗 Links


Project details


Download files

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

Source Distribution

impact_synth_konfai-1.5.7.tar.gz (738.8 kB view details)

Uploaded Source

Built Distribution

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

impact_synth_konfai-1.5.7-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file impact_synth_konfai-1.5.7.tar.gz.

File metadata

  • Download URL: impact_synth_konfai-1.5.7.tar.gz
  • Upload date:
  • Size: 738.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for impact_synth_konfai-1.5.7.tar.gz
Algorithm Hash digest
SHA256 79efcd62d6750e52eb60c1de182bd9713d72100bc56713adfa3ca0e71792ffe3
MD5 f88ba2af88cad0d43857691d6587a9e4
BLAKE2b-256 b9d70de02246aa83005740c62e4cf8c890b198686694198a49e7298004b471de

See more details on using hashes here.

Provenance

The following attestation bundles were made for impact_synth_konfai-1.5.7.tar.gz:

Publisher: publish.yml on vboussot/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_synth_konfai-1.5.7-py3-none-any.whl.

File metadata

File hashes

Hashes for impact_synth_konfai-1.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 de40294ed5b2b6aef606b363e84755695cf36fbe8ad623acc1ff313df7a38b4d
MD5 51fc8b70d3fb3053bd9ee4bb952bba04
BLAKE2b-256 a0d1c0f08b316b34b5494e44a2cfc4875c4e4f02f28f802fbd38abf64ece5e31

See more details on using hashes here.

Provenance

The following attestation bundles were made for impact_synth_konfai-1.5.7-py3-none-any.whl:

Publisher: publish.yml on vboussot/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 Pingdom Monitoring Sentry Error logging StatusPage Status page