soundgen (version 2.3.0)

getFormantDispersion: Get formant dispersion

Description

Internal soundgen function.

Usage

getFormantDispersion(
  formants,
  method = c("meanDispersion", "regression")[2],
  interceptZero = TRUE,
  speedSound = 35400,
  plot = FALSE,
  checkFormat = TRUE,
  output = c("simple", "detailed")[1]
)

Arguments

formants

formant frequencies in any format recognized by soundgen: a character string like aaui referring to default presets for speaker "M1"; a vector of formant frequencies like c(550, 1600, 3200); or a list with multiple values per formant like list(f1 = c(500, 550), f2 = 1200))

method

the method of estimating vocal tract length (see details)

interceptZero

if TRUE, forces the regression curve to pass through the origin, which corresponds to a closed-open tube (method = "regression" only)

speedSound

speed of sound in warm air, by default 35400 cm/s. Stevens (2000) "Acoustic phonetics", p. 138

plot

if TRUE, plots the regression line whose slope gives formant dispersion (method = "regression" only) and Label size shows the influence of each observation; the second plot shows how VTL varies depending on the number of formants used

checkFormat

if FALSE, only a list of properly formatted formant frequencies is accepted

output

"simple" (default) = just the VTL; "detailed" = a list of additional stats (see Value below)

Details

Estimates formant dispersion based on one or more formant frequencies.

Examples

# NOT RUN {
soundgen:::getFormantDispersion(
  list(f1 = c(570, 750), f2 = NA, f3 = c(2400, 2200, NA)))
# }