Struct PYINExecutor 

pub struct PYINExecutor<A>
where
    A: Float + FloatConst + FftNum + Add + Sub + Mul + MulAssign + DivAssign + NumAssign + ScalarOperand + MaybeNan + AbsDiffEq<Epsilon = A>,
    <A as MaybeNan>::NotNan: Ord,
{ /* private fields */ }

pYIN algorithm executor.

It’s generic over the input type, which can bef32 or f64. It contains memory for the FFTs and some reusable constants. The new() method creates a new instance, and the pyin() method executes the algorithm.

Implementations

impl<A> PYINExecutor<A>

where A: Float + FloatConst + FftNum + Add + Sub + Mul + MulAssign + DivAssign + NumAssign + ScalarOperand + MaybeNan + AbsDiffEq<Epsilon = A>, <A as MaybeNan>::NotNan: Ord,

pub fn set_boltzmann_parameter(&mut self, val: f64) -> &mut Self

shape parameter for the Boltzmann distribution prior over troughs. Larger values will assign more mass to smaller periods. (default: 2.0)

pub fn set_no_trough_prob(&mut self, val: A) -> &mut Self

maximum probability to add to global minimum if no trough is below threshold. (default: 0.01)

impl<A> PYINExecutor<A>

where A: Float + FloatConst + FftNum + Add + Sub + Mul + MulAssign + DivAssign + NumAssign + ScalarOperand + MaybeNan + AbsDiffEq<Epsilon = A>, <A as MaybeNan>::NotNan: Ord,

pub fn n_thresholds(&self) -> usize

number of thresholds for peak estimation. (always returns 100)

pub fn beta_parameters(&self) -> (f64, f64)

shape parameters for the beta distribution prior over thresholds. (always returns (2.0, 18.0))

pub fn boltzmann_parameter(&self) -> f64

shape parameter for the Boltzmann distribution prior over troughs. Larger values will assign more mass to smaller periods. (default: 2.0)

pub fn max_transition_rate(&self) -> f64

maximum pitch transition rate in octaves per second. (always returns 35.92)

pub fn switch_prob(&self) -> A

probability of switching from voiced to unvoiced or vice versa. (always returns 0.01)

pub fn no_trough_prob(&self) -> A

maximum probability to add to global minimum if no trough is below threshold. (default: 0.01)

impl<A> PYINExecutor<A>

where A: Float + FloatConst + FftNum + Add + Sub + Mul + MulAssign + DivAssign + NumAssign + ScalarOperand + MaybeNan + AbsDiffEq<Epsilon = A>, <A as MaybeNan>::NotNan: Ord,

pub fn new( fmin: f64, fmax: f64, sr: u32, frame_length: usize, win_length: Option<usize>, hop_length: Option<usize>, resolution: Option<f64>, ) -> Self

Create a new PYIN executor instance.

Arguments

• fmin - minimum frequency in Hz
• fmax - maximum frequency in Hz
• sr - sampling rate in Hz
• frame_length - frame length in samples
• win_length - length of the window for calculating autocorrelation in samples. (If None, defaults to frame_length/2)
• hop_length - number of audio samples between adjacent pYIN predictions. (If None, defaults to frame_length/4)
• resolution - Resolution of the pitch bins. should be 0 < resolution < 1. 0.01 corresponds to cents.(If None, defaults to 0.1)

pub fn pyin( &mut self, wav: &[A], fill_unvoiced: A, framing: Framing<A>, ) -> (Vec<f64>, Vec<A>, Vec<bool>, Vec<A>)

Execute pYIN algorithm.

Arguments

• wav - audio signal
• fill_unvoiced - value to fill unvoiced frames. Typically, it is 0.0 or <A as Float>::nan().
• framing - where the first frame starts. Refer to Framing

Returns

(timestamp: Array1<f64>, f0: Array1<A>, voiced_flag: Array1<bool>, voiced_prob: Array1<A>)

• timestamp - contains the timestamp (in seconds) of each frames
• f0 - contains estimated pitch in Hz. (If unvoiced, it is fill_unvoiced.)
• voiced_flag - contains whether each frame is voiced or unvoiced.
• voiced_prob - contains probability of each frame being voiced.

pub fn frame_to_sec(&self, i_frame: usize) -> f64

Trait Implementations

impl<A> Clone for PYINExecutor<A>

where A: Float + FloatConst + FftNum + Add + Sub + Mul + MulAssign + DivAssign + NumAssign + ScalarOperand + MaybeNan + AbsDiffEq<Epsilon = A> + Clone, <A as MaybeNan>::NotNan: Ord,

fn clone(&self) -> PYINExecutor<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.