.analyze  R Documentation 
Internal soundgen function
.analyze(
audio,
dynamicRange = 80,
silence = 0.04,
windowLength = 50,
step = 25,
overlap = 50,
specType = c("spectrum", "reassign", "spectralDerivative")[1],
wn = "gaussian",
zp = 0,
cutFreq = NULL,
nFormants = 3,
formants = NULL,
loudness = NULL,
roughness = NULL,
novelty = NULL,
pitchMethods = c("dom", "autocor"),
pitchManual_list = NULL,
entropyThres = 0.6,
pitchFloor = 75,
pitchCeiling = 3500,
priorMean = 300,
priorSD = 6,
priorAdapt = TRUE,
nCands = 1,
minVoicedCands = NULL,
pitchDom = list(domThres = 0.1, domSmooth = 220),
pitchAutocor = list(autocorThres = 0.7, autocorSmooth = 7, autocorUpsample = 25,
autocorBestPeak = 0.975),
pitchCep = list(cepThres = 0.75, cepZp = 0),
pitchSpec = list(specThres = 0.05, specPeak = 0.25, specHNRslope = 0.8, specSmooth =
150, specMerge = 0.1, specSinglePeakCert = 0.4, specRatios = 3),
pitchHps = list(hpsNum = 5, hpsThres = 0.1, hpsNorm = 2, hpsPenalty = 2),
pitchZc = list(zcThres = 0.1, zcWin = 5),
harmHeight = list(harmThres = 3, harmTol = 0.25, harmPerSel = 5),
subh = list(method = c("cep", "pitchCands", "harm")[1], nSubh = 5, tol = 0.05, nHarm =
5, harmThres = 12, harmTol = 0.25, amRange = c(10, 200)),
flux = list(thres = 0.15, smoothWin = 100),
amRange = c(10, 200),
fmRange = c(5, 1000/step/2),
shortestSyl = 20,
shortestPause = 60,
interpol = NULL,
pathfinding = c("none", "fast", "slow")[2],
annealPars = list(maxit = 5000, temp = 1000),
certWeight = 0.5,
snakeStep = 0,
snakePlot = FALSE,
smooth = 1,
smoothVars = c("pitch", "dom"),
returnPitchCands = FALSE,
plot = TRUE,
showLegend = TRUE,
osc = "linear",
pitchPlot = list(col = rgb(0, 0, 1, 0.75), lwd = 3, showPrior = TRUE),
pitchDom_plotPars = list(),
pitchAutocor_plotPars = list(),
pitchCep_plotPars = list(),
pitchSpec_plotPars = list(),
pitchHps_plotPars = list(),
pitchZc_plotPars = list(),
extraContour = NULL,
ylim = NULL,
xlab = NULL,
ylab = NULL,
main = NULL,
width = 900,
height = 500,
units = "px",
res = NA,
...
)
audio 
a list returned by 
dynamicRange 
dynamic range, dB. All values more than one dynamicRange under maximum are treated as zero 
silence 
(0 to 1 as proportion of max amplitude) frames with RMS
amplitude below 
windowLength 
length of FFT window, ms 
step 
you can override 
overlap 
overlap between successive FFT frames, % 
specType 
plot the original FFT ('spectrum'), reassigned spectrogram ('reassigned'), or spectral derivative ('spectralDerivative') 
wn 
window type accepted by 
zp 
window length after zero padding, points 
cutFreq 
if specified, spectral descriptives (peakFreq, specCentroid,
specSlope, and quartiles) are calculated only between 
nFormants 
the number of formants to extract per STFT frame (0 = no formant analysis, NULL = as many as possible) 
formants 
a list of arguments passed to

loudness 
a list of parameters passed to 
roughness 
a list of parameters passed to

novelty 
a list of parameters passed to 
pitchMethods 
methods of pitch estimation to consider for determining pitch contour: 'autocor' = autocorrelation (~PRAAT), 'cep' = cepstral, 'spec' = spectral (~BaNa), 'dom' = lowest dominant frequency band, 'hps' = harmonic product spectrum, NULL = no pitch analysis 
entropyThres 
pitch tracking is only performed for frames with Weiner
entropy below 
pitchFloor, pitchCeiling 
absolute bounds for pitch candidates (Hz) 
priorMean, priorSD 
specifies the mean (Hz) and standard deviation
(semitones) of gamma distribution describing our prior knowledge about the
most likely pitch values for this file. For ex., 
priorAdapt 
adaptive secondpass prior: if TRUE, optimal pitch contours
are estimated first with a prior determined by 
nCands 
maximum number of pitch candidates per method, normally 1...4
(except for 
minVoicedCands 
minimum number of pitch candidates that have to be
defined to consider a frame voiced (if NULL, defaults to 2 if 
pitchDom 
a list of control parameters for pitch tracking using the
lowest dominant frequency band or "dom" method; see details and

pitchAutocor 
a list of control parameters for pitch tracking using the
autocorrelation or "autocor" method; see details and

pitchCep 
a list of control parameters for pitch tracking using the
cepstrum or "cep" method; see details and 
pitchSpec 
a list of control parameters for pitch tracking using the
BaNa or "spec" method; see details and 
pitchHps 
a list of control parameters for pitch tracking using the
harmonic product spectrum or "hps" method; see details and

pitchZc 
a list of control parameters for pitch tracking based on zero
crossings in bandpassfiltered audio or "zc" method; see

harmHeight 
a list of control parameters for estimating how high
harmonics reach in the spectrum; see details and 
subh 
a list of control parameters for estimating the strength of
subharmonics per frame  that is, spectral energy at integer ratios of f0:
see 
flux 
a list of control parameters for calculating featurebased flux
(not spectral flux) passed to 
amRange 
target range of frequencies for amplitude modulation, Hz: a
vector of length 2 (affects both 
fmRange 
target range of frequencies for analyzing frequency
modulation, Hz ( 
shortestSyl 
the smallest length of a voiced segment (ms) that constitutes a voiced syllable (shorter segments will be replaced by NA, as if unvoiced) 
shortestPause 
the smallest gap between voiced syllables (ms): large value = interpolate and merge, small value = treat as separate syllables separated by an unvoiced gap 
interpol 
a list of parameters (currently 
pathfinding 
method of finding the optimal path through pitch
candidates: 'none' = best candidate per frame, 'fast' = simple heuristic,
'slow' = annealing. See 
annealPars 
a list of control parameters for postprocessing of
pitch contour with SANN algorithm of 
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 
snakeStep 
optimized path through pitch candidates is further
processed to minimize the elastic force acting on pitch contour. To
disable, set 
snakePlot 
if TRUE, plots the snake 
smooth, smoothVars 
if 
plot 
if TRUE, produces a spectrogram with pitch contour overlaid 
showLegend 
if TRUE, adds a legend with pitch tracking methods 
osc 
"none" = no oscillogram; "linear" = on the original scale; "dB" = in decibels 
pitchPlot 
a list of graphical parameters for displaying the final
pitch contour. Set to 
extraContour 
name of an output variable to overlap on the pitch
contour plot, eg 'peakFreq' or 'loudness'; can also be a list with extra
graphical parameters, eg 
ylim 
frequency range to plot, kHz (defaults to 0 to Nyquist frequency). NB: still in kHz, even if yScale = bark, mel, or ERB 
xlab, ylab, main 
plotting parameters 
width, height, units, res 
parameters passed to

... 
other graphical parameters passed to 
Called by analyze
and pitch_app
to analyze a
single sound.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.