snake: Snake

Description Usage Arguments Details Value

View source: R/utilities_pitch_postprocessing.R

Description

Internal soundgen function.

Usage

1
2
snake(pitch, pitchCands, pitchCert, certWeight, pitchCenterGravity,
  snakeStep = 0.05, snakePlot = FALSE)

Arguments

pitch

numeric vector representing our best guess at pitch contour, which we are now attempting to improve by minimizing its elastic tension

pitchCands

a matrix of multiple pitch candidates per fft frame. Each column is one fft frame, each row is one candidate.

pitchCert

a matrix of the same dimensionality as pitchCands specifying our certainty in pitch candidates

certWeight

(0 to 1) in pitch postprocessing, specifies how much we prioritize the certainty of pitch candidates vs. pitch jumps / the internal tension of the resulting pitch curve

pitchCenterGravity

numeric vector giving the mean of all pitch candidates per fft frame weighted by our certainty in each of these candidates

snakeStep

optimized path through pitch candidates is further processed to minimize the elastic force acting on pitch contour. To disable, set snakeStep to NULL

snakePlot

if TRUE, plots the snake

Details

Internal helper function for postprocessing of pitch contour. Wiggles a snake along the gradient of internal + external forces. NB: if the snake is run, the final contour may deviate from the actually measured pitch candidates!

Value

Returns optimized pitch contour (numeric vector of the same length as pitch).


soundgen documentation built on Oct. 4, 2018, 9:04 a.m.