Struct Kernel3D 

pub struct Kernel3D { /* private fields */ }

3D point-spread function stored as a (depth, height, width) f32 array.

Constructors copy data into standard layout and reject empty or non-finite arrays. Use Kernel3D::normalized when the PSF should sum to 1.

Implementations

impl Kernel3D

pub fn new(data: Array3<f32>) -> Result<Self>

Build a 3D kernel from (depth, height, width) samples.

The data is copied into standard layout.

Errors

Returns Error::InvalidPsf for empty arrays and Error::NonFiniteInput for NaN or infinite samples.

pub fn as_array(&self) -> &Array3<f32>

Borrow the underlying (depth, height, width) array.

pub fn into_inner(self) -> Array3<f32>

Consume the kernel and return its owned array.

pub fn dims(&self) -> (usize, usize, usize)

Return (depth, height, width).

pub fn sum(&self) -> f32

Sum all kernel samples.

pub fn is_finite(&self) -> bool

Return whether every sample is finite.

pub fn normalize(&mut self) -> Result<()>

Normalize the kernel in place so its sum is 1.

Errors

Returns Error::InvalidPsf when the kernel sum is non-finite or too close to zero.

pub fn normalized(&self) -> Result<Self>

Return a normalized copy of this kernel.

Errors

Returns Error::InvalidPsf when the kernel sum is non-finite or too close to zero.

Trait Implementations

impl Clone for Kernel3D

fn clone(&self) -> Kernel3D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Kernel3D

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

Formats the value using the given formatter.

impl PartialEq for Kernel3D

fn eq(&self, other: &Kernel3D) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Kernel3D