diffct
English · 简体中文
Differentiable CUDA projectors for CT: arbitrary trajectories, multi-GPU, multi-node, geometry gradients.
Intro video (MP4) · Technical report · DOI
Install · Quickstart · Features · Performance · Examples · Citation
Version 2.0 replaces the circular-orbit API of 1.x with per-view trajectories. Code written for 1.x needs changes; see the migration notes. For Apple Silicon, use the MLX port by Linda-Sophie Schneider.
Why diffct
To our knowledge, diffct is the only open-source GPU CT library that combines arbitrary per-view trajectories, autograd through the volume, first-order gradients through the acquisition geometry, and built-in multi-GPU and multi-node execution. We compared it with LEAP, TIGRE, ASTRA/tomosipo, DiffDRR and others in October 2026.
- Arbitrary trajectories. Each view has its own source, detector centre and detector axes. Circular, helical, saddle, sinusoidal, random and calibrated scans use the same code. Trajectory tensors with
requires_grad=Truereceive geometry gradients for calibration. - Curved detectors.
ParameterizedSurfacedefines native arc, cylindrical or arbitrary pixels from global coordinates and explicit parameters, sampled in bounded view/pixel batches. Legacydetector_surface(u, v)callbacks remain available. Projection and matched backprojection support first-order surface gradients. See the surface API. - Matched operators.
project()andbackproject()form an exact adjoint pair for the cell-constant Siddon model. Both support PyTorch autograd, with volume/sinogram gradients and Hessian-vector products. - Large volumes. Automatic spatial, view and pixel blocks with bounded transfer buffers control working memory.
project_into/backproject_intoaccept caller-owned tensor or disk stores; tensor autograd keeps complete data on its input device. See chunked execution. - Multi-GPU and multi-node. Use
devices=[0, 1, 2, 3]in one process, or torchrun and NCCL across ranks. Defaultpartition="views"shards projections and replicates volumes.partition="space"gives each rank an owned volume slab and combines ray contributions. Speedup depends on workload and communication costs. - Analytical helpers.
diffct.analyticalprovides ramp filters (ram-lak, shepp-logan, cosine, hamming, hann), fan, cone and Parker weights, and FBP and FDK backprojection.
Capabilities, limits and isocenter rules: docs/REFERENCE.md.
Install
You need an NVIDIA GPU. Install PyTorch for your CUDA version first. Then install diffct with the extra for the same CUDA major version:
pip install "diffct[cu12]" # PyTorch built for CUDA 12
pip install "diffct[cu13]" # PyTorch built for CUDA 13
The extra installs the CUDA compiler libraries that Numba CUDA needs to compile the kernels. A plain pip install diffct does not install them. Use it only if a CUDA Toolkit is already installed on the system.
From source, with the examples:
git clone https://github.com/sypsyp97/diffct.git
cd diffct && pip install -e ".[cu12]"
python examples/quickstart.py # smoke test: prints adjoint mismatch ~1e-8 for each beam
Notes on CUDA versions
- Numba CUDA imports
numpy.row_stack, which NumPy 2.5 removes. Keepnumpy<2.5. - Keep NVVM and NVJitLink compatible with the CUDA libraries that PyTorch loads. A newer NVVM with an older NVJitLink fails when the kernels compile.
- A tested CUDA 13 set:
pip install "numpy<2.5" "numba-cuda[cu13]" "cuda-toolkit[cccl,cudart,nvrtc,nvvm]==13.0.2" "nvidia-nvjitlink<13.1". - A tested CUDA 12 set: PyTorch 2.10 (cu126) with
numba-cuda[cu12]0.30.4 on NVIDIA driver 535.
Quickstart
Create the acquisition once. Then call project() and backproject().
import torch
from diffct import Projector, spiral_trajectory_3d
trajectory = spiral_trajectory_3d(360, sid=320.0, sdd=512.0, z_range=40.0, n_turns=1.0, device="cpu")
A = Projector(trajectory, volume_shape=(128, 128, 128), detector_shape=(384, 256), detector_spacing=0.8)
volume = torch.rand(A.volume_shape, device="cuda")
sinogram = A.project(volume) # (360, 384, 256) line integrals
adjoint = A.backproject(sinogram) # matched adjoint A^T
x = torch.zeros_like(volume, requires_grad=True)
loss = 0.5 * (A.project(x) - sinogram).square().sum()
loss.backward() # x.grad = A^T (A x - y)
Custom or calibrated trajectories. Pass calibrated tensors directly instead of a generator; no circular fit is needed. See REFERENCE.
Geometry gradients. Set requires_grad=True on trajectory tensors before you build Projector. See REFERENCE.
Several GPUs and nodes. See REFERENCE and DISTRIBUTED.md.
A = Projector(trajectory, (128, 128, 128), (384, 256), detector_spacing=0.8, devices=[0, 1, 2, 3])
Volumes larger than GPU memory. Keep the arrays on CPU. The same calls use CUDA tiles automatically; CUDA inputs retain the full-volume path when its estimated working set fits. Explicit limits are optional:
A = Projector(trajectory, (128, 128, 128), (384, 256), detector_spacing=0.8)
volume = torch.ones(A.volume_shape, device="cpu", requires_grad=True)
sinogram = A.project(volume) # CPU output, CUDA computation
sinogram.square().mean().backward() # CPU volume.grad
# Optional: volume_chunk_shape=(32, 64, 64), view_chunk_size=16
Run python examples/chunked_reconstruction.py for CPU-backed CGLS and measured
CUDA allocation. Chunking preserves the Siddon model, with float32 summation
differences; smaller blocks can increase transfer and launch overhead. Full
tensor arrays and iterative state still need enough host RAM. For disk-backed
state and sharded checkpoints, run
python examples/disk_reconstruction.py --output disk-run; for fixed rank-local
volume slabs use --partition space under torchrun. Run
python examples/benchmark_execution.py to compare schedules and copy payloads.
Performance
| 512³ volume | 1 GPU | 4 GPUs, 1 node | 8 GPUs, 2 nodes |
|---|---|---|---|
| Forward projection | 493.05 ms | 132.22 ms (3.7×) | 73.18 ms (6.7×) |
| Adjoint (backprojection) | 1400.80 ms | 369.29 ms (3.8×) | 265.87 ms (5.3×) |
| CGLS iteration | 2054.36 ms | 547.06 ms (3.8×) | 373.38 ms (5.5×) |
diffct 2.2.0, FP32, A100 64 GB GPUs; circular cone beam, 360 views, 1024×768 detector, pitch 1.25. Default memory settings, without an imposed allocator cap.
Projection times are medians of seven samples after three warmups. CGLS uses three ten-iteration solves after a two-iteration warmup; the median includes initialization and is divided by ten. Timings use synchronized wall time and the slowest rank. Raw samples and configuration: scaling.json.
Run the same workload:
python examples/benchmark_scaling.py --output one.json
torchrun --standalone --nproc-per-node=4 examples/benchmark_scaling.py --expected-nodes 1 --output four.json
Gallery
TV denotes TV-regularized iterative reconstruction; Adam is the optimizer. Figure labels distinguish the method from its optimizer.
Measured walnut. 240 measured views, circular cone beam, 256³: FDK (Hann window), SIRT (200 iterations), CGLS (20), TV (300, weight 0.3); axial and coronal centre slices.
python examples/walnut_reconstruction.py --figure out.png
Simulated helical scan of the walnut. The FDK walnut volume as ground truth, 720 views, 1% noise, 256³. PSNR: FDK 26.67 dB, CGLS (30 iterations) 34.13 dB, SIRT (200) 34.52 dB, TV (200, weight 1.0) 37.77 dB.
python examples/walnut_reconstruction.py --algorithms --save-volume walnut256.npy
python examples/iterative_reconstruction.py --size 256 --views 720 --trajectory helical --noise 0.01 --phantom walnut256.npy --figure out.png
Walnut data: Meaney 2022, Zenodo 6986012, CC BY 4.0; see examples/data/NOTICE.
Examples
quickstart.py, curved_detector.py, chunked_reconstruction.py, analytical_reconstruction.py, iterative_reconstruction.py, walnut_reconstruction.py, geometry_calibration.py, benchmark_projector.py, plot_trajectory.py, and the Slurm template slurm/multi_node.sbatch. Launch modes and distributed-loss rules are in examples/README.md.
Documentation
| Document | Contents |
|---|---|
| Trajectory guide | Trajectory tuples and Projector usage |
| docs/REFERENCE.md | Capabilities and limits, custom trajectories, geometry gradients, multi-GPU details, geometry and units |
| docs/DISTRIBUTED.md | Execution/memory choices, distributed loss rules, Slurm and cross-node checks |
| docs/MIGRATION.md | Moving from the circular-only API |
| docs/video/README.md | How the intro video is rendered |
| CHANGELOG.md | Release history |
Run the test suite on a CUDA host with python -m pytest tests/ -q.
Citation
If you use this library in your research, please cite the software and the technical report:
@software{diffct2025,
author = {Yipeng Sun},
title = {diffct: Differentiable Computed Tomography Reconstruction with CUDA},
year = 2025,
publisher = {Zenodo},
doi = {10.5281/zenodo.14999333},
url = {https://doi.org/10.5281/zenodo.14999333}
}
@article{202605.1446,
doi = {10.20944/preprints202605.1446.v1},
url = {https://doi.org/10.20944/preprints202605.1446.v1},
year = 2026,
month = {May},
publisher = {Preprints},
author = {Yipeng Sun and Linda-Sophie Schneider and Chengze ye and Andreas Maier},
title = {diffct: Differentiable CT Operators from Circular Orbits to Arbitrary Trajectories},
journal = {Preprints}
}
License and acknowledgements
Apache 2.0, see LICENSE. The project draws on PYRO-NN and geometry_gradients_CT. Issues and pull requests are welcome. The walnut data are CC BY 4.0 (Meaney 2022); see NOTICE.
Metadata
Release files for diffct 2.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| diffct-2.2.0.tar.gz | 242.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| diffct-2.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 332.7 kB
Release files / diffct-2.2.0.tar.gz
| Download URL | diffct-2.2.0.tar.gz |
|---|---|
| Size | 242.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a08b9342a5f15320bc2e04571daeb5acf15ec455bba3070af9b690e18e68946a
|
|
BLAKE2b-256 checksum How to use checksums |
fe625c904f6dc8ea5da1013709762a7d240740fde6b7d15365b135dd95002deb
|
| 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 Oct 11, 2026.
Transparency logRelease files / diffct-2.2.0-py3-none-any.whl
| Download URL | diffct-2.2.0-py3-none-any.whl |
|---|---|
| Size | 90.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
19fe6c9880dd85344c57e8de5f53bf918929226e747e50d29565aef71e940119
|
|
BLAKE2b-256 checksum How to use checksums |
de64e5397348726ec463107c9383654b90c321d2424826a007ff1acf42a59c62
|
| 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 Oct 11, 2026.
Transparency log