Struct Volume 

pub struct Volume<T: Scalar> { /* private fields */ }

A regular 3D grid of scalar values stored contiguously in memory.

The memory layout is X-fastest (row-major in image terms): data[x + y * nx + z * nx * ny] for single-component data.

VTK Equivalent

vtkImageData with scalar data in PointData.

Type Parameter

T must implement Scalar, which is sealed to known numeric types.

Implementations

impl<T: Scalar> Volume<T>

pub fn from_data( data: Vec<T>, dimensions: UVec3, spacing: DVec3, origin: DVec3, direction: DMat3, components: u32, ) -> Result<Self, VolumeError>

Create a volume from a flat voxel buffer.

data.len() must equal dimensions.x * dimensions.y * dimensions.z * components.

Errors

Returns VolumeError if dimensions, spacing, or data length are invalid.

pub fn from_slices( slices: &[&[T]], width: u32, height: u32, spacing: DVec3, origin: DVec3, direction: DMat3, ) -> Result<Self, VolumeError>

Assemble a volume from a sequence of 2D frames stacked along Z.

Each slice must have exactly width * height scalars in row-major order (X-fastest). Useful when building a volume from DICOM slices.

Errors

Returns VolumeError if any slice has the wrong length or inputs are invalid.

pub fn get(&self, x: u32, y: u32, z: u32) -> Option<T>

Direct voxel access by integer index (component 0).

Returns None if any index is out of bounds.

pub fn sample_linear(&self, ijk: DVec3) -> Option<f64>

Sample with trilinear interpolation at a continuous voxel index.

Returns None if the index falls outside [0, dims-1] on any axis. Only samples the first component for multi-component volumes.

pub fn sample_nearest(&self, ijk: DVec3) -> Option<T>

Sample nearest-neighbour at a continuous voxel index.

Returns None if the index falls outside the volume.

pub fn scalar_range(&self) -> (f64, f64)

Compute the (min, max) scalar range of all voxels.

The result is computed once and cached.

pub fn as_bytes(&self) -> &[u8]

Raw byte slice of the voxel data, suitable for GPU upload.

pub fn data(&self) -> &[T]

Borrow the typed scalar buffer.

Trait Implementations

impl<T: Clone + Scalar> Clone for Volume<T>

fn clone(&self) -> Volume<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Scalar> Debug for Volume<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Volume<f32>> for DynVolume

fn from(v: Volume<f32>) -> Self

Converts to this type from the input type.

impl From<Volume<f64>> for DynVolume

fn from(v: Volume<f64>) -> Self

Converts to this type from the input type.

impl From<Volume<i16>> for DynVolume

fn from(v: Volume<i16>) -> Self

Converts to this type from the input type.

impl From<Volume<i32>> for DynVolume

fn from(v: Volume<i32>) -> Self

Converts to this type from the input type.

impl From<Volume<i8>> for DynVolume

fn from(v: Volume<i8>) -> Self

Converts to this type from the input type.

impl From<Volume<u16>> for DynVolume

fn from(v: Volume<u16>) -> Self

Converts to this type from the input type.

impl From<Volume<u32>> for DynVolume

fn from(v: Volume<u32>) -> Self

Converts to this type from the input type.

impl From<Volume<u8>> for DynVolume

fn from(v: Volume<u8>) -> Self

Converts to this type from the input type.

impl<T: Scalar> VolumeInfo for Volume<T>

fn dimensions(&self) -> UVec3

Number of voxels along each axis: [nx, ny, nz].

fn spacing(&self) -> DVec3

Physical size of each voxel in world units (typically millimetres).

fn origin(&self) -> DVec3

World-space position of voxel (0, 0, 0).

fn direction(&self) -> DMat3

3×3 orientation matrix whose columns are the axis directions. For axis-aligned volumes this is the identity matrix.

fn components(&self) -> u32

Number of scalar values stored per voxel (1 for grayscale).

fn index_to_world(&self, ijk: DVec3) -> DVec3

Convert a continuous voxel index (i, j, k) to world coordinates.

fn world_to_index(&self, xyz: DVec3) -> DVec3

Convert world coordinates to a continuous voxel index.

fn world_bounds(&self) -> Aabb

Axis-aligned bounding box enclosing all voxel centres in world space.