HHTPackagePlotter: Set up spectrogram figure

Description Usage Arguments Value Author(s)

View source: R/rendering_and_plotting.R

Description

Sets up the figure window for HHGramImage and FTGramImage. This is an internal function and will likely never be called by a user

Usage

1
2
3
HHTPackagePlotter(img, trace, amp.span, img.x.lab, img.y.lab, blur = NULL, 
fit.line = NULL, window = NULL, colormap = NULL, backcol = c(0, 0, 0), 
pretty = FALSE, grid = TRUE, colorbar = TRUE, opts = list())

Arguments

img

Fourier or Hilbert spectrogram image.

trace

Time series corresponding to the spectrogram.

amp.span

Amplitudes over which to plot.

blur

Apply a Gaussian smoother. Default NULL - no smoothing

.

img.x.lab

Specifies the X axis label on the image part of the figure, defaults to "time"

img.y.lab

Specifies the Y axis label on the image part of the figure, defaults to "frequency"

fit.line

Plots a line corresponding to the IMF sum on the trace, if requested

window

The Fourier window length, if applicable

colormap

The image color map

backcol

The background color of the image (what shows up for pixels with value NA)

pretty

Adjusts image axes to have nice values, see the pretty function in the base package included in R

grid

Determines whether to plot grid lines on the spectrogram

colorbar

Whether to plot a color bar for amplitude values

opts

Other possible options passed from HHGramImage and FTGramImage

Value

INTERNAL

Author(s)

Daniel Bowman [email protected]


hht documentation built on May 29, 2017, 9:26 a.m.