Struct BinaryMask 

pub struct BinaryMask { /* private fields */ }

Validated binary mask (0 background, 1 foreground).

Implementations

impl BinaryMask

pub fn try_new( width: usize, height: usize, data: Vec<u8>, ) -> Result<BinaryMask, VisionError>

Creates a mask and rejects values other than zero and one.

pub fn from_threshold( input: ImageView<'_, f32, 1>, threshold: f32, ) -> Result<BinaryMask, VisionError>

Thresholds a float score image into a binary mask.

pub const fn width(&self) -> usize

Returns mask width.

pub const fn height(&self) -> usize

Returns mask height.

pub fn image(&self) -> &Image<u8, 1>

Borrows the underlying image.

pub fn view(&self) -> ImageView<'_, u8, 1>

Borrows a mask view.

pub fn contains(&self, x: usize, y: usize) -> bool

Returns whether one pixel is foreground.

pub fn area(&self) -> usize

Counts foreground pixels.

pub fn into_image(self) -> Image<u8, 1>

Consumes the wrapper and returns its image.

Trait Implementations

impl Clone for BinaryMask

fn clone(&self) -> BinaryMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryMask

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

Formats the value using the given formatter.

impl PartialEq for BinaryMask

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

impl StructuralPartialEq for BinaryMask