show_support.pro

NRAO GBTIDL
Produced by IDL 7.1.1
Developer Documentation

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

SUMMARY: fields | routine DETAILS: routine

./plotter
show_support.pro

Last modification date:: Wed Sep 28 13:27:13 2016

show_support

procedure show_support[, dc], [/postscript], [filename=string], [/reshow], [/defaultx], [/portrait], [color=long integer], [/smallheader], [/noheader]

This procedure is the workhorse behind show, reshow, and write_ps. It is expected that users will use those proecdures rather than use this directly, although there is no loss of functionality in using this directly. The top-level interface was split into three procedures to make each less confusing. This procedure displays a spectral line data container. If no dc is passed, the global container is used.

Version: $Id$
Common blocks: gbtplot_common

Parameters

dc
in, optional
data container or integer (def. 0) a data container, or an integer global buffer number. Defaults to the primary data container (buffer 0).

Keywords

postscript
in, optional
boolean If set, then this write to a postscript file given by filename.

filename
in, optional
string Filename to use for postscript file. A valid file must be supplied when postscript is set. This keyword is ignored unless postscript is set.

reshow
in, optional
boolean When set, then dc argument is ignored and the previously set xarray will be re-used here. This allows other routines to set the xarray and speeds up this procedure when the same data is being reshown.

defaultx
in, optional
boolean When set, the default x-axis (frame, velocity definition, units from the data header in absolute units) will be used. In the default case (unset), the current settings are retained.

portrait
in, optional
boolean If set and the postcript keyword is also set, then the postscript will be generated in portrait mode instead of the default landscape mode.

color
in, optional
long integer (def. !g.showcolor) The color for the primary data.

smallheader
in, optional
boolean When set, only a small, one line header consisting of RA, DEC, source name, and date is placed at the top of the plot. The footer line is displayed when smallheader is set. By default, the full, multi-line header and the single line footer are displayed.

noheader
in, optional
boolean When set, no header information is displayed at the top of the plot or below the x-axis label of the plot (footer). This takes precedence over smallheader. By default, the full, multi-line header and the single line footer are displayed.

Produced by IDLdoc 1.6 on Wed Sep 28 13:27:21 2016

Parameters
dc in, optional data container or integer (def. 0)	a data container, or an integer global buffer number. Defaults to the primary data container (buffer 0).

Keywords
postscript in, optional boolean	If set, then this write to a postscript file given by filename.
filename in, optional string	Filename to use for postscript file. A valid file must be supplied when postscript is set. This keyword is ignored unless postscript is set.
reshow in, optional boolean	When set, then dc argument is ignored and the previously set xarray will be re-used here. This allows other routines to set the xarray and speeds up this procedure when the same data is being reshown.
defaultx in, optional boolean	When set, the default x-axis (frame, velocity definition, units from the data header in absolute units) will be used. In the default case (unset), the current settings are retained.
portrait in, optional boolean	If set and the postcript keyword is also set, then the postscript will be generated in portrait mode instead of the default landscape mode.
color in, optional long integer (def. !g.showcolor)	The color for the primary data.
smallheader in, optional boolean	When set, only a small, one line header consisting of RA, DEC, source name, and date is placed at the top of the plot. The footer line is displayed when smallheader is set. By default, the full, multi-line header and the single line footer are displayed.
noheader in, optional boolean	When set, no header information is displayed at the top of the plot or below the x-axis label of the plot (footer). This takes precedence over smallheader. By default, the full, multi-line header and the single line footer are displayed.