phantomkit 0.1.7

Collection of tools to derive metrics from physical phantoms used in QA of medical imaging instruments.

PhantomKit

PhantomKit is a Python toolkit for automated quality assurance (QA) of medical imaging scanners using physical phantoms. It provides pydra-based workflows that register phantom scans to a reference template, extract per-vial signal statistics across multiple contrast types, and generate publication-quality plots — supporting both MRI and PET phantom protocols.

Features

• Template-based registration — iterative ANTs SyN registration with automatic orientation search across a rotation library
• Vial metric extraction — per-vial mean, median, std, min and max across all contrast images, written to CSV
• Plotting — scatter plots of vial intensity and parametric map plots (T1/IR, T2/TE) with mrview ROI overlays
• Protocol support — extensible protocols sub-package for phantom- and project-specific workflow configurations
• Parallel batch processing — pydra-native splitting and combining for multi-session datasets

Installation

python -m pip install phantomkit

Basic usage

from phantomkit.protocols.gsp_spirit import GspSpiritAnalysis

wf = GspSpiritAnalysis(
    input_image="/data/session01/t1_mprage.nii.gz",
    template_dir="/templates/gsp_spirit",
    rotation_library_file="/templates/gsp_spirit/rotations.txt",
)
outputs = wf(cache_root="/data/cache-root")

Or via the command line:

# Single session
phantom-process run gsp-spirit /data/session01/t1_mprage.nii.gz \
    --template-dir /templates/gsp_spirit \
    --rotation-library-file /templates/gsp_spirit/rotations.txt \
    --output-base-dir /results

# Batch — process every matching image found under /data/
phantom-process run gsp-spirit /data/ \
    --template-dir /templates/gsp_spirit \
    --rotation-library-file /templates/gsp_spirit/rotations.txt \
    --output-base-dir /results \
    --pattern "*t1*mprage*.nii.gz"

# List available protocols
phantom-process list

Plotting

Generate QA plots from existing CSV metric files:

# Vial intensity scatter plot for one contrast
phantom-process plot vial-intensity \
    /results/session01/metrics/session01_t1_mprage_mean_matrix.csv scatter \
    --std_csv /results/session01/metrics/session01_t1_mprage_std_matrix.csv \
    --output  /results/session01/metrics/session01_t1_PLOTmeanstd.png

# T1 inversion-recovery parametric map plot
phantom-process plot maps-ir \
    /results/session01/images_template_space/ir_*.nii.gz \
    --metric_dir /results/session01/metrics \
    --output     /results/session01/metrics/session01_T1map_plot.png

# T2 spin-echo parametric map plot
phantom-process plot maps-te \
    /results/session01/images_template_space/te_*.nii.gz \
    --metric_dir /results/session01/metrics \
    --output     /results/session01/metrics/session01_T2map_plot.png

See the CLI documentation for the full option reference.

License

Copyright 2026 Australian Imaging Service. Released under the Apache License 2.0.