Internal soundgen function called by getSurprisal.
.getSurprisal(
audio,
winSurp,
input = c("audSpec", "spec", "env")[1],
audSpec_pars = list(filterType = "butterworth", nFilters = 32, step = 20, yScale =
"bark"),
spec_pars = list(windowLength = c(5, 40), step = NULL),
env_pars = list(windowLength = 40, step = 20),
method = c("acf", "np")[1],
sameLagAllFreqs = TRUE,
weightByAmpl = TRUE,
rescale = FALSE,
plot = TRUE,
whatToPlot = c("surprisal", "surprisalLoudness")[1],
osc = c("none", "linear", "dB")[2],
heights = c(3, 1),
ylim = NULL,
contrast = 0.2,
brightness = 0,
maxPoints = c(1e+05, 5e+05),
padWithSilence = TRUE,
colorTheme = c("bw", "seewave", "heat.colors", "...")[1],
col = NULL,
extraContour = NULL,
xlab = NULL,
ylab = NULL,
xaxp = NULL,
mar = c(5.1, 4.1, 4.1, 2),
main = NULL,
grid = NULL,
width = 900,
height = 500,
units = "px",
res = NA,
...
)surprisal analysis window, ms (Inf = from sound onset to each point)
audSpec = auditory spectrogram
(audSpectrogram, speed ~= 0.4x), spec = ordinary STFT
spectrogram (spectrogram, speed ~= 0.25x), env =
analytic envelope (getRMS, speed ~= 33x)
a list of parameters passed to
audSpectrogram (if input = 'audSpec'),
spectrogram (if input = 'spec'), or getRMS (if
input = 'env')
acf = change in maximum autocorrelation after adding the final
point, np = nonlinear prediction (see nonlinPred - works but
is VERY slow)
(only for method = 'acf') if TRUE, the best_lag is calculated by averaging the ACFs of all channels, and the same best_lag is used to calculate the surprisal in each frequency channel (we expect the same "rhythm" for all frequencies); if FALSE, the best_lag is calculated separately for each frequency channel (we can track different "rhythms" at different frequencies)
if TRUE, ACFs and surprisal are weighted by max amplitude per frequency channel
if TRUE, surprisal is normalized from (-Inf, Inf) to [-1, 1]
if TRUE, plots the auditory spectrogram and the
suprisalLoudness contour
"surprisal" = pure surprisal, "surprisalLoudness" = surprisal x increase in subjective loudness
"none" = no oscillogram; "linear" = on the original scale; "dB" = in decibels
a vector of length two specifying the relative height of the spectrogram and the oscillogram (including time axes labels)
frequency range to plot, kHz (defaults to 0 to Nyquist frequency). NB: still in kHz, even if yScale = bark, mel, or ERB
controls the sharpness or contrast of the image: <0 =
decrease contrast, 0 = no change, >0 increase contrast. Recommended range
approximately (-1, 1). The spectrogram is raised to the power of
exp(3 * contrast)
makes the image lighter or darker: <0 = darker, 0 = no change, >0 = lighter, range (-1, 1). The color palette is preserved, so "brightness" works by capping an increasing proportion of image at the lightest or darkest color. To lighten or darken the palette, just change the colors instead
the maximum number of "pixels" in the oscillogram (if any) and spectrogram; good for quickly plotting long audio files; defaults to c(1e5, 5e5); does not affect reassigned spectrograms
if TRUE, pads the sound with just enough silence to resolve the edges properly (only the original region is plotted, so the apparent duration doesn't change)
black and white ('bw'), as in seewave package ('seewave'),
matlab-type palette ('matlab'), or any palette from
palette such as 'heat.colors', 'cm.colors', etc
actual colors, eg rev(rainbow(100)) - see ?hcl.colors for colors in base R (overrides colorTheme)
a vector of arbitrary length scaled in Hz (regardless of yScale, but nonlinear yScale also warps the contour) that will be plotted over the spectrogram (eg pitch contour); can also be a list with extra graphical parameters such as lwd, col, etc. (see examples)
graphical parameters for plotting
if numeric, adds n = grid dotted lines per kHz
graphical parameters for saving plots passed to
png
other graphical parameters