API Summary

We summarize important functions and classes that you may encounter in daily usage of tomosipo. This list is not meant to be exhaustive.

Create geometries

tomosipo.volume(*[, shape, pos, size, extent])

Create an axis-aligned volume geometry

tomosipo.parallel(*[, angles, shape, size])

Create a circular parallel-beam geometry

tomosipo.cone(*[, angles, shape, size, ...])

Create a circular cone-beam geometry

tomosipo.volume_vec(*, shape[, pos, w, v, u])

Create an arbitrarily oriented volume geometry

tomosipo.parallel_vec(*, shape, ray_dir, ...)

Create an arbitrarily oriented parallel-beam geometry

tomosipo.cone_vec(*, shape, src_pos, ...)

Create an arbitrarily oriented cone-beam geometry

Create geometric transforms

tomosipo.translate(axis, *[, alpha])

Create a translation transform

tomosipo.rotate(*, pos, axis[, angles, rad, ...])

Create a rotation transform

tomosipo.scale(scale, *[, pos, alpha])

Create a scaling transform

tomosipo.reflect(*, pos, axis)

Create a reflection transform

tomosipo.to_perspective(*[, pos, w, v, u, ...])

Create a perspective transform

tomosipo.from_perspective(*[, pos, w, v, u, ...])

Create a perspective transform

Create projection operator

tomosipo.operator(volume_geometry, ...[, ...])

Create a new tomographic operator

tomosipo.Operator.Operator(volume_geometry, ...)

A linear tomographic projection operator

Display geometries

tomosipo.svg(*geoms[, height, width, ...])

Geometry Classes

tomosipo.geometry.VolumeGeometry([shape, ...])

A volume geometry

tomosipo.geometry.VolumeVectorGeometry(...)

Documentation for VolumeVectorGeometry

tomosipo.geometry.ProjectionGeometry([shape])

A general base class for projection geometries

tomosipo.geometry.ParallelGeometry([angles, ...])

A parametrized parallel-beam geometry

tomosipo.geometry.ParallelVectorGeometry(...)

Documentation for ParallelVectorGeometry

tomosipo.geometry.ConeGeometry([angles, ...])

A parametrized circular cone-beam geometry

tomosipo.geometry.ConeVectorGeometry(*, ...)

Documentation for ConeVectorGeometry

tomosipo.geometry.Transform(matrix)

Documentation for Transform

Interoperability

ASTRA-toolbox

tomosipo.to_astra(x)

Convert tomosipo geometry to ASTRA

tomosipo.from_astra(astra_geom)

Import ASTRA geometry to tomosipo

ODL

tomosipo.odl.from_odl(geom_or_op)

Cupy

tomosipo.cupy

This module can be used to force interoperability with cupy