gbtoplot.pro

NRAO GBTIDL
Produced by IDL 6.1
User Documentation

prev file | next file view single page | view frames | update routines

SUMMARY: fields | routine DETAILS: routine

./plotter
gbtoplot.pro

Last modification date:: Thu Jun 2 23:56:08 2005

gbtoplot

procedure gbtoplot[, x], y, [color=long integer], [/chan], [index=variable]

Overplots using oplot on to the GBT plotter's surface. It also remembers the x and y values so that they can be replotted as needed (e.g. the x-axis changes). Overplots, if toggled off, are automatically toggled on by a call to gbtoplot.

Version: $Id: gbtoplot.pro,v 1.11 2005/04/29 06:02:19 bgarwood Exp $
Common blocks: gbtplot_common

Parameters

x
in, optional
numerical vector The x values to be plotted. If omitted, then x is assumed to be channels starting at 0 and going through n_elements(y) - 1. When supplied, it must have the same number of elements as y. Unless chan is specified, this is assumed to be in the same units as the existing x axis.

y
in, required
numerical vector . The y values to be plotted.

Keywords

color
in, optional
long integer (def. !g.oplotcolor) The color of the line to be plotted.

chan
in, optional
boolean When set, the x axis is assumed to be in channels and a conversion to the existing x axis is necessary to plot them. That conversion is done using the header information of the primary plot (the argument to the most recent show).

index
out, optional
variable Returns the index associated with this oplot. This index can be used to clear this over plot using clearoplots. Note that once an index is cleared, subsequent indexes are renumbered - i.e. there are never any gaps in in index number.

Produced by IDLdoc 1.6 on Thu Jun 2 23:56:52 2005

Parameters
x in, optional numerical vector	The x values to be plotted. If omitted, then x is assumed to be channels starting at 0 and going through n_elements(y) - 1. When supplied, it must have the same number of elements as y. Unless chan is specified, this is assumed to be in the same units as the existing x axis.
y in, required numerical vector	. The y values to be plotted.

Keywords
color in, optional long integer (def. !g.oplotcolor)	The color of the line to be plotted.
chan in, optional boolean	When set, the x axis is assumed to be in channels and a conversion to the existing x axis is necessary to plot them. That conversion is done using the header information of the primary plot (the argument to the most recent show).
index out, optional variable	Returns the index associated with this oplot. This index can be used to clear this over plot using clearoplots. Note that once an index is cleared, subsequent indexes are renumbered - i.e. there are never any gaps in in index number.