kernelkit.VolumeGeometry

class kernelkit.VolumeGeometry(shape, voxel_size, extent_min, extent_max, rotation=(0.0, 0.0, 0.0))

Geometry for a single 3D reconstruction object.

Methods

check_consistency()	Checks if the volume geometry is consistent.
has_isotropic_voxels([atol])	Checks if the volume has an isotropic voxel size.
voxel_volume()	Returns the volume of a single voxel.

__init__(shape, voxel_size, extent_min, extent_max, rotation=(0.0, 0.0, 0.0))

Initializes a VolumeGeometry object.

Parameters:

shapearray-like

The shape of the volume.

voxel_sizearray-like

The size of a single voxel.

extent_minarray-like

The minimum extent of the volume.

extent_maxarray-like

The maximum extent of the volume.

rotationarray-like, optional

The rotation of the volume in roll, pitch, yaw order, by default (0., 0., 0.). The rotation is equivalent to a rotation of all projection geometriess in the opposite direction.

Notes

• To encode a shift, use the extent_min and extent_max parameters.

• The shape, voxel_size, extent_min, extent_max, and rotation parameters are all stored as tuples. They contain redundant information, to generate this object from only a few parameters, see kernelkit.geom.vol.resolve_volume_geometry`.

Methods

__init__(shape, voxel_size, extent_min, ...)	Initializes a VolumeGeometry object.
check_consistency()	Checks if the volume geometry is consistent.
has_isotropic_voxels([atol])	Checks if the volume has an isotropic voxel size.
voxel_volume()	Returns the volume of a single voxel.