User API

MBIRJAX is designed to give reconstructions using just a few lines of code.

The first step is to create an instance with a specific geometry. This is done by initializing a class such as

mbirjax.ParallelBeamModel(sinogram_shape, ...)

A class designed for handling forward and backward projections in a parallel beam geometry, extending the TomographyModel.

ParallelBeamModel and classes for other geometries are derived from TomographyModel, which includes several methods for manipulating sinograms and reconstructions.

mbirjax.TomographyModel.recon(sinogram[, ...])	Perform MBIR reconstruction using the Multi-Granular Vector Coordinate Descent algorithm.
mbirjax.TomographyModel.forward_project(recon)	Perform a full forward projection at all voxels in the field-of-view.
mbirjax.TomographyModel.back_project(sinogram)	Perform a full back projection at all voxels in the field-of-view.
mbirjax.TomographyModel.reshape_recon(recon)	Reshape recon into its 3D form.
mbirjax.TomographyModel.set_params([...])	Updates parameters using keyword arguments.
mbirjax.TomographyModel.get_params(...)	Get the values of the listed parameter names.
mbirjax.TomographyModel.gen_weights(...)	Compute the weights used in MBIR reconstruction.
mbirjax.TomographyModel.gen_3d_sl_phantom()	Generates a 3D Shepp-Logan phantom.
mbirjax.TomographyModel.print_params()	Prints out the parameters of the model.