Expand description
§tomoxide
A Rust tomographic reconstruction toolkit — the algorithmic breadth of
tomopy (CPU libtomo) and the GPU streaming reconstruction of tomocupy
(CUDA), behind one tri-backend abstraction (CPU / CUDA / wgpu).
This is a single crate; its modules are the foundational data model and
backend traits (backend, data, dtype, error, geometry,
params), the backends (cpu, cuda, wgpu), reconstruction
(recon), preprocessing (prep), I/O (io), simulation (sim),
and the high-level engine + pipeline + align.
use tomoxide::{Engine, BackendKind};
let engine = Engine::new(BackendKind::Auto)?; // CPU on a GPU-less box
println!("backend: {}", engine.name());See docs/ARCHITECTURE.md for the design and CHANGELOG.md for status.
Re-exports§
pub use engine::Engine;pub use pipeline::prep_band;pub use pipeline::reconstruct;pub use pipeline::reconstruct_lamino_streaming;pub use pipeline::CancelToken;pub use pipeline::PrepOptions;pub use pipeline::ReconSteps;pub use backend::Backend;pub use backend::DeviceBuffer;pub use backend::DeviceKind;pub use backend::Elementwise;pub use backend::FbpFilter;pub use backend::Fft;pub use backend::FilteredBackproject;pub use backend::ForwardProject;pub use backend::IterativeReconstruct;pub use backend::RankFilter;pub use cpu::CpuBackend;pub use cuda::CudaBackend;pub use data::Dataset;pub use data::Frames;pub use data::Layout;pub use data::Slice2D;pub use data::Tomo;pub use data::Volume;pub use dtype::Complex32;pub use dtype::Dtype;pub use dtype::Element;pub use error::Error;pub use error::Result;pub use geometry::Angles;pub use geometry::Beam;pub use geometry::Center;pub use geometry::Detector;pub use geometry::Geometry;pub use geometry::ValidFov;pub use params::Algorithm;pub use params::BackendKind;pub use params::FilterName;pub use params::PhaseMethod;pub use params::ReconParams;pub use params::StripeMethod;
Modules§
- align
- Laminography alignment on one prepped projection stack: the rings estimate,
the centre probe sweep and the tilt scan, run in the order
docs/LAMINOGRAPHY_ALIGNMENT.mdgives.tomoxide alignand the GUI both drive these; judging a sweep (judge_sweep) and reporting it stay with them. - backend
- The tri-backend abstraction.
- cpu
- tomoxide-cpu
- cuda
- tomoxide-cuda
- data
- The 3-D array data model.
- dtype
- Element scalar types and the runtime
Dtypetag. - engine
- Backend selection.
Engineowns a boxedBackendand is the single place that knows all three backend crates exist (see ARCHITECTURE §2.4). - error
- Error and result types shared across the workspace.
- geometry
- Acquisition geometry: angles, rotation center, beam type, detector.
- io
- tomoxide-io
- params
- Algorithm selectors and parameter structs (the union of tomopy + tomocupy).
- pipeline
- High-level reconstruction pipelines.
- prep
- tomoxide-prep
- recon
- tomoxide-recon
- sim
- tomoxide-sim
- wgpu
- tomoxide-wgpu