dot-filterSoundByMS: Filter a single sound by MS
In tatters/soundgen: Sound Synthesis and Acoustic Analysis

.filterSoundByMS

R Documentation

Filter a single sound by MS

Description

Internal soundgen function.

Usage

.filterSoundByMS(
  audio,
  logSpec = FALSE,
  windowLength = 25,
  step = NULL,
  overlap = 80,
  wn = "hamming",
  zp = 0,
  amCond = NULL,
  fmCond = NULL,
  jointCond = NULL,
  action = c("remove", "preserve")[1],
  initialPhase = c("zero", "random", "spsi")[3],
  nIter = 50,
  play = FALSE,
  plot = TRUE,
  savePlots = NULL,
  width = 900,
  height = 500,
  units = "px",
  res = NA
)

Arguments

`audio`	a list returned by `readAudio`
`logSpec`	if TRUE, the spectrogram is log-transformed prior to taking 2D FFT
`windowLength`	length of FFT window, ms
`step`	you can override `overlap` by specifying FFT step, ms (NB: because digital audio is sampled at discrete time intervals of 1/samplingRate, the actual step and thus the time stamps of STFT frames may be slightly different, eg 24.98866 instead of 25.0 ms)
`overlap`	overlap between successive FFT frames, %
`wn`	window type accepted by `ftwindow`, currently gaussian, hanning, hamming, bartlett, rectangular, blackman, flattop
`zp`	window length after zero padding, points
`amCond, fmCond`	character strings with valid conditions on amplitude and frequency modulation (see examples)
`jointCond`	character string with a valid joint condition amplitude and frequency modulation
`action`	should the defined AM-FM region be removed ('remove') or preserved, while everything else is removed ('preserve')?
`initialPhase`	initial phase estimate: "zero" = set all phases to zero; "random" = Gaussian noise; "spsi" (default) = single-pass spectrogram inversion (Beauregard et al., 2015)
`nIter`	the number of iterations of the GL algorithm (Griffin & Lim, 1984), 0 = don't run
`play`	if TRUE, plays back the reconstructed audio
`plot`	if TRUE, produces a triple plot: original MS, filtered MS, and the MS of the output sound
`savePlots`	if a valid path is specified, a plot is saved in this folder (defaults to NA)
`width, height, units, res`	parameters passed to `png` if the plot is saved