costPerPath: Cost per path

View source: R/pitch_postprocessing.R

costPerPathR Documentation

Cost per path

Description

Internal soundgen function.

Usage

costPerPath(
  path,
  pitchCands,
  pitchCert,
  certWeight,
  pitchCenterGravity,
  manual = NULL
)

Arguments

path

evaluated path through pitch candidates (as integers specifying the rows in pitchCands, not the actual values of pitch)

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

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

manual

a dataframe of manual pitch candidates from pathfinder()

Details

Internal helper function for postprocessing of pitch contours called by pathfinding_slow. Calculates the cost of a particular path through pitch candidates based on pitch jumps and distance from high-certainty candidates.


soundgen documentation built on Sept. 12, 2024, 6:29 a.m.