plot.swdft {swdft}R Documentation

Plot method for 'swdft' object

Description

Plot method for 'swdft' object

Usage

## S3 method for class 'swdft'
plot(x, freq_type = "cycles", fs = NULL,
  hertz_range = NULL, take_log = FALSE, log_thresh = 1e-05,
  use_fields = TRUE, scale_shrink = 0.9, zlim = NULL,
  xlab = "Window Position", ylab = "Frequency (Cycles/Window)",
  title = "SWDFT", cex_main = 1, cex_lab = 1, cex_axis = 1,
  xaxis_subset = NULL, custom_xaxis = NULL, custom_yaxis = NULL,
  col = "grayscale", display = TRUE, ...)

Arguments

x

Object of class 'swdft'. If x$a is complex-valued, it is converted to the squared modulus. If x$a is real-valued, then we assume that it represents the squared

freq_type

Specify how to display the frequency axis. Either 'cycles' (default), 'fraction', or 'hertz'

fs

sample rate. Used if freq_type='hertz'

hertz_range

integer vector, given by (low, high). Specifies the range of hertz to display and is only used when freq_type='hertz'

take_log

logical. Whether to take the log before plotting

log_thresh

numeric. Threshold for smallest possible value. Defaults to .000001, and is used to keep plots from displaying of ~ -40.

use_fields

logical. Determines whether we use image.plot from the fields package, or 'image' from the graphics package. The advantage of image.plot is that we get a color scale, so the default is TRUE

scale_shrink

Proportion between 0 and 1 to shrink the scale

zlim

Custom z range

xlab

Custom x-label

ylab

Custom y-label

title

Custom title

cex_main

how large to make the title

cex_lab

how large to make the labels

cex_axis

how large to make the axis labels

xaxis_subset

subset of x-axis (time / window position) for plotting

custom_xaxis

Defaults to NULL. Otherwise, used to change the x-axis

custom_yaxis

Defaults to NULL. Otherwise, used to change the y-axis

col

defaults to grayscale, can also be 'tim.colors' from fields package

display

logical. Defaults to TRUE, only used for testing purposes, so it should always be TRUE.

...

optional arguments to match the plot generic function


[Package swdft version 1.0.0 Index]