Struct PlanarMask

pub struct PlanarMask { /* private fields */ }

A dense row-major boolean mask aligned with a field’s cell grid.

Implementations

impl PlanarMask

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

Construct an all-false mask.

pub fn from_field(field: &LayeredField, channel: FieldChannel) -> Self

Derive a mask from one channel of a field.

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

Mask dimensions.

pub fn count(&self) -> usize

Number of set cells.

pub fn get(&self, x: usize, y: usize) -> Option<bool>

Read a cell, or None when outside the mask.

pub fn set( &mut self, x: usize, y: usize, value: bool, ) -> Result<(), LayeredFieldError>

Write a cell.

pub fn inverted(&self) -> Self

Set-complement.

pub fn intersect(&self, other: &Self) -> Result<Self, LayeredFieldError>

Set-intersection with an identically sized mask.

pub fn dilate( &self, config: &FieldConfig, radius: Scalar, ) -> Result<Self, LayeredFieldError>

Metric dilation by radius in local units.

The radius is converted to a cell count by ceiling division on the configured cell size, so the result never under-covers the requested distance. A zero radius is the identity.

pub fn erode( &self, config: &FieldConfig, radius: Scalar, ) -> Result<Self, LayeredFieldError>

Metric erosion by radius in local units.

pub fn connected_components(&self) -> ComponentLabels

Label 4-connected components of set cells.

Labels are assigned in row-major discovery order, so the labelling is stable across runs.

Trait Implementations

impl Clone for PlanarMask

fn clone(&self) -> PlanarMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlanarMask

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

Formats the value using the given formatter.

impl PartialEq for PlanarMask

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

impl StructuralPartialEq for PlanarMask