This page was created by the IDL library routine
mk_html_help. For more information on
this routine, refer to the IDL Online Help Navigator
or type:
? mk_html_help
at the IDL command line prompt.
Last modified: Fri Feb 2 17:45:07 2001.
Project : SOHO - CDS Name : DEVICELIB Purpose : Definitions needed for the SERTS graphics device library. Explanation : Defines variables and common blocks needed for the SERTS graphics device library. Adds system variables !BCOLOR and !ASPECT. Use : DEVICELIB Inputs : None. Opt. Inputs : None. Outputs : None. Opt. Outputs: None. Keywords : None. Calls : None. Common : None. Restrictions: This routine should be called only once, preferably in the startup procedure. Side effects: System variables may be changed to their default values. Category : Utilities, Prev. Hist. : William Thompson, 10 November 1992. Written : William Thompson, GSFC, 10 November 1992. Modified : Version 1, William Thompson, GSFC, 23 June 1993. Incorporated into CDS library. Version : Version 1, 23 June 1993.
Project : SOHO - CDS
Name :
GET_DFONT()
Purpose :
Return widget font with size compatible with current device
Explanation :
Useful for selecting fonts to fit into widgets
Use :
Result = GET_DFONT(UFONT)
Inputs :
UFONT = user's optional input fonts (string array)
Opt. Inputs :
None.
Outputs :
DFONT = returned fonts (string array)
Opt. Outputs:
None.
Keywords :
None.
Calls :
DEVICE
Common :
None.
Restrictions:
None.
Side effects:
None.
Category :
Online_help.
Prev. Hist. :
Written Elaine Einfalt (HSTX) May 1992.
Modified :
Version 1, Dominic Zarro, GSFC, 1 August 1994.
Corrected some bugs
Version :
Version 1, 1 August 1994.
Project : SOHO - CDS
Name : GET_SCREEN
Purpose :
return screen scaling parameters for controlling widget
sizing
Explanation :
Use : GET_SCREEN, space,xpad,ypad,scx,scy
Inputs : None.
Opt. Inputs : None.
Outputs :
space = pixel spacing between children bases
xpad,ypad = horizontal and vertical pixel spacing being children
bases and edges of parent base.
scx,scy = pixel scale factors to rescale screen size in
X- and Y-directions
Opt. Outputs: None.
Keywords : None.
Procedure :
The returned values were derived empirically by
experimenting with sizing widgets on a 1280 x 1024 pixel screen.
They can be used as keywords in WIDGET_CONTROL to produce
"nice fitting" widgets. IDL can (and will likely) ignore them.
Calls : None.
Common : None.
Restrictions: None.
Side effects: None.
Category :
Prev. Hist. : None.
Written : DMZ (ARC) Oct 1993
Modified :
Version :
Project : SOHO - CDS Name : GET_VIEWPORT Purpose : Gets current viewport values, in device coordinates. Explanation : Gets the current values of the viewport, in the form of the old-fashioned variables !SC1, !SC2, !SC3, and !SC4. This supports those routines that were originally developed for IDL version 1. The routine calculates the system variables by generating a dummy plot without actually drawing to the screen. Use : GET_VIEWPORT, SC1, SC2, SC3, SC4 Inputs : None. Opt. Inputs : None. Outputs : SC1, SC2, SC3, SC4 are the device coordinates of the viewport. Opt. Outputs: None. Keywords : None. Calls : None. Common : None. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: None. Category : Utilities, Devices. Prev. Hist. : William Thompson, November 1992. William Thompson, November 1992, modified to get parameters by generating a dummy plot rather than calculating directly, so as to be compatible with !P.MULTI. William Thompson, December 1992, corrected bug where certain system variables were being changed by this routine. Written : William Thompson, GSFC, November 1992. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 12 January 1994. Modified to avoid problems that may arise when !X.STYLE or !Y.STYLE is not zero. Version : Version 2, 12 January 1994.
Project : SOHO - CDS Name : HAVE_WIDGETS Purpose : Tests whether current graphics device supports widgets. Explanation : The system variable !D.FLAGS is examined to see if the current graphics device supports widgets. Use : Result = HAVE_WIDGETS() IF HAVE_WIDGETS() THEN ... Inputs : None. Opt. Inputs : None. Outputs : The result of the function is either 0 (false) or 1 (true) depending on whether or not the current graphics device supports widgets. Opt. Outputs: None. Keywords : None. Calls : None. Common : None. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: None. Category : Utilities, Devices. Prev. Hist. : William Thompson, April 1992. Written : William Thompson, GSFC, April 1992. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : HAVE_WINDOWS Purpose : Tests whether current graphics device supports windows. Explanation : The system variable !D.FLAGS is examined to see if the current graphics device supports windows. Use : Result = HAVE_WINDOWS() IF HAVE_WINDOWS() THEN ... Inputs : None. Opt. Inputs : None. Outputs : The result of the function is either 0 (false) or 1 (true) depending on whether or not the current graphics device supports windows. Opt. Outputs: None. Keywords : None. Calls : None. Common : None. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: None. Category : Utilities, Devices. Prev. Hist. : William Thompson, April 1992. Written : William Thompson, GSFC, April 1992. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : PCL Purpose : Sets graphics device to HP LaserJet PCL file. Explanation : This procedure sets the system variables needed to write HP LaserJet PCL plot files. The plot is done in landscape mode, using most of the paper. SETPLOT is called to save and set the system variables, and DEVICE is called to set the plot window size and orientation, and to open the file. If the plot file is already open, then calling PCL without any parameters or keywords allows the user to write into the already opened file, in the same mode as before. Use : PCL [, FILENAME ] PCL ;Open PCL plot file ... plotting commands ... ;Create plot PCLPLOT ;Close & plot file, reset to prev. dev. or PCLCLOSE ;Close w/o printing, " " " " Inputs : None required. Opt. Inputs : FILENAME - Name of PCL plot file to be opened. If not passed, and no filename was previously passed, "idl.pcl" is assumed. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : LANDSCAPE = If set, then plotting is done in LANDSCAPE mode (default). PORTRAIT = If set, then plotting is done in PORTRAIT mode. PORTRAIT takes precedent over LANDSCAPE. Calls : SETPLOT, FORM_FILENAME Common : PCL_FILE which contains PCL_FILENAME, the name of the plotting file, and LAST_DEVICE, which is the name of the previous graphics device. Also calls SETPLOT, which uses common block PLOTFILE. Restrictions: Only the routines PCLPLOT and PCLCLOSE can be used to close the PCL plot file. It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If the FILENAME parameter, or either the LANDSCAPE or PORTRAIT keywords, is passed then DEVICE is called to open a new file. Any previously opened PCL plot file would be closed. If a new file is opened, then the DEVICE routine is called with the /LANDSCAPE or /PORTRAIT switch to set the size and orientation of the plot window. If not the first time this routine is called, then system variables that affect plotting are reset to previous values. If it is the first time the routine is called, !FANCY is set to 1. In UNIX, if a new file is opened with the same name as an existing file, then the old file is lost. Category : Utilities, Devices. Prev. Hist. : None. Written : William Thompson, GSFC, 15 June 1993. Modified : Version 1, William Thompson, GSFC, 15 June 1993. Based on QMS.PRO Version : Version 1, 15 June 1993.
Project : SOHO - CDS Name : PCLCLOSE Purpose : Close an HP LaserJet PCL plot file, reset graphics device. Explanation : The currently opened HP LaserJet PCL plot file is closed, and the graphics device is reset to what was used previously. Use : PCLCLOSE PCL ;Open PCL plot file ... plotting commands ... ;Create plot PCLPLOT ;Close & plot file, reset to prev. dev. or PCLCLOSE ;Close w/o printing, " " " " Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : PCL_FILE which contains PCL_FILENAME, the name of the plotting file, and LAST_DEVICE, which is the name of the previous graphics device. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The previous plotting device is reset. Category : Utilities, Devices. Prev. Hist. : None. Written : William Thompson, GSFC, 15 June 1993. Modified : Version 1, William Thompson, GSFC, 15 June 1993. Based on QMCLOSE.PRO. Version : Version 1, 15 June 1993.
Project : SOHO - CDS Name : PCLPLOT Purpose : Print an HP LaserJet PCL plot file, reset graphics device. Explanation : Sends a PCL plot file generated by IDL to the HP LaserJet PCL laser printer. The default queue is defined by the logical name/environment variable HPLASER. The graphics device is reset to what was used previously. Use : PCLPLOT [, FILE ] [, /DELETE ] PCL ;Open PCL plot file ... plotting commands ... ;Create plot PCLPLOT ;Close & plot file, reset to prev. dev. or PCLCLOSE ;Close w/o printing, " " " " Inputs : None required. Opt. Inputs : The default filename is either taken from the last call to the PCL routine, or is "idl.pcl". A filename other than the default can be passed in one of three ways: Explicitly: e.g. PCLPLOT,'graph.pcl' By number (VMS) e.g. PCLPLOT,3 for "idl.pcl;3" All versions (VMS) e.g. PCLPLOT,'*' for "idl.pcl;*" All ".pcl" files (UNIX) e.g. PCLPLOT,'*' for "*.pcl" Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : DELETE = If set, then file is deleted after printing. QUEUE = Name of printer queue to be used in printing the file. COMMAND = (Unix only.) Command to be used to send the plot file to the printer. If not passed, then the environment variable PRINTCOM is checked. If neither of these is set, then the standard command "lpr" is used. Calls : SETPLOT Common : PCL_FILE which contains PCL_FILENAME, the name of the plotting file, and LAST_DEVICE, which is the name of the previous graphics device. Restrictions: The requested plot file must exist. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The plot file is queued on the printer HPLASER. Also, any files "idl.pcl" that may be open will be closed. The previous plotting device is reset. Category : Utilities, Devices. Prev. Hist. : None. Written : William Thompson, GSFC, 15 June 1993. Modified : Version 1, William Thompson, GSFC, 15 June 1993. Based on QMPLOT.PRO. Version 2, William Thompson, GSFC, 8 June 1994 Added keyword COMMAND Version : Version 2, 8 June 1994.
Project : SOHO - CDS Name : PS Purpose : Sets graphics device to PostScript file. Explanation : This procedure sets the system variables needed to write PostScript printer plot files. The default configuration is landscape mode. Alternate modes are (TeX-compatible) encapsulated mode, portrait mode using all of the paper, and color mode (either landscape or portrait) which is compatible with the color printer. SETPLOT is called to save and set the system variables. If a new file is to be opened, then DEVICE is called to set the plot window size and orientation, and to open the file. If the plot file is already open, then calling PS without any parameters or keywords allows the user to write into the already opened file, in the same mode as before. Use : PS [, FILENAME ] PS ;Open PostScript plot file ... plotting commands ... ;Create plot PSPLOT ;Close & plot file, reset to prev. dev. or PSCLOSE ;Close w/o printing, " " " " Inputs : None required unless /ENCAPSULATED switch set. See FILENAME below. Opt. Inputs : FILENAME - Name of postscript file to be opened. If not passed, and no filename was previously passed, "idl.ps" is assumed. If the /ENCAPSULATED switch is passed, then a filename must be passed. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : The following keywords are listed in the order of precedence. ENCAPSULATED = If set, then the plot is done in encapsulated landscape mode. This is compatible with TeX/LaTeX. TEX = A synonym for ENCAPSULATED. PORTRAIT = If set, then the plot is done in portrait mode, using all of the paper. LANDSCAPE = If set, then the plot is done in landscape mode, using all of the paper. This is the default mode. In addition, the following keyword can be used with any of the others. COLOR = If set, then a color plot is made. COPY = If set, (together with /COLOR) then the current color table is copied to the PostScript device. Also, the SETFLAG routine is called to set TOP equal to the number of colors. Also makes sure that !P.COLOR does not exceed the TOP color. Requires the SERTS image display software. Calls : SETPLOT, FORM_FILENAME Common : PS_FILE which contains PS_FILENAME, the name of the plotting file, LAST_DEVICE, which is the name of the previous graphics device, and various parameters used to keep track of which configuration is being used. Also calls SETPLOT, which uses common block PLOTFILE. Restrictions: Only the routines PSPLOT and PSCLOSE can be used to close the PostScript file. It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If the filename, or one of the configuration keywords (ENCAPSULATED, COLOR, PORTRAIT, or LANDSCAPE) are passed, then DEVICE is called to open a new file. Any previously opened PostScript file would be closed. If a new file has to be opened, and if none of the configuration keywords are passed, then the default configuration (LANDSCAPE) is used. This is true even if the last PostScript file was in a different configuration. If not the first time this routine is called, then system variables that affect plotting are reset to previous values. If it is the first time the routine is called, !FANCY is set to 1. In UNIX, if a new file is opened with the same name as an existing file, then the old file is lost. Category : Utilities, Devices. Prev. Hist. : W.T.T., Nov. 1989. W.T.T., Aug. 1990, added LAST_DEVICE to common block. W.T.T., Feb. 1991, added keywords LANDSCAPE, PORTRAIT, TEX, COLOR. W.T.T., June 1992, fixed bug where CUR_CONFIG was not stored. W.T.T., Nov. 1992, added !P.POSITION to common block. Written : William Thompson, GSFC, November 1989. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 11 November 1993. Added ENCAPSULATED keyword. Relegated TEX to a synonym. Version 3, William Thompson, GSFC, 14 September 1994 Added COPY keyword. Version : Version 3, 14 September 1994
Project : SOHO - CDS Name : PSCLOSE Purpose : Close a PostScript plot file, reset graphics device. Explanation : The currently opened PostScript plot file is closed, and the graphics device is reset to what was used previously. Use : PSCLOSE PS ;Open PostScript plot file ... plotting commands ... ;Create plot PSPLOT ;Close & plot file, reset to prev. dev. or PSCLOSE ;Close w/o printing, " " " " Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : PS_FILE which contains PS_FILENAME, the name of the plotting file, LAST_DEVICE, which is the name of the previous graphics device, and various parameters used to keep track of which configuration is being used. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The previous plotting device is reset. Category : Utilities, Devices. Prev. Hist. : William Thompson, August 1990. W.T.T., Feb. 1991, modified to reflect change in common block PS_FILE. Written : William Thompson, GSFC, August 1990. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 2 January 1994. Added save into common plot of current configuration. Version : Version 2, 2 January 1994.
Project : SOHO - CDS
Name :
PSPLOT
Purpose :
Prints PostScript plots and resets to the previous device.
Explanation :
Send a PostScript plot file generated by IDL to the PostScript laser
printer. The default queue is defined by the logical name/environment
variable PSLASER.
If PSPLOT is being used to close the PostScript file as well as print
it, and the queue name is not passed explicitly, then it will
automatically select a color printer (PSCOLOR) if the file was opened by
the PS procedure with /COLOR set, and a regular PostScript printer
(PSLASER) otherwise. However, if the file was previously closed with
PSCLOSE or PSPLOT, then either the /COLOR or QUEUE keyword will need to
be used to direct a color PostScript file to the appropriate printer.
Use :
PSPLOT [, FILE ] [, /DELETE ]
PS ;Open PostScript plot file
... plotting commands ... ;Create plot
PSPLOT ;Close & plot file, reset to prev. dev.
or
PSCLOSE ;Close w/o printing, " " " "
Inputs :
None required.
Opt. Inputs :
The default filename is either taken from the last call to the PS
routine, or is "idl.ps".
A filename other than the default can be passed in one of three ways:
Explicitly: e.g. PSPLOT,'graph.ps'
By number (VMS) e.g. PSPLOT,3 for "idl.ps;3"
All versions (VMS) e.g. PSPLOT,'*' for "idl.ps;*"
All ".ps" files (UNIX) e.g. PSPLOT,'*' for "*.ps"
Outputs :
A message is printed to the screen.
Opt. Outputs:
None.
Keywords :
DELETE = If set, then file is deleted after printing.
QUEUE = Name of printer queue to be used in printing the file. If
not passed, then the environment variable PSLASER (or
PSCOLOR) is checked for the name of the print queue.
COLOR = If set, then the environment variable PSCOLOR is checked for
the name of the print queue rather then PSLASER. Ignored if
QUEUE is passed.
COMMAND = (Unix only.) Command to be used to send the plot file to the
printer. If not passed, then the environment variable
PRINTCOM is checked. If neither of these is set, then the
standard command "lpr" is used.
Calls :
SETPLOT
Common :
PS_FILE which contains PS_FILENAME, the name of the plotting file,
LAST_DEVICE, which is the name of the previous graphics device, and
various parameters used to keep track of which configuration is being
used.
Restrictions:
The requested plot file must exist.
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
The plot file is queued on the printer. Also, any files "idl.ps" that
may be open will be closed. The previous plotting device is reset.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson, November 1989.
W.T.T., added check for LAST_DEVICE, August 1990.
W.T.T., changed DELETE to keyword, February, 1991.
W.T.T., Feb. 1991, modified to reflect change in common block PS_FILE.
W.T.T., May 1991, extended environment variable PSLASER to UNIX.
W.T.T., Jun 1992, added check for PSCOLOR.
W.T.T., Jul 1992, added check for PS_FILENAME in common block.
W.T.T., Sep 1992, added COLOR keyword.
Written :
William Thompson, GSFC, November 1989.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version 2, William Thompson, GSFC, 2 January 1994.
Added save into common plot of current configuration.
Version 2.1, S.V. Haugan, ItA/UiO
Added support for alternative UNIX print commands via $PRINTCOM
Version 3, William Thompson, GSFC, 8 June 1994
Added keyword COMMAND
Version :
Version 3, 8 June 1994.
Project : SOHO - CDS
Name : PS_LONG
Purpose : To stretch plotting area when device is PostScript printer.
Explanation : Resets plotting area using device command. If the environment
variable US_FUNNY_PAPER is defined then the size is adjusted
from A4 to US size.
Use : IDL> ps_long
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : None
Common : None
Restrictions: None
Side effects: None
Category : Util, plotting
Prev. Hist. : From Yohkoh routine by R D Bentley.
Written : CDS version by C D Pike, RAL, 21-Apr-94
Modified :
Version : Version 1, 21-Apr-94
Project : SOHO - CDS
Name : PS_RESET
Purpose : Resets PostScript plotting area to Portrait, normal size.
Explanation : The antidote to PS_LONG.
Use : IDL> ps_reset
Inputs : None
Opt. Inputs : None
Outputs : None
Opt. Outputs: None
Keywords : None
Calls : None
Common : None
Restrictions: None
Side effects: Returns PostScript device to Portrait mode also.
Category : Util, device
Prev. Hist. : Yohkoh routine by R D Bentley.
Written : CDS version by C D Pike, RAL, 21-Apr-94
Modified :
Version : Version 1, 21-Apr-94
Project : SOHO - CDS Name : QMCLOSE Purpose : Close a QMS plot file and reset the graphics device. Explanation : The currently opened QMS plot file is closed, and the graphics device is reset to what was used previously. Use : QMCLOSE QMS ;Open QMS plot file ... plotting commands ... ;Create plot QMPLOT ;Close & plot file, reset to prev. dev. or QMCLOSE ;Close w/o printing, " " " " Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : QMS_FILE which contains QMS_FILENAME, the name of the plotting file, and LAST_DEVICE, which is the name of the previous graphics device. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The previous plotting device is reset. Category : Utilities, Devices. Prev. Hist. : William Thompson, Feb. 1991, from PSCLOSE Written : William Thompson, GSFC, February 1991. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : QMPLOT Purpose : Print a QMS plot file and reset the graphics device. Explanation : Sends a QMS plot file generated by IDL to the QMS laser printer. The default queue is defined by the logical name/environment variable LASER. The graphics device is reset to what was used previously. Use : QMPLOT [, FILE ] [, /DELETE ] QMS ;Open QMS plot file ... plotting commands ... ;Create plot QMPLOT ;Close & plot file, reset to prev. dev. or QMCLOSE ;Close w/o printing, " " " " Inputs : None required. Opt. Inputs : The default filename is either taken from the last call to the QMS routine, or is "idl.bit". A filename other than the default can be passed in one of three ways: Explicitly: e.g. QMPLOT,'graph.bit' By number (VMS) e.g. QMPLOT,3 for "idl.bit;3" All versions (VMS) e.g. QMPLOT,'*' for "idl.bit;*" All ".bit" files (UNIX) e.g. QMPLOT,'*' for "*.bit" Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : DELETE = If set, then file is deleted after printing. QUEUE = Name of printer queue to be used in printing the file. COMMAND = (Unix only.) Command to be used to send the plot file to the printer. If not passed, then the environment variable PRINTCOM is checked. If neither of these is set, then the standard command "lpr" is used. Calls : SETPLOT Common : QMS_FILE which contains QMS_FILENAME, the name of the plotting file, and LAST_DEVICE, which is the name of the previous graphics device. Restrictions: The requested plot file must exist. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The plot file is queued on the printer LASER. Also, any files "idl.bit" that may be open will be closed. The previous plotting device is reset. Category : Utilities, Devices. Prev. Hist. : W.T.T., February, 1991, from PSPLOT. W.T.T., May 1991, extended environment variable LASER to UNIX. W.T.T., Jul 1992, added check for QMS_FILENAME in common block. Written : William Thompson, GSFC, February 1991. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 3 June 1993. Fixed bug with ENDIF/ENDELSE statements. Version 3, William Thompson, GSFC, 8 June 1994 Added keyword COMMAND Version : Version 3, 8 June 1994
Project : SOHO - CDS Name : QMS Purpose : Sets graphics device to QMS Quikplot file. Explanation : This procedure sets the system variables needed to write QMS plot files. The plot is done in landscape mode, using most of the paper. SETPLOT is called to save and set the system variables, and DEVICE is called to set the plot window size and orientation, and to open the file. If the plot file is already open, then calling QMS without any parameters or keywords allows the user to write into the already opened file, in the same mode as before. Use : QMS [, FILENAME ] QMS ;Open QMS plot file ... plotting commands ... ;Create plot QMPLOT ;Close & plot file, reset to prev. dev. or QMCLOSE ;Close w/o printing, " " " " Inputs : None required. Opt. Inputs : FILENAME - Name of QMS plot file to be opened. If not passed, and no filename was previously passed, "idl.bit" is assumed. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : LANDSCAPE = If set, then plotting is done in LANDSCAPE mode (default). PORTRAIT = If set, then plotting is done in PORTRAIT mode. PORTRAIT takes precedent over LANDSCAPE. Calls : SETPLOT, FORM_FILENAME Common : QMS_FILE which contains QMS_FILENAME, the name of the plotting file, and LAST_DEVICE, which is the name of the previous graphics device. Also calls SETPLOT, which uses common block PLOTFILE. Restrictions: Only the routines QMPLOT and QMCLOSE can be used to close the QMS plot file. It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If the FILENAME parameter, or either the LANDSCAPE or PORTRAIT keywords, is passed then DEVICE is called to open a new file. Any previously opened QMS plot file would be closed. If a new file is opened, then the DEVICE routine is called with the /LANDSCAPE or /PORTRAIT switch to set the size and orientation of the plot window. If not the first time this routine is called, then system variables that affect plotting are reset to previous values. If it is the first time the routine is called, !FANCY is set to 1. In UNIX, if a new file is opened with the same name as an existing file, then the old file is lost. Category : Utilities, Devices. Prev. Hist. : W.T.T., Feb. 1991, from PS.PRO. Written : William Thompson, GSFC, February 1991. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : REGIS Purpose : Sets graphics device to REGIS mode. Explanation : SETPLOT is called to save and set the system variables. Use : REGIS Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. are used (i.e. those routines that use SETPLOT) to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : W.T.T., Nov. 1987. Written : William Thompson, GSFC, November 1987. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : RESET Purpose : Resets system variables to their default values. Explanation : Resets the system variables for the currently selected device, and sets the following system variables to their default settings: !LINETYPE !PSYM !NOERAS !X.TITLE !Y.TITLE !P.TITLE !XTICKS !YTICKS The routine SETPLOT is called to reinitialize the relevant system parameters for the selected device. Then the above mentioned system variables are set to their defaults. Use : RESET Inputs : None. Opt. Inputs : None. Outputs : None. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None, but this routine calls SETPLOT which uses the PLOTFILE common block. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: None. Category : Utilities, Devices. Prev. Hist. : William Thompson, January 23, 1989. William Thompson, January 1993, changed to use current system variable names. Written : William Thompson, GSFC, 23 January 1989. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : SETPLOT Purpose : Switch between plotting devices with memory about each. Explanation : Switches among the various available plotting devices. The plotting variables for each device are saved in a common block so that the user retains the ability to reset to a previously used device and do over- plots, even if plots were produced on another device in the meantime. Calling SETPLOT with the name of the currently selected device resets the system variables to either default values, or those from the last time SETPLOT was called. The !BCOLOR and !ASPECT system variables are also saved. Use : SETPLOT, DEVICE Inputs : DEVICE - Name of the plotting device one is changing to. Opt. Inputs : None. Outputs : None. Opt. Outputs: None. Keywords : COPY = If set, then the current color table is copied to the new graphics device. Also, the SETFLAG routine is called to set TOP equal to the number of colors. Also makes sure that !P.COLOR does not exceed the TOP color. Requires the SERTS image display software. Calls : ADD_DEVICE, SETSCALE Common : PLOTFILE - Saves system variables for later retrieval. Not to be used by other routines. Restrictions: The procedure will not work correctly unless it is used exclusively to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: Many system variables are manipulated by this routine--in particular !P.CHARSIZE and !P.FONT. The first time the routine is called for a particular graphics device, certain plot parameters may be set to default values. Any SETSCALE settings will be lost. Category : Utilities, Devices. Prev. Hist. : W.T.T., Sept. 1987. William Thompson, February, 1990. William Thompson, October, 1991, added !ASPECT system variable. William Thompson, November 1992, changed to save !P.NOERASE and !Z.THICK. Written : William Thompson, GSFC, September 1987. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 14 September 1994 Added COPY keyword. Version : Version 2, 14 September 1994
Project : SOHO - CDS Name : SETSCALE Purpose : Sets plot scale so it is the same in X and Y directions. Explanation : The data limits in the X and Y directions (plus 5%) are calculated and compared against the the physical size of the plotting area in device coordinates. Whichever scale is larger is then used for both axes, and the plot limits are set to center the data in both directions. The parameters !X.STYLE and !Y.STYLE are then set to 1 for exact spacing. Use : SETSCALE - Resets to previous state. SETSCALE, ARRAY - Calculates scale for CONTOUR. SETSCALE, XARRAY, YARRAY - Calculates scale from arrays. SETSCALE, XMIN, XMAX, YMIN, YMAX - Calculates scale from limits. Inputs : None required. Calling SETSCALE without any parameters resets to the default behavior. Opt. Inputs : ARRAY - Two dimensional array to be used in a simple contour plot. The minima are set to zero, and the maxima are set to one less than the dimensions of the array. XARRAY, YARRAY - Arrays from which the minimum and maximum values are calculated. XMIN, XMAX, YMIN, YMAX - The limits in the X and Y directions from which the scale is calculated. The actual X and Y ranges must include these values. Outputs : None. Opt. Outputs: None. Keywords : NOBORDER = If set, then the 5% border is not applied. NOADJUST = If set, then the edges of the plot (!P.POSITION) are not modified. Calls : GET_VIEWPORT Common : SETSCALE = Keeps track of the system variables changed by this routine. Restrictions: Unpredictable results may occur if SETSCALE is in effect when WINDOW, WSET or SET_PLOT are called. It is recommended that SETSCALE be called without parameters to reset to the ordinary behavior before the graphics device or window is changed. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The system variables !X.STYLE, !Y.STYLE, !X.S, !Y.S, !X.RANGE (!XMIN and !XMAX) and !Y.RANGE (!YMIN and !YMAX) are modified. Unless NOADJUST is set, the edges of the plot (!P.POSITION) are adjusted to fit the data. Then, when SETSCALE is called without any parameters, these parameters are returned to their original settings. System variables may be changed even if the routine exits with an error message. If SETSCALE is called without any parameters, then the modified system variables are restored to their original values. Additional graphics functions such as OPLOT will still be possible. Category : Utilities, Devices. Prev. Hist. : William Thompson, Feb. 1991. William Thompson, Oct. 1991, added !ASPECT system variable. William Thompson, May 1992, added common block and changing viewport. William Thompson, Nov. 1992, changed structure of common block, and removed support for changing viewport. William Thompson, Nov. 1992, changed to use GET_VIEWPORT instead of INIT_SC1_SC4, and to restore original !P.POSITION when called with no parameters. William Thompson, December 1992, changed common block to keep better track of the state of the system variables. Written : William Thompson, GSFC, February 1991. Modified : Version 1, William Thompson, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : SETVIEW Purpose : Switch between several plots on one page. Explanation : SETVIEW modifies the viewport parameters !SC1, !SC2, !SC3 and !SC4 to allow several plots on one page, arranged horizontally and/or vertically. Calling SETVIEW with nontrivial parameters also sets !NOERAS to 1. New plots must be started with an explicit ERASE command. Calling SETVIEW without any parameters, or IX,NX and IY,NY all equal to 1 resets the viewport, and sets !NOERAS to 0. Recalling SETVIEW with the same parameters as before will restore the system variables associated with that setting. This allows the user to switch between several plots without losing the scaling information associated with each. Note that when switching between windows that both WSET and SETVIEW must be called each time for this to work. Alternatively, SETWINDOW can be used to switch between windows. Use : SETVIEW [, IX, NX [, IY, NY [, SX [, SY ]]]] Inputs : None required. Calling SETVIEW without any parameters resets to the default behavior. Opt. Inputs : IX, NX = Relative position along X axis, expressed as position IX out of a possible NX, from left to right. If not passed, then 1,1 is assumed. IY, NY = Relative position along Y axis, from top to bottom. If not passed, then 1,1 is assumed. SX = Multiplication factor for space between plots in X direction. A value of SX between 0 and 1 decreases the amount of space between plots, a value greater than 1 increases the amount of space. If not passed, then 1 is assumed. SY = Multiplication factor for space between plots in Y direction. If not passed, then 1 is assumed. Outputs : None. Opt. Outputs: None. Keywords : None. Calls : ADD_VIEWPORT, SETSCALE, TRIM Common : VIEWPORT = Contains data to maintain information about the viewports as a function of graphics device and window. Restrictions: IX must be between 1 and NX. IY must be between 1 and NY. SX and SY must not be negative. This routine must be called separately for each graphics device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: The system variable !NOERAS is changed. Any SETSCALE settings will be lost. Category : Utilities, Devices. Prev. Hist. : William Thompson Applied Research Corporation September, 1988 8201 Corporate Drive Landover, MD 20785 William Thompson, Nov 1992, changed common block to allow system variables to be saved between multiple plots. Also added call to disable possible SETSCALE settings. Written : William Thompson, GSFC, September 1988. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 4 January 1994. Fixed bug where original state was not being completely restored. Version : Version 2, 4 January 1994.
Project : SOHO - CDS
Name :
SETWINDOW
Purpose :
Switch between windows, retaining parameters for each.
Explanation :
SETWINDOW stores the plot parameters for the current window in a common
block, switches to the desired window, and restores the plot parameters
from the last time that window was used.
Use :
SETWINDOW [, WINDOW ]
Inputs :
None required.
Opt. Inputs :
WINDOW = Number of window to switch to. If not passed, then the
parameters for the current window are saved.
Outputs :
None.
Opt. Outputs:
None.
Keywords :
SHOW : call WSHOW
Calls :
ADD_WINDOW, SETSCALE, TRIM
Common :
SETWINDOW = Contains WINDOWS, and the structure SAVE which contains the
graphics system variables.
Restrictions:
WINDOW must be a valid, existing window.
Creating a new window with the WINDOW command will also switch to that
window. To save the settings for the current window, call SETWINDOW
before calling WINDOW.
In general, the SERTS graphics devices routines use the special system
variables !BCOLOR and !ASPECT. These system variables are defined in
the procedure DEVICELIB. It is suggested that the command DEVICELIB be
placed in the user's IDL_STARTUP file.
Side effects:
Certain system variables from the previous time the window was used are
recalled.
Any SETSCALE settings will be lost.
Category :
Utilities, Devices.
Prev. Hist. :
William Thompson Applied Research Corporation
November, 1992 8201 Corporate Drive
Landover, MD 20785
Written :
William Thompson, GSFC, November 1992.
Modified :
Version 1, William Thompson, GSFC, 27 April 1993.
Incorporated into CDS library.
Version 1.1, Dominic Zarro, (ARC/GFSC), 15 December 1994.
Added WSHOW
Version :
Version 1.1, 15 December 1994.
Project : SOHO - CDS Name : SHOW_QUEUE Purpose : Show the contents of a print queue. Explanation : Spawns the proper command to the operating system to display the contents of print queues. Use : SHOW_QUEUE [, QUEUE ] Inputs : None required. Opt. Inputs : QUEUE = Name of queue to be listed. If not passed, then the environment variable PSLASER (or PSCOLOR) is checked for the name of the print queue. Outputs : The information about the print queue is printed to the terminal screen. Opt. Outputs: None. Keywords : COLOR = If set, then the environment variable PSCOLOR is checked for the name of the print queue rather then PSLASER. Ignored if QUEUE is passed. Calls : TRIM Common : None. Restrictions: In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: None. Category : Utilities, Devices. Prev. Hist. : William Thompson, July 1992. Written : William Thompson, GSFC, July 1992. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : SUNVIEW Purpose : Switch to SunView mode. Explanation : SETPLOT is called to save and set the system variables. Use : SUNVIEW Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : William Thompson Written : William Thompson, GSFC. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 21 October 1993. Renamed to SUNVIEW. Version : Version 2, 21 October 1993.
Project : SOHO - CDS Name : TEK Purpose : Sets graphics device to Tektronix 4010 mode. Explanation : SETPLOT is called to save and set the system variables. Use : TEK Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : W.T.T., Nov. 1987. Written : William Thompson, GSFC, November 1987. Modified : Version 1, William Thompson, 27 April 1993. Renamed to TEK, and incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : TEK4105 Purpose : Sets the graphics device for Tektronix 4105 terminals. Explanation : SETPLOT is called to save and set the system variables. Then DEVICE is called to enable TEK4100 mode with 8 colors. Use : TEK4105 Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : W.T.T., Nov. 1987. W.T.T., Mar. 1991, split TEK into TEK4105 and TEK4211. Written : William Thompson, GSFC, November 1987. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : TEK4211 Purpose : Sets graphics device for Tektronix 4211 color terminal. Explanation : SETPLOT is called to save and set the system variables. Then DEVICE is called to enable TEK4100 mode with 64 colors. Use : TEK4211 Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Device. Prev. Hist. : W.T.T., Nov. 1987. W.T.T., Mar. 1991, split TEK into TEK4105 and TEK4211. Written : William Thompson, GSFC, November 1987. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : TEKMONO Purpose : Sets graphics device for Tek 4100+ terminals, mono mode. Explanation : SETPLOT is called to save and set the system variables. Then DEVICE is called to enable TEK4100 mode with 2 colors (black and white). Use : TEKMONO Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : W.T.T., Nov. 1987. W.T.T., Mar. 1991, split TEK into TEKMONO and TEK4211. Written : William Thompson, GSFC, November 1987. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version : Version 1, 27 April 1993.
Project : SOHO - CDS Name : WIN Purpose : Switch to Microsoft Windows mode. Explanation : SETPLOT is called to save and set the system variables. Use : WIN Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : None. Written : William Thompson, GSFC, 15 June 1993. Modified : Version 1, William Thompson, GSFC, 15 June 1993. Version : Version 1, 15 June 1993.
Project : SOHO - CDS Name : XWIN Purpose : Switch to X-windows mode. Explanation : SETPLOT is called to save and set the system variables. Use : XWIN Inputs : None. Opt. Inputs : None. Outputs : A message is printed to the screen. Opt. Outputs: None. Keywords : None. Calls : SETPLOT Common : None. But calls SETPLOT, which uses common block PLOTFILE. Restrictions: It is best if the routines TEK, REGIS, etc. (i.e. those routines that use SETPLOT) are used to change the plotting device. In general, the SERTS graphics devices routines use the special system variables !BCOLOR and !ASPECT. These system variables are defined in the procedure DEVICELIB. It is suggested that the command DEVICELIB be placed in the user's IDL_STARTUP file. Side effects: If not the first time this routine is called, then system variables that affect plotting are reset to previous values. Category : Utilities, Devices. Prev. Hist. : William Thompson Written : William Thompson, GSFC. Modified : Version 1, William Thompson, GSFC, 27 April 1993. Incorporated into CDS library. Version 2, William Thompson, GSFC, 21 October 1993. Renamed to XWIN. Version : Version 2, 21 October 1993.