# dcviewer.pro

At APS this program is installed in the /usr/local/epics/extensions/bin/$HOST_ARCH directory. This program integrates the view1d, view2d, bi2xdr_converter programs into a single system This program normally is automatically invoked by the script command viewer.

# List of Routines

- BI2XDR_CONVERTER
- DCVIEWER

# Routine Descriptions

## BI2XDR_CONVERTER

[Next Routine] [List of Routines]

     NAME:
           BI2XDR_CONVERTER

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

     CATEGORY:
           Widgets.

     CALLING SEQUENCE:
           BI2XDR_CONVERTER [,file=file]  [,GROUP=Group]

     INPUTS:
           None.

     KEYWORD PARAMETERS:
           file:   Specifies the input data file name. The input file should
                   contain pure binary data objects.
           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 BI2XDR_CONVERTER.

     OUTPUTS:
           The output filename uses the input filename suffixed with '.xdr'.
           Output file contains the converted XDR binary data objects.

     COMMON BLOCKS:
           COMMON BI2XDR_BLOCK

     RESTRICTIONS:
           The input data file should contain pure native binary data objects.
           The 'os.init' and 'dcviewer.pro' must be loaded into IDL first.

     EXAMPLE:

           @os.init
           .RUN dcviewer
           BI2XDR_CONVERTER

     MODIFICATION HISTORY:
           Written by:     Ben-chin K. Cha, 06-01-97.

           xx-xx-xx      iii  comment

(See dcviewer.pro)

## DCVIEWER

[Previous Routine] [List of Routines]

     NAME:
    	DCVIEWER

     PURPOSE:
           This program integrates the view1D and view2D program into a single
           system. It provides 1D and 2D data viewing features for data
           catcher. It operates on the same set of data files generated by
           the data catcher.

           It is written in pure IDL language and it is platform-independent.
           It can read data either in native binary form or XDR binary form.

           It can be invoked as an XDR data converter to convert native data
           into XDR binary form.

     CATEGORY:
           Widgets.

     CALLING SEQUENCE:

           DCVIEWER [,DATA='1data'] [,FILE='1data.image'] [,/XDR] [,GROUP=Group]

     INPUTS:
           None.

     KEYWORD PARAMETERS:
           DATA:   Specifies the input filename for the 1D scan data on the
                   command line.
           FILE:   Specifies the input filename for the 2D image data on the
                   command line.
           XDR:    Starts the DCVIEWER as the XDR data convert program.
           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 DCVIEWER.

     OUTPUTS:
           It provides all the viewing and report features available in the
           EPICS data catcher except with the channel access functions been
           removed.

     COMMON BLOCKS:
           COMMON DCVIEWER_BLOCK
           COMMON BI2XDR_BLOCK

     SIDE EFFECTS:
           If the data catcher has appended new scan data on the same file,
           a user has to reload the data file to get the newly added scan
           data into the DCVIEWER.

     RESTRICTIONS:
           A complete package of DCVIEWER includes the following files:
              os.init
              dcviewer.pro
              view1d.init
              view1d.pro
              view1d_overlay.pro
              view2d.init
              view2d.pro
              plot1d.pro
           The path to these files must be included in the IDL_PATH. Before
           invoking DCVIEWER, the file 'os.init' must be loaded into IDL
           first.

     PROCEDURE:
           On the UNIX operating system, the script file 'viewer' can be
           used to directly invoke the data viewer. The environment, path
           settings, and running procedure are automatically taking cared
           by the script file 'viewer'.

     EXAMPLE:
           Start the DCVIEWER as scan data display package -
                   @os.init
                   dcviewer

           Start the DCVIEWER as an XDR data converter -
                   @os.init
                   dcviewer,/XDR

     MODIFICATION HISTORY:
           Written by:     Ben-chin K. Cha, 6-01-97.
           12-19-97 bkc  - Allows the access of the view1d_overlay program
                           Add the IDL> prompt dialog which let the user
                           run any IDL command

(See dcviewer.pro)