Extended IDL Help

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: Wed Aug 20 11:05:56 1997.


List of Routines


Routine Descriptions

BOX_CURSOR

[Next Routine] [List of Routines]
 NAME:
	BOX_CURSOR

 PURPOSE:
	Emulate the operation of a variable-sized box cursor (also known as
	a "marquee" selector).

 CATEGORY:
	Interactive graphics.

 CALLING SEQUENCE:
	BOX_CURSOR, x0, y0, nx, ny [, INIT = init] [, FIXED_SIZE = fixed_size]

 INPUTS:
	No required input parameters.

 OPTIONAL INPUT PARAMETERS:
	x0, y0, nx, and ny give the initial location (x0, y0) and 
	size (nx, ny) of the box if the keyword INIT is set.  Otherwise, the 
	box is initially drawn in the center of the screen.

 KEYWORD PARAMETERS:
	INIT:  If this keyword is set, x0, y0, nx, and ny contain the initial
	parameters for the box.

	FIXED_SIZE:  If this keyword is set, nx and ny contain the initial
	size of the box.  This size may not be changed by the user.

	MESSAGE:  If this keyword is set, print a short message describing
	operation of the cursor.

 OUTPUTS:
	x0:  X value of lower left corner of box.
	y0:  Y value of lower left corner of box.
	nx:  width of box in pixels.
	ny:  height of box in pixels. 

	The box is also constrained to lie entirely within the window.

 COMMON BLOCKS:
	None.

 SIDE EFFECTS:
	A box is drawn in the currently active window.  It is erased
	on exit.

 RESTRICTIONS:
	Works only with window system drivers.

 PROCEDURE:
	The graphics function is set to 6 for eXclusive OR.  This
	allows the box to be drawn and erased without disturbing the
	contents of the window.

	Operation is as follows:
	Left mouse button:   Move the box by dragging.
	Middle mouse button: Resize the box by dragging.  The corner
		nearest the initial mouse position is moved.
	Right mouse button:  Exit this procedure, returning the 
			     current box parameters.

 MODIFICATION HISTORY:
	DMS, April, 1990.
	DMS, April, 1992.  Made dragging more intutitive.
	June, 1993 - Bill Thompson
			prevented the box from having a negative size.
       04-18-96   bkc  Made the box color more visible.

(See catcher_v1.pro)


CATCHER_V1

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
	CATCHER_V1

 PURPOSE:
       EPICS 3.12.2 Scan record data acquistion tool.

       This program provides the EPICS user a convenient IDL data 
       acquistion tool.  It calls the IDL external CA functions which 
       are defined in the ezcaIDL package. 

       Currently, this program can capture both 1D and 2D scan data
       through setting monitor on the EPICS scan record. During data
       acquisition it also provides real-time plotting. Post acquisition
       it also provides primitive 1D and 2D post data plot and analysis. 
       Each scan record can support up-to four positioners and fifteen
       detectors."

 CATEGORY:
	Widgets. 

 CALLING SEQUENCE:
	CATCHER_V1 

 INPUTS:
	None

 KEYWORD PARAMETERS:
     CONFIG:   Specifies the configuration file to be saved when data
               catcher is normally terminated. If not specified, the 
               default configuration file name 'catch1d.config' is 
               assumed.
     DATA:     Specifies the data file name to be used for appending 
               new captured scan data. If not specified, the default 
               data file name 'catch1d.trashcan' is assumed.
     ENVFILE:  Specifies the environment (process variables) file to
               be saved with the captured scan data. If not specified,
               the default environment file name 'catch1d.env' is 
               assumed.
     NOSAVE:   Turns off the autosave feature. If it is specified, the
               data catcher will be able to display the life data but
               data will not be recorded.
     VIEWONLY: Runs the data catcher as a scan data browser. If it is 
               specified, it can only display the recorded scan data 
               from a saved data file. 
     GROUP:    The widget ID of the group leader of the widget.  If this 
               keyword is specified, the death of the group leader results in
               the death of CATCHER_V1.

 OUTPUTS:
       It provides realtime plot and various post acquistion 1D and
       2D surface plot. In addition of DATA file is saved, if 2D scan 
       is detected the DATA.image file will also be saved at the end 
       of 2D scan. Various levels of report files can also be generated 
       by this program.  All the file generated will be prefixed by the 
       DATA file name.

 COMMON BLOCKS:
       CATCH1D_COM
       W_PLOTSPEC_BLOCK
       W_VIEWSCAN_BLOCK
       REALTIME_BLOCK 
       ENV_FIELD_BLOCK
       FIELD_BLOCK

 SIDE EFFECTS:
       It is capable to detect scan invoked by outside channel access
       client.

 RESTRICTIONS:
       Supports EPICS 3.12.2 and later scan record.

 PROCEDURE:
       For live data acquisition: boot the IOC first, setup and initialize
       the scan records, setup the run ezcaIDL environment, run IDL,
       then start up the data catcher at the IDL prompt. 
       
       A simplified UNIX script file catcher can be used for starting up 
       this program. For help on catcher enter "catcher -h" at the UNIX
       prompt.

 EXAMPLE:
       Use default setting for config, envfile, and data file

       CATCHER_V1

       Override the default setting for config, envfile, and data file, 
       the 'test' is used for this example.

       CATCHER_V1, CONFIG='test.config', ENVFILE='test.env', DATA='test.dat'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 02-27-96.

       04-16-96  bkc  - Reduce the data catcher window size by moving scan 
                        pvname entries to a pop up setup window 
                      - Realtime trend plot against the real time axis is 
                        implemented
                      - Realtime plot also displays the scan record name
                      - Fix various miscellaneous replot bugs
                      - Add option of accessing HTML documents on help menu 

       04-29-96 bkc   - Modified pv status, main window manager, release
                        note 1.4
       09-30-96 bkc   - Implemented more new features, dialog windows, 
                        exceptional catches, check for non saved scan
                        data, improve the efficiency, release note 1.5.1 
                        etc...
       11-07-96 bkc   - Monitor positioner readback name, debug option,
                        various realtime plot option
       12-13-96 bkc   - Modified index file updating, aborting 2D scan,
                        image file location, report location
       07-23-97 bkc   - Added image strip to show all 15 detectors 2D image 
                        (two sizes are available); 
                        Added the support for different operating system, eg
                        UNIX or W95 (see SYSTEM_BLOCK, os.init);
                        Modified to run under IDL4.0.1 as well as IDL5.0 
       08-08-97 bkc   - Release R2.1 changes
                        Fix the problem of 'No Save', wrong X, Y array due 
                        to user aborting 2D scans from the MEDM screen
                        Database desc info for detectors are added to 
                        the 2D image data

(See catcher_v1.pro)


CW_TERM

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
	cw_term

 PURPOSE:
      writtable text window widget

 CATEGORY:
	Compound widgets.

 CALLING SEQUENCE:
	widget_id = CW_TERM(parent)

 INPUTS:
       PARENT - The ID of the parent widget.

 KEYWORD PARAMETERS:
	BGROUP_NAMES:	An array of strings to be associated with
			each button and returned in the event structure as VALUE.
	BGEVENT_FUNCT:	The name of an user-supplied event function 
			for the buttons. This function is called with the return
			value structure whenever a button is pressed, and 
			follows the conventions for user-written event
			functions.
	FONT:		The name of the font to be used for the text output 
			If this keyword is not specified, the default
			font is used.
	FRAME:		Specifies the width of the frame to be drawn around
			the base.
       FILENAME:       Copy contents of file into widget
       RESET:          Clear existing widget contents and write new value/file.
                       The parent widget is the existing widget id. 
	MAP:		If set, the base will be mapped when the widget
			is realized (the default).
	SCROLL:		If set, the base will include scroll bars to allow
			viewing a large text area through a smaller viewport.
	SET_VALUE:	The initial value of the text widget. This is equivalent
			to the later statement:

			WIDGET_CONTROL, widget, set_value=value

       TITLE:          New Window title
	UVALUE:         The user value for the compound widget

	XSIZE:		The width of the text widget
	YSIZE:		The height of the text widget

 OUTPUTS:
       The ID of the created widget is returned.

 COMMON BLOCKS:
	None.

 SIDE EFFECTS:

 PROCEDURE:
	WIDGET_CONTROL, id, SET_VALUE=value can be used to change the
		current value displayed by the widget.

	WIDGET_CONTROL, id, GET_VALUE=var can be used to obtain the current
		value displayed by the widget.

 MODIFICATION HISTORY:
  01  8-9-95  jps  	modified from idl's cw_tmpl.pro

(See catcher_v1.pro)


OS_INIT

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
	OS_INIT

 PURPOSE:
       Defines the structure of main operating system variables. All the 
       operating system dependent varibles used in data catcher are 
       assembled in this routine. 

 CATEGORY:
       Global System Variables !os.

 CALLING SEQUENCE:
       OS_INIT

 PARAMETER FIELDS:
       ARCH:           IDL detected operating system architecture
       OS:             IDL detected operating system 
       OS_FAMILY:      IDL detected operating system family
       RELEASE:        IDL release number
       FONT:           Bold font used in highlight label in dialog
       DEVICE:         Default output device
       FILE_SEP:       Operating sytem file separator, '/' for unix '\' for W95
       CHMOD:          Command change file permission mode, 'chmod'
       MV:             Command rename file, 'mv' for unix, 'rename' for W95
       CP:             Command copy file, 'cp' for unix, 'copy' for W95
       RM:             Command remove file, 'rm' for unix, 'del' for W95
       LPR:            Command print PS file, 'lpr' for unix, 'print' for W95
       PRT:            Command print text file, 'enscript' for unix, 'print' for W95
       PRINTER:        Default printer name, '' 
       WC:             Command return line count, 'wc' for unix

 COMMON BLOCKS:
       COMMON SYSTEM_BLOCK

 SIDE EFFECTS:
       This routine defines the OS_SYSTEM structure and the global 
       system variable !os. All the system dependent varialbes used in
       data catcher and data viewer are kept in this routine.

 RESTRICTIONS:
       Current version works for Unix and W95 operating system. 

 PROCEDURE:
       Porting to other operating system, the corresponding
       fields in 'os.init' may need to be modified accordingly.

 EXAMPLE:

               OS_INIT

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 6-01-97.
       xx-xx-xx iii  - comment

(See catcher_v1.pro)


PS_CLOSE

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       PS_CLOSE

 PURPOSE:
       This routine closes the PostScript output device and resets the
       the original system graphic device as the output plot device.

 CALLING SEQUENCE:
       PS_CLOSE

 INPUTS:
       None.

 OUTPUTS:
       None.

 KEYWORD PARAMETERS:
       None.

 COMMON BLOCKS:
       COMMON SYSTEM_BLOCK
       COMMON COLORS 

 RESTRICTIONS:
       The program 'PS_open.pro' must be loaded into IDL prior calling
       this routine. 

 EXAMPLE:

        PS_OPEN, 'myfile.ps'
        tvscl,scan
        PS_CLOSE

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       07-28-97   bkc  Add the support for reverse PostScript color scheme. 
                       Add handling capability for different operating system

(See catcher_v1.pro)


PS_ENSCRIPT

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       PS_ENSCRIPT

 PURPOSE:
       This routine uses the system printing command to print
       an ASCII text file. On unix operating system the command
       'enscript -r' is used. 

 CALLING SEQUENCE:
       PS_ENSCRIPT, 'filename'

 INPUTS:
       filename : Specifies the ASCII filename to be printed.

 OUTPUTS:
       A copy of the specified file is sent to the user selected  
       printer.

 KEYWORD PARAMETERS:

 COMMON BLOCKS:
       COMMON SYSTEM_BLOCK

 RESTRICTIONS:
       The program 'PS_open.pro' must be loaded into IDL prior calling
       this routine. 

 EXAMPLE:

        PS_ENSCRIPT, 'myfile'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       07-28-97   bkc  Add handling capability for different operating system

(See catcher_v1.pro)


PS_OPEN

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       PS_OPEN

 PURPOSE:
       This routine sets the current graphics device to PostScript.
       and saves plot in a user specified PostScript file.

 CALLING SEQUENCE:
       PS_OPEN, 'myfile.ps' [,/TV]

 INPUTS:
       myfile.ps:  Specifies the PostScript filename to be saved.

 OUTPUTS:
       The PostScript graphic output is saved which can be sent to
       any PostScript printer or viewer. 

 KEYWORD PARAMETERS:
       TV:       Specifies whether reverse color video to be used in PS. 

 COMMON BLOCKS:
       COMMON PRINTER_BLOCK
       COMMON COLORS 

 RESTRICTIONS:
       The program 'PS_open.pro' must be loaded into IDL first before 
       calling this routine.

 EXAMPLE:

        PS_OPEN, 'myfile.ps'
        tvscl,scan
        PS_CLOSE

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       07-28-97   bkc  Add the support for color PostScript
                       Add the support for reverse video
                       Add handling capability for different operating system

(See catcher_v1.pro)


PS_PRINT

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       PS_PRINT

 PURPOSE:
       This routine uses the system printing command to print
       a PostScript or ASCII text file. On the unix operating 
       system the command 'lpr' is used. 

 CALLING SEQUENCE:
       PS_PRINT, 'myfile.ps'

 INPUTS:
       myfile:    Specifies either the PostScript or ASCII text filename 
                  to be printed.

 OUTPUTS:
       A copy of the specified file is sent to the user selected  
       printer.

 KEYWORD PARAMETERS:

 COMMON BLOCKS:
       COMMON SYSTEM_BLOCK

 RESTRICTIONS:
       The program 'PS_open.pro' must be loaded into IDL prior calling
       this routine. 

 EXAMPLE:

        PS_PRINT, 'myfile.ps'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       07-28-97   bkc  Add handling capability for different operating system

(See catcher_v1.pro)


PS_PRINTER

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
	PS_PRINTER

 PURPOSE:
       This widget dialog allows the user to set up PostScript printer
       and printer name to be used by the IDL session. Default setting
       is color PS using default printer.

 CATEGORY:
       Widgets.

 CALLING SEQUENCE:
       PS_PRINTER [,GROUP=Group]

 INPUTS:
       None.
	
 KEYWORD PARAMETERS:
       GROUP:  The widget ID of the group leader of the widget. If this 
               keyword is specified, the death of the group leader results in
               the death of PS_PRINTER.

 OUTPUTS:

 COMMON BLOCKS:
       COMMON PRINTER_BLOCK

 SIDE EFFECTS:
       Initially the system printer is set to the user's default 
       printer. If a null printer name is specified, whatever the 
       system printer was previously set will be used. 

 RESTRICTIONS:
       The program 'PS_open.pro' must be loaded into IDL prior calling
       this routine. 
       
 PROCEDURE:
      
 EXAMPLE:

               PS_PRINTER

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 6-01-97.
       xx-xx-xx bkc  - comment

(See catcher_v1.pro)


U_BI2XDR

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_BI2XDR

 PURPOSE:
       This IDL routine converts native binary data into platform-independent
       XDR binary data. 

       The input file should contain only pure native binary data.
       The output filename uses the input filename suffixed with '.xdr'.

 CALLING SEQUENCE:

       U_BI2XDR, 'filename' [,/Help]

 INPUTS:
       filename:   The data file should contain pure binary data objects.

 OUTPUTS:
       filename.xdr:   Output file. 
                   It contains the converted XDR binary data objects.

 KEYWORD PARAMETERS:
       HELP:   If this keyword is set, a simple on line help is given.

 RESTRICTIONS:
       The input data file should contain pure binary data objects.

 EXAMPLE:

        U_BI2XDR,'catch1d.trashcan'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 05-30-97.

       xx-xx-xx      iii  comment     

(See catcher_v1.pro)


U_CLOSE

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_CLOSE

 PURPOSE:
       This routine closes a file LUN opened for unformmated I/O.

 CALLING SEQUENCE:

       U_CLOSE, Unit

 INPUTS:
       Unit:     The LUN number to be closed.

 OUTPUTS:
       None.

 EXAMPLE:

        U_CLOSE, unit

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       xx-xx-xx      iii  comment     

(See catcher_v1.pro)


U_OPENR

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_OPENR

 PURPOSE:
       This routine assigns a LUN to the opened file for unformatted
       read only.

 CALLING SEQUENCE:

       U_OPENR, Unit, 'filename' [,/XDR] [,/Help]

 INPUTS:
       filename: Specifies the filename to be read by the U_READ 
                 command.

 OUTPUTS:
       Unit:     The LUN number to be associated with the opened file.

 KEYWORD PARAMETERS:
       XDR:      This keyword specifies that the file is opened for 
                 reading data in platform-independent XDR binary form. 
       HELP:     If this keyword is set, a simple on line help is given.

 RESTRICTIONS:
       The data file should contain only consistant type of binary 
       objects: either native binary data or platform-independent 
       XDR data. No mixture type is allowed.

 EXAMPLE:

        U_OPENR, unit, 'catch1d.trashcan'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       xx-xx-xx      iii  comment     

(See catcher_v1.pro)


U_OPENW

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_OPENW

 PURPOSE:
       This routine assigns a LUN to the opened file for unformatted
       write only.

 CALLING SEQUENCE:

       U_OPENW, Unit, 'filename' [,/Append] [,/XDR] [,/Help]

 INPUTS:
       filename: Specifies the filename to be created or opened for
                 data recording through using the U_WRITE command.

 OUTPUTS:
       Unit:     The LUN number to be associated with the opened file.

 KEYWORD PARAMETERS:
       APPEND:   This keyword specifies that the file is opened for 
                 data appending. If not specified, write on the unit
                 will replace the old file content by the new data.
       XDR:      This keyword specifies that the file is opened for 
                 writing data in platform-independent XDR binary form. 
       HELP:     If this keyword is set, a simple on line help is given.

 RESTRICTIONS:
       The data file should contain only consistant type of binary 
       objects: either native binary data or platform-independent 
       XDR data. No mixture type is allowed.

 EXAMPLE:

        U_OPENW, unit, 'catch1d.trashcan'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       xx-xx-xx      iii  comment     

(See catcher_v1.pro)


U_READ

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_READ

 PURPOSE:
       This routine reads an unformatted data entity from a file unit which is
       opened for unformatted read. It supports all IDL data type except the
       complex number and up to 2D array.  

 CALLING SEQUENCE:

       U_READ, Unit, Var [,/Help]

 INPUTS:
       Unit:   The logic unit number returned by file open for unformatted
               read.
	
 KEYWORD PARAMETERS:
       HELP:   If this keyword is set, a simple on line help is given.

 OUTPUTS:
       Var:    This variable holds the right type of data obtained from 
               the opened file, it can be either 1D vector, or 2D array.

 RESTRICTIONS:
       All the data must be created by the U_WRITE routine in order to be 
       read by this routine.

 EXAMPLE:

       Read the first data entity from the 'test.dat' which was previously
       created by the U_WRITE routine.

         u_openr,unit,'test.dat'
         u_read, unit, X
         u_close,unit

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       05-30-97	bkc	Support opened file as XDR type data.

(See catcher_v1.pro)


U_REWIND

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_REWIND

 PURPOSE:
       This routine locates the LUN file pointer at the beginning of the 
       file.

 CALLING SEQUENCE:

       U_REWIND, Unit

 INPUTS:
       Unit:     The LUN number to be rewind.

 OUTPUTS:
       None.

 EXAMPLE:

        U_REWIND, unit

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       07-25-97      bkc  Rename routine rewind to u_rewind     

(See catcher_v1.pro)


U_WRITE

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       U_WRITE

 PURPOSE:
       This routine writes an IDL data array to a file unit which is
       opened for unformatted write. It supports all IDL data type except the
       complex number and up to 2D array.  

 CALLING SEQUENCE:

       U_WRITE, Unit, Var [,/Help]

 INPUTS:
       Unit:   The logic unit number returned by file open for unformatted
               write.

       Var:    This variable holds the data  array to be written to
               the opened file, it can be scaler, vector, or 2D array.
	
 KEYWORD PARAMETERS:
       HELP:   If this keyword is set, a simple on line help is given.


 RESTRICTIONS:
       The data array can not be complex number. In order to make the
       data to be read by the U_READ routine, all the data saved must 
       be using this routine. 

 EXAMPLE:

       Create the 'test.dat'  and write the variable X to the file

         u_openw,unit,'test.dat'
         u_write, unit, X
         u_close,unit

       Create or append X to the 'test.dat'  

         u_openw,unit,'test.dat',/append
         u_write, unit, X
         u_close,unit

       Create XDR platform independent data to the 'test.dat'  

         u_openw,unit,/XDR,'test.dat'
         u_write, unit, X
         u_close,unit

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 03-23-95.

       05-30-97	bkc	Support opened file as XDR type data.

(See catcher_v1.pro)


VIEW1D

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       VIEW1D	

 PURPOSE:

       This program is specially written for the data catcher. It
       provides the IDL user a convenient post data acquisition
       1D data display program. It shares the common 1D data file
       with data catcher without interrupting the process of data
       scanning of data catcher.

 CATEGORY:
	Widgets. 

 CALLING SEQUENCE:
	VIEW1D [,Data='test.dat'] [,Config='test.config'] [,/XDR] [GROUP=Group] 

 INPUTS:
	None

 KEYWORD PARAMETERS:
     CONFIG:   Specifies whether the configuration file to be used in the 
               startup of the VIEW1D.
     DATA:     Specifies the 1D file name to be used for displaying 
               captured 1D scan data. If not specified, the default 
               data file name 'catch1d.trashcan' is assumed.
     XDR:      Indicates whether the data file entered on the command line is
               in XDR format.
     GROUP:    The widget ID of the group leader of the widget.  If this 
               keyword is specified, the death of the group leader results in
               the death of VIEW1D.

 OUTPUTS:
       It provides various post acquistion 1D scan displaying features. 
       Various levels of report files can be generated by this program.  
       All the file generated will be prefixed by the DATA file name.

 COMMON BLOCKS:
       VIEW1D_COM
       W_PLOTSPEC_BLOCK
       W_VIEWSCAN_BLOCK

 SIDE EFFECTS:
       New scan data may be appended at the end of data file if the
       data catcher is runing at the same time and new data 
       is detected by the data catcher. Reload the data file will
       let you access the newly captured scan data from the file.

 RESTRICTIONS:

 PROCEDURE:
       The 'os.init' must be loaded into IDL before invoking the 
       VIEW1D application.

 EXAMPLE:
       Use default setting for view1d 

       	VIEW1D

       Override the default setting by specifying config and data file
       on the command line

       	VIEW1D, CONFIG='test.config', DATA='test.dat'

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 05-27-97.

       08-01-97  bkc   Add the 2D scan # in the header 

(See ~/test/idl/catcher/R1.5/view1d_drv.pro)


VIEW1D_OVERLAY

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       VIEW1D_OVERLAY	

 PURPOSE:

       This program is specially written for the data catcher. It
       allows the data catcher user overlay few 1D scans on the same 
       plot for a selected detector.

 CATEGORY:
	Widgets. 

 CALLING SEQUENCE:
	VIEW1D_OVERLAY [,'filename'] [,/XDR] [,GROUP=Group] 

 INPUTS:
	None

 KEYWORD PARAMETERS:
     filename: Specifies the 1D file name to be used for displaying 
               captured 1D scan data. If not specified, the default 
               data file name 'catch1d.trashcan' is assumed.
     XDR:      Required it the input data file is in XDR platform-
               independent binary form.
     GROUP:    The widget ID of the group leader of the widget.  If this 
               keyword is specified, the death of the group leader results in
               the death of VIEW1D.

 OUTPUTS:
       It uses the general purpose 1D plot plackage to overlay plot the 
       selected scans. The window is resizable by the X window manager.

 COMMON BLOCKS:
       COMMON  MULTI_BLOCK, multi_ids

 SIDE EFFECTS:
       It can be invoked by the script catcher_V1D as a stand along 
       program.

 RESTRICTIONS:
       Only native binary data is allowed.

 PROCEDURE:
       The path to this program must be included in the IDL search
       path.

 EXAMPLE:
       Use default setting for view1d_overlay 

       	VIEW1D_OVERLAY

       Override the default setting by specifying the data file
       on the command line

       	VIEW1D_OVERLAY, 'test.dat.xdr', /XDR

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 05-27-97.

       07-25-97  bkc   Rename the catcher_view1d to view1d_overlay.
                       Add the support for XDR data format.

(See view1d_overlay.pro)


VIEW2D

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       VIEW2D	

 PURPOSE:
       This program provides the EPICS user a convenient IDL 2D scan data 
       display tool.  Its input image file is automatically saved by the  
       data catcher program CATCHER_V1. 

       Currently, this program provides TV, SURFACE, CONTOUR, SHOW3, and 
       XSURFACE plot. It also provides simple xz, yz line plot and data
       value query information.

 CATEGORY:
	Widgets. 

 CALLING SEQUENCE:
	VIEW2D

 INPUTS:
       None.	

 KEYWORD PARAMETERS:
     GROUP:    The widget ID of the group leader of the widget.  If this 
               keyword is specified, the death of the group leader results in
               the death of VIEW2D.

     FILE:    The input image file name.  If this keyword is specified, the
              file should contain the image data must be in the data catcher
              created format. 
          
     XDR:     If specified, indicates that the input is in XDR format.

 OUTPUTS:
       It provides option of postscript plot of drawing area.

 COMMON BLOCKS:
       None.

 RESTRICTIONS:
	Drawing area is 460 x 400 pixels.

 PROCEDURE:
       This program is available as an epics/extensions tool. It can be
       directly accessed from the view data menu of the CATCHER_V1.  
 
 EXAMPLE:
       VIEW2D

 MODIFICATION HISTORY:
       Written by:     Ben-chin K. Cha, 02-27-96.
       04-29-96 bkc  Add image button, 2d scan #, on-line help      	
       09-30-96 bkc  Add cross hair to reflect the cursor position      	
       11-21-96 bkc  Text window image out include x,y array vales     	
		      Option of save and load private color map
                     Take care out of sync 2D scan #
                     Modify XZ, YZ profile distributions
       12-13-96 bkc  Add zoom-in, zoom-off, printer support,
                     color PS plot, rewrite TV, equal aspect TV
                     ratio, reverse PS video, cursor features, etc
       04-11-97 bkc  Call the MAX function to give the max location
       08-08-97 bkc  Release R2.1
                     Cursor position readout fixed by catcher R2.1
                     Fix the Y title cut off problem for PostScript 
                     More useful plots and printouts info for TV screen
                     and PostScript output
                        min, max values and locations
                        detector database  description
                        positioner database description

(See ~/test/idl/catcher/R1.5/catch2d.pro)


XDISPLAYFILE

[Previous Routine] [List of Routines]
 NAME: 
	XDISPLAYFILE

 PURPOSE:
	Display an ASCII text file using widgets and the widget manager.

 CATEGORY:
	Widgets.

 CALLING SEQUENCE:
	XDISPLAYFILE, Filename

 INPUTS:
     Filename:	A scalar string that contains the filename of the file
		to display.  The filename can include a path to that file.

 KEYWORD PARAMETERS:
	FONT:   The name of the font to use.  If omitted use the default
		font.
	GROUP:	The widget ID of the group leader of the widget.  If this 
		keyword is specified, the death of the group leader results in
		the death of XDISPLAYFILE.

	HEIGHT:	The number of text lines that the widget should display at one
		time.  If this keyword is not specified, 24 lines is the 
		default.

	TEXT:	A string or string array to be displayed in the widget
		instead of the contents of a file.  This keyword supercedes
		the FILENAME input parameter.

	TITLE:	A string to use as the widget title rather than the file name 
		or "XDisplayFile".

	WIDTH:	The number of characters wide the widget should be.  If this
		keyword is not specified, 80 characters is the default.

 OUTPUTS:
	No explicit outputs.  A file viewing widget is created.

 SIDE EFFECTS:
	Triggers the XMANAGER if it is not already in use.

 RESTRICTIONS:
	None.

 PROCEDURE:
	Open a file and create a widget to display its contents.

 MODIFICATION HISTORY:
	Written By Steve Richards, December 1990
	Graceful error recovery, DMS, Feb, 1992.
       12 Jan. 1994  - KDB
               If file was empty, program would crash. Fixed.
       4 Oct. 1994     MLR Fixed bug if /TEXT was present and /TITLE was not.
      14 Jul. 1995     BKC Increased the max line to variable size.
      16 Jun. 1997     BKC Max dispalyable line is 10000 for non-unix OS system.

(See catcher_v1.pro)