Struct DisplacementField 

pub struct DisplacementField {
    pub field: Vec<f64>,
    pub dims: Vec<usize>,
    pub n_components: usize,
}

A dense displacement (vector) field over a 2D or 3D domain.

For a 2D domain of shape (rows, cols) the field has shape (rows, cols, 2) where the last dimension carries [dy, dx] displacements in pixels.

For a 3D domain (nz, ny, nx) the shape is (nz, ny, nx, 3) with [dz, dy, dx].

Fields

field: Vec<f64>

Displacement vectors; shape [..dims.., n_components].

dims: Vec<usize>

Spatial dimensions of the domain (e.g., [rows, cols] or [nz, ny, nx]).

n_components: usize

Number of vector components (2 for 2D, 3 for 3D).

Implementations

impl DisplacementField

pub fn zeros_2d(rows: usize, cols: usize) -> DisplacementField

Create a zero displacement field for a 2D domain.

pub fn zeros_3d(nz: usize, ny: usize, nx: usize) -> DisplacementField

Create a zero displacement field for a 3D domain.

pub fn num_voxels(&self) -> usize

Total number of spatial voxels / pixels.

pub fn get_2d(&self, r: usize, c: usize) -> Result<[f64; 2], NdimageError>

Access the displacement vector at pixel (r, c) for a 2D field.

Returns [dy, dx].

pub fn set_2d( &mut self, r: usize, c: usize, dy: f64, dx: f64, ) -> Result<(), NdimageError>

Set the displacement vector at pixel (r, c) for a 2D field.

pub fn get_3d( &self, iz: usize, iy: usize, ix: usize, ) -> Result<[f64; 3], NdimageError>

Access the displacement vector at voxel (iz, iy, ix) for a 3D field.

Returns [dz, dy, dx].

pub fn compose_2d( &self, other: &DisplacementField, ) -> Result<DisplacementField, NdimageError>

Compose two displacement fields: result(x) = self(x) + other(x + self(x)).

Currently supports only 2D fields.

pub fn gaussian_smooth_2d(&mut self, sigma: f64) -> Result<(), NdimageError>

Apply a Gaussian smoothing kernel to the displacement field in-place.

Only 2D fields are supported. sigma is in pixels.

pub fn rms_magnitude(&self) -> f64

Root-mean-square magnitude of the displacement vectors.

Trait Implementations

impl Clone for DisplacementField

fn clone(&self) -> DisplacementField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplacementField

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

Formats the value using the given formatter.