Struct MaskHandle 

pub struct MaskHandle { /* private fields */ }

Processed mask image with optional further refinement and output generation.

Represents a concrete mask image (typically binary after thresholding) produced by executing operations from a crate::MatteHandle.

Example

use outline::Outline;

let outline = Outline::new("model.onnx");
let session = outline.for_image("input.jpg")?;
let mask = session.matte().blur().threshold().processed()?;

// Generate multiple outputs from the mask
mask.save("mask.png")?;
mask.foreground()?.save("subject.png")?;

To trace the mask into SVG, pass a MaskVectorizer implementation to MaskHandle::trace. The crate re-exports VtracerSvgVectorizer when the vectorizer-vtracer feature is enabled.

Implementations

impl MaskHandle

pub fn to_raw_mask(&self) -> GrayImage

Clone and return the raw mask.

pub fn as_raw_mask(&self) -> &GrayImage

Get a reference to the raw mask.

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

Return the current mask canvas dimensions.

pub fn raw(&self) -> GrayImage

👎Deprecated:

use to_raw_mask()

Get the raw mask.

pub fn image(&self) -> &GrayImage

👎Deprecated:

use as_raw_mask()

Get a reference to the raw mask.

pub fn into_image(self) -> GrayImage

Consume the handle and return the current mask.

pub fn save(&self, path: impl AsRef<Path>) -> OutlineResult<()>

Save the current mask to the specified path.

pub fn bounding_box(&self) -> Option<BoundingBox>

Compute the bounding box of the current mask using a non-zero threshold.

pub fn bounding_box_with(&self, threshold: u8) -> Option<BoundingBox>

Compute the bounding box of the current mask at or above threshold.

pub fn blur(self) -> Self

Add a blur operation using the default sigma.

Panics

Panics if the configured default blur sigma is not greater than zero.

pub fn blur_with(self, sigma: f32) -> Self

Add a blur operation with a custom sigma.

Panics

Panics if sigma is not greater than zero.

pub fn threshold(self) -> Self

Add a threshold operation using the default mask threshold.

pub fn threshold_with(self, value: u8) -> Self

Add a threshold operation with a custom value.

pub fn dilate(self) -> Self

Add a dilation operation using the default radius.

Note: Dilation typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

A radius of zero leaves the mask unchanged.

Panics

Panics if the configured default dilation radius is negative or NaN.

pub fn dilate_with(self, radius: f32) -> Self

Add a dilation operation with a custom radius.

Note: Dilation typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

A radius of zero leaves the mask unchanged.

Panics

Panics if radius is negative or NaN.

pub fn erode(self) -> Self

Add an erosion operation using the default radius.

Note: Erosion typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

A radius of zero leaves the mask unchanged.

Panics

Panics if the configured default erosion radius is negative or NaN.

pub fn erode_with(self, radius: f32) -> Self

Add an erosion operation with a custom radius.

Note: Erosion typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

A radius of zero leaves the mask unchanged.

Panics

Panics if radius is negative or NaN.

pub fn erode_with_border_mode( self, radius: f32, border_mode: ErosionBorderMode, ) -> Self

Add an erosion operation with a custom radius and boundary behavior.

Note: Erosion typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

A radius of zero leaves the mask unchanged.

Panics

Panics if radius is negative or NaN.

pub fn fill_holes(self) -> Self

Add a hole-filling operation to the processing pipeline.

Note: Hole-filling typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

pub fn fill_holes_with(self, threshold: u8) -> Self

Add a hole-filling operation with a custom threshold.

Note: Hole-filling typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

pub fn keep_largest_component(self) -> Self

Keep only the largest connected foreground component.

Note: Component filtering typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

pub fn keep_n_largest_components(self, count: usize) -> Self

Keep the largest count connected foreground components.

Note: Component filtering typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

pub fn drop_components_below_area(self, min_area: f32) -> Self

Drop connected foreground components below min_area pixels.

Note: Component filtering typically works best on binary masks. If this mask is still grayscale, consider calling threshold first.

Panics

Panics if min_area is negative or NaN.

pub fn processed(self) -> OutlineResult<MaskHandle>

Process the mask with the accumulated operations.

pub fn processed_with( self, pipeline: &MaskPipeline, ) -> OutlineResult<MaskHandle>

Process the mask with the accumulated operations and a custom pipeline.

pub fn foreground(&self) -> OutlineResult<ForegroundHandle>

Compose the RGBA foreground image from the RGB image and the current mask.

pub fn colorize(&self, color: impl Into<MaskColor>) -> RgbaImage

Colorize the current mask into a flat-color RGBA image.

pub fn trace<V>( &self, vectorizer: &V, options: &V::Options, ) -> OutlineResult<V::Output>

where V: MaskVectorizer,

Trace the current mask using the specified vectorizer and options.

pub fn pad(self, padding: impl Into<Padding>) -> Self

Expand the mask canvas by the given padding while keeping content at the same offset.

Any pending mask operations are applied before padding so method call order is preserved. The underlying RGB canvas is padded with black to keep foreground aligned with the mask.

pub fn crop(self, bounds: BoundingBox) -> Option<Self>

Crop the mask and source RGB image to bounds.

Returns None when bounds is empty or outside the current mask canvas.

pub fn crop_to_content(self) -> Option<Self>

Crop the mask and source RGB image to the smallest non-zero content box.

Returns None when the current mask has no non-zero pixels.

pub fn crop_to_content_with(self, threshold: u8) -> Option<Self>

Crop the mask and source RGB image to the smallest content box at or above threshold.

Returns None when the current mask has no pixels at or above threshold.

Trait Implementations

impl Clone for MaskHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaskHandle

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

Formats the value using the given formatter.