Documentation map
Every guide by task.
Start with a small reconstruction, then supply your acquisition's geometry and preprocessing details. TomoJAX is an early research library for parallel-beam, laminography and lab cone-beam models; consult the support and limitations pages before planning a workflow.
Use the library
| You want to… | Guide |
|---|---|
| Install CPU or CUDA dependencies | Installation |
| Load an NXtomo, APS Data Exchange, Nikon or TIFF scan, correct its frames and reconstruct it | Quickstart |
| Simulate data or call the Python API | Synthetic tomography, examples |
| Supply measured geometry for parallel or laminography scans, including TIFF stacks | Real scan guide |
| Import, calibrate and reconstruct a lab cone-beam CT scan | Lab cone-beam CT |
| Differentiate through projection in PyTorch | PyTorch bridge |
| Correct per-view motion or the centre of rotation | Alignment guide |
| Reconstruct scans larger than the GPU, or use several GPUs | Large scans and several GPUs |
| Check geometry, units, algorithms, and GPU scope | Support matrix, known limitations |
| See the measured speed, accuracy and memory behind the guides | Measurements |
Python reference and development
Run just docs from a development checkout to build the Python API reference
at .artifacts/docs/index.html, directly from the NumPy-style public docstrings.
Run just docstrings to validate their structure and parameter coverage.
Import through public module roots or their api facades. Files beginning with
_ and the core implementation are not stable application interfaces.
- Command line: the commands, their conventions
and
--configfiles. - Geometry: grids, detectors, and poses.
- Forward projection: model and derivative choices.
- Reconstruction: algorithms and configuration.
- Corrections: the steps from detector counts to line integrals, and on line integrals.
- IO: datasets, acquisition metadata and TIFF angle files.
- Alignment: configurations, plans and
checkpoints behind
tj.align. - Alignment solver:
AlignConfigsettings, Jacobians, coupling and linear-solve diagnostics. - Benchmarks: how to rerun the comparisons with ASTRA and TIGRE.
- Contributing: tests, packaging, and repository conventions.
- Changelog: behavioural changes and migration notes.