Enum BoundaryTreatment

pub enum BoundaryTreatment {
    Lower,
    Upper,
    Average(f64),
}

Method variants for dealing with a Point on boundaries

Leaving the treatment of a Point on a voxel boundary to the user’s imagination is a bad idea. Providing a variant of this type forces the behaviour to be explicit.

The variants may be:

• Lower - ON the boundary returns the lower voxel result
• Upper - ON the boundary returns the higher voxel result
• Average - NEAR the boundary returns average of both voxels

For example, if the x-bounds of two voxels were [1.0, 2.0, 3.0] and you specified x=2.0: > lower => (1.0 < x <= 2.0), choose voxel 0 > upper => (2.0 <= x < 3.0), choose voxel 1 > average, tol=0.1 => (1.9 < x < 2.1), average both

Boundary cases are special and will be included for each extreme. For example, Upper will return the last voxel for exactly 3.0 in this case.

Variants

Lower

Values exactly on a boundary return the lower voxel

Upper

Values exactly on a boundary return the higher voxel

Average(f64)

Values within a tolerance of a boundary return an average of both voxels

Trait Implementations

impl Clone for BoundaryTreatment

fn clone(&self) -> BoundaryTreatment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundaryTreatment

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

Formats the value using the given formatter.

impl Default for BoundaryTreatment

fn default() -> BoundaryTreatment

Returns the “default value” for a type.

impl Display for BoundaryTreatment

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

Formats the value using the given formatter.

impl PartialEq for BoundaryTreatment

fn eq(&self, other: &BoundaryTreatment) -> 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 Copy for BoundaryTreatment

impl StructuralPartialEq for BoundaryTreatment