Trellis Plot of a Signal

DESCRIPTION:

Create a Trellis plot of a signalSeries object on the current plotting device. This function is the method for trellisPlot for objects of class signalSeries, but it can also be called directly.

USAGE:

trellisPlot.signalSeries(x, ..., subset=T, xlab="", ylab="",
                         xlim=NULL, ylim=NULL, x.axis.args=NULL,
                         y.axis.args=NULL, scales=NULL, layout=NULL,
                         log.axes="c", polar=F, magnitude=polar,
                         phase=polar, real.im=F, real=real.im,
                         im=real.im, dB=F,
                         type=trellis.par.get("style.type")$plot.type,
                         trellis.args=NULL, frame.call=sys.nframe(),
                         frame.function=frame.call)

REQUIRED ARGUMENTS:

x
first signal to plot, or a list of signals. If it is a named list, those names will be used as the panel labels.

OPTIONAL ARGUMENTS:

...
additional signal or graphical arguments.
subset
a subscript vector appropriate for subscripting the data's x and y values. This can be a numeric vector with positive integers, one with negative integers indicating which observations should be omitted, or a logical vector.
xlab
title for the x-axis
ylab
title for the y-axis
xlim
the range of x values to use for plotting.
ylim
the range of y values to use for plotting.
x.axis.args
a list of parameters to pass to the axis.numeric function for customizing the x-axis.
y.axis.args
a list of parameters to pass to the axis.numeric function for customizing the y-axis.
scales
a list with optional x and y components for passing into the scales argument of xyplot. Typically, this is used to make the x or y axes for each panel have separate scales, by setting the x or y component of scales to list(relation="free").
layout
the layout of the Trellis panels for the plot, e.g. c(2,3) for a two-row, three-column layout. If NULL, a layout that is as nearly square as possible will be calculated using the good.layout function.
log.axes
set to "xy", "x", or "y" to make the corresponding axis or axes logarithmic. Any other value makes them linear. Note that a logarithmic y axis is ignored if either dB or phase is TRUE. Also, negative and zero values are removed from the dataset when plotting logarithmically.
polar
if TRUE, create panels with the phase and magnitude of the data.
magnitude
if TRUE, create a panel with the magnitude of the data.
phase
if TRUE, create a panel with the phase of the data. This panel has the phase, as calculated by the Arg function, plotted three times (+/- 2 pi), to eliminate arbitrary 2 pi boundaries. Also, phase panels are always plotted using points, no matter what the value of type is.
real.im
if TRUE, create panels with the real and imaginary parts of the data.
real
if TRUE, create a panel with the real part of the y values.
im
if TRUE, create a panel with the imaginary part of the y values.
dB
if TRUE, create a panel with a dB plot (y values are converted to dB by taking 10 * log10(Mod(y))).
type
type of lines or points to plot: "p", "l", "b", "o", "n", "s", and "h" produce points, lines, both, both (overlaid), nothing, stairsteps, and high-density lines, respectively. This may be a single character value, to use the same plot type for everything; a vector as long as the number of series arguments, to specify different plot types for each series; a list of length one to use the same plot types for each series, but specify different plotting types for the columns within the series; or a list as long as the number of series, where each list is a vector specifying plot types for each column in that series. In all cases, the same plot type is used for the same data in each panel containing that data.
trellis.args
a list of additional arguments to pass to the xyplot trellis plotting function; these can also be passed directly as part of ....
frame.call
frame to evaluate sys.call and deparse(substitute()) in to figure out data set names (passed to parse.signal.dotargs) in parsing the ... arguments.
frame.function
frame to evaluate sys.function in to figure out the plot function arguments (passed to parse.signal.dotargs) in parsing the ... arguments.

VALUE:

an object of class trellis, which is automatically plotted by print.trellis, using the panel.signalSeries panel function.

DETAILS:

This function creates a Trellis plot of one or more signal objects. For each signal argument passed in the x or ... arguments, one or more panels is created. The possible panels contain the magnitude of the data, phase, real or imaginary part, or dB; if none of those is requested, the standard panel is plotted, which plots real data unchanged and takes the magnitude of complex data. Each panel is labeled with the name of the dataset, as specified in the trellisPlot call, along with a string identifying the type of panel. The same panels are plotted for each data argument, and if a signal is multivariate, all of the columns are plotted on each panel for that signal, typically with different line types or colors. Graphical arguments governing line type, color, and other parameters for Trellis plots of signals should be set using trellis.par.set. They are stored in the various Trellis data sets for the plotting devices, and designed to give good-looking plots with distinct styles for each column of each data set.

EXAMPLES:

trellisPlot(say.wavelet+100i, polar=T, real.im=T,
   scales=list(y=list(relation="free")))

SEE ALSO:

, , .