Struct MaskParams 

pub struct MaskParams { /* private fields */ }

Settings of the harmonic masks.

The mask of note n at frequency f and time t is M_n(f, t) = sum_{h=1..H} exp(-(f - h f_n(t))^2 / (2 sigma^2)), where f_n(t) follows the note’s contour. A cell lies inside a mask when the value reaches the threshold.

Implementations

impl MaskParams

pub fn new() -> Self

20 harmonics, sigma of one unpadded bin, fs / frame_len, and a threshold of exp(-2), the mask value two sigma from a harmonic. That covers the 4-bin main lobe of a Hann window. Zero padding narrows the bins but not the lobe, so sigma ignores the padding.

pub fn with_harmonics(self, harmonics: usize) -> Self

Sets the number of harmonics H. Harmonics at or above the Nyquist frequency are skipped.

pub fn with_sigma(self, sigma: Hz) -> Self

Sets sigma, for example to the unison spread when it is known.

pub fn with_threshold(self, threshold: Normalized) -> Self

Sets the mask value a cell needs to count as inside.

Trait Implementations

impl Clone for MaskParams

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaskParams

impl Debug for MaskParams

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

Formats the value using the given formatter.

impl Default for MaskParams

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for MaskParams

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MaskParams