Enum WindowShape 

pub enum WindowShape {
    Rectangular {
        width: usize,
        height: usize,
    },
    Circular {
        radius: f64,
    },
    Custom {
        mask: Vec<bool>,
        width: usize,
        height: usize,
    },
}

Window shape for focal operations

Variants

Rectangular

Rectangular window with given width and height (must be odd)

Fields

width: usize

height: usize

Circular

Circular window with given radius

Fields

radius: f64

Custom

Custom window defined by a binary mask (1 = include, 0 = exclude)

Fields

mask: Vec<bool>

width: usize

height: usize

Implementations

impl WindowShape

pub fn rectangular(width: usize, height: usize) -> Result<Self>

Creates a rectangular window

Arguments

• width - Window width (must be odd)
• height - Window height (must be odd)

Errors

Returns an error if width or height is even or zero

pub fn circular(radius: f64) -> Result<Self>

Creates a circular window

Arguments

• radius - Window radius (must be positive)

Errors

Returns an error if radius is not positive

pub fn custom(mask: Vec<bool>, width: usize, height: usize) -> Result<Self>

Creates a custom window from a binary mask

Arguments

• mask - Binary mask (true = include pixel)
• width - Mask width
• height - Mask height

Errors

Returns an error if dimensions don’t match mask size or are even

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

Gets the window dimensions

pub fn includes(&self, dx: i64, dy: i64) -> bool

Checks if a pixel at given offset is included in the window

pub fn offsets(&self) -> Vec<(i64, i64)>

Returns all offsets included in the window

pub fn cell_count(&self) -> usize

Returns the number of cells in the window

Trait Implementations

impl Clone for WindowShape

fn clone(&self) -> WindowShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowShape

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

Formats the value using the given formatter.

impl PartialEq for WindowShape

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