Struct Mask

Source

pub struct Mask { /* private fields */ }

Expand description

A mask represents a 2D image that can be used to filter out points

§Example

use vegas_lattice::Mask;
use std::path::Path;

let mask = Mask::try_new(Path::new("docs/bpm.png"), 1.0).unwrap();
let keep = mask.keep(0.5, 0.5, &mut rand::rng());

assert!(keep || !keep);

Implementations§

Source §

impl Mask

Source

pub fn try_new(path: &Path, ppu: f64) -> Result<Self, VegasLatticeError>

Create a new mask from a path and a pixels per unit ratio

Source

pub fn keep<R: Rng + ?Sized>(&self, x: f64, y: f64, rng: &mut R) -> bool

Computes wheter to keep a site or not given the coordinates of the site and a random number generator.

Auto Trait Implementations§

§

impl UnwindSafe for Mask

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §