.getSurprisal: Get surprisal per sound

Description

Internal soundgen function called by getSurprisal.

Usage

.getSurprisal(
  audio,
  winSurp,
  audSpec_pars = list(filterType = "butterworth", nFilters = 64, step = 20),
  method = c("acf", "np")[1],
  plot = TRUE,
  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,
  ...
)

Arguments

winSurp: surprisal analysis window, ms (Inf = from sound onset to each point)
audSpec_pars: a list of parameters passed to audSpectrogram
method: acf = change in maximum autocorrelation after adding the final point, np = nonlinear prediction (see nonlinPred)
plot: if TRUE, plots the auditory spectrogram and the suprisalLoudness contour
osc: "none" = no oscillogram; "linear" = on the original scale; "dB" = in decibels
heights: a vector of length two specifying the relative height of the spectrogram and the oscillogram (including time axes labels)
ylim: frequency range to plot, kHz (defaults to 0 to Nyquist frequency). NB: still in kHz, even if yScale = bark, mel, or ERB
contrast: a number, recommended range -1 to +1. The spectrogram is raised to the power of exp(3 * contrast). Contrast >0 increases sharpness, <0 decreases sharpness
brightness: how much to "lighten" the image (>0 = lighter, <0 = darker)
maxPoints: the maximum number of "pixels" in the oscillogram (if any) and spectrogram; good for quickly plotting long audio files; defaults to c(1e5, 5e5)
padWithSilence: 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)
colorTheme: 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
col: actual colors, eg rev(rainbow(100)) - see ?hcl.colors for colors in base R (overrides colorTheme)
extraContour: a vector of arbitrary length scaled in Hz (regardless of yScale!) 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)
xlab, ylab, main, mar, xaxp: graphical parameters for plotting
grid: if numeric, adds n = grid dotted lines per kHz
width, height, units, res: graphical parameters for saving plots passed to png
...: other graphical parameters