API Reference¶
Voxel is conventionally imported as:
import voxel as vx
Core classes and I/O functions are available at the top level (vx.Volume, vx.load_volume, ...), while specialized functions live in module namespaces (vx.filters.gaussian_filter, vx.morphology.dilate, ...).
Classes¶
| Class | Description |
|---|---|
| Volume | Multi-channel 3D image with a world-space geometry |
| AcquisitionGeometry | Voxel-to-world transform of an image grid |
| Orientation | Anatomical orientation of the voxel axes |
| AffineMatrix | 4×4 transform for 3D coordinates |
| BoundingBox | Oriented 3D bounding box |
| LabelLookup | Table mapping label values to names and colors |
| Label | Single named, colored entry of a label lookup |
| Mesh | Triangular mesh in world space |
| Space | Voxel vs. world coordinate frame designator |
| Warp | Dense world-coordinate deformation |
| VectorField | Volume of 3D displacement or velocity vectors |
Functions¶
| Group | Contents |
|---|---|
| io | Loading and saving volumes, meshes, affines, boxes, and labels |
| volume | Volume stacking, grids, and comparison |
| acquisition | Geometry and orientation casting and comparison |
| affine | Transform constructors and fitting |
| warp | Transform composition |
| bounds | Oriented bounding box fitting |
| labels | Label map recoding and one-hot encoding |
| filters | Convolution filtering |
| morphology | Binary morphology and labeling |
| snapshots | 2D visualization |