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 MatteHandle.

Example

use outline::{Outline, VtracerSvgVectorizer, TraceOptions};

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")?;

let vectorizer = VtracerSvgVectorizer;
let svg = mask.trace(&vectorizer, &TraceOptions::default())?;
std::fs::write("outline.svg", svg)?;

Implementations

impl MaskHandle

pub fn raw(&self) -> GrayImage

Get the raw mask.

pub fn image(&self) -> &GrayImage

Get a reference to the mask.

pub fn into_image(self) -> GrayImage

Consume the handle and return the mask.

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

Save the mask to the specified path.

pub fn blur(self) -> Self

Add a blur operation using the default sigma.

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

Add a blur operation with a custom sigma.

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.

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.

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 processed(self) -> OutlineResult<MaskHandle>

Process the mask with the accumulated operations and default options.

pub fn processed_with( self, options: &MaskProcessingOptions, ) -> OutlineResult<MaskHandle>

Process the mask with the accumulated operations and custom options.

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

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

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.

Trait Implementations

impl Clone for MaskHandle

fn clone(&self) -> MaskHandle

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.