forcePerPath: Force per path

View source: R/utilities_pitch_postprocessing.R

forcePerPathR Documentation

Force per path

Description

Internal soundgen function.

Usage

forcePerPath(pitch, pitchCands, pitchCert, pitchCenterGravity, certWeight)

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 (the last row is always "manual")

pitchCert

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

pitchCenterGravity

numeric vector giving the mean of all pitch candidates per fft frame weighted by our certainty in each of these 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

Details

Internal helper function for postprocessing of pitch contour. Returns the total force acting on a snake (sum of internal and external gradients, i.e. of the elastic force trying to straighten the snake [internal] and of the force pushing the snake towards the most certain pitch estimates [external])

Value

Returns a numeric vector of the same length as pitch that gives the total force acting on the snake at each point.


soundgen documentation built on Aug. 14, 2022, 5:05 p.m.