plotSpec: Plot spectrogram

Description

Internal soundgen function

Usage

plotSpec(
  X,
  Y,
  Z,
  audio = NULL,
  internal = NULL,
  dynamicRange = 80,
  osc = c("none", "linear", "dB")[2],
  heights = c(3, 1),
  ylim = NULL,
  yScale = "linear",
  contrast = 0.2,
  brightness = 0,
  maxPoints = c(1e+05, 5e+05),
  padWithSilence = TRUE,
  colorTheme = c("bw", "seewave", "heat.colors", "...")[1],
  col = NULL,
  nlevels = 30,
  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

X: time stamps, ms
Y: frequency stamps, kHz / mel / bark
Z: time in rows, frequency in columns (NB: this is the transpose of the exported spectrogram!)
audio: a list returned by readAudio
dynamicRange: dynamic range, dB. All values more than one dynamicRange under maximum are treated as zero
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
yScale: scale of the frequency axis: 'linear' = linear, 'log' = logarithmic (musical), 'bark' = bark with hz2bark, 'mel' = mel with hz2mel, 'ERB' = Equivalent Rectangular Bandwidths with HzToERB
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

Details

Helper function called by spectrogram() etc to plot a spectrogram.