# toImage.pro

At APS this program is installed in the /usr/local/epics/extensions/bin/$HOST_ARCH directory. This is a utility program for extracting 1D scans and created 2D images. This program normally is invoked by toimage script.

# List of Routines

- SCAN_READ_EXTRACT
- TOIMAGE

# Routine Descriptions

## SCAN_READ_EXTRACT

[Next Routine] [List of Routines]

     NAME:
           SCAN_READ_EXTRACT

     PURPOSE:
           This routine provides the data catcher user a way of creating 2D
           images from the 1D scans.  Normally, 2D image are automatically
           saved by the data catcher.  Only if something abnomal happened
           during data acqusition and 2D images did not get saved, then
           this routine can be used to create the images.

           Normally this routine is automatically invoked by the TOIMAGE
           widgets program.

     CATEGORY:
           catcher_v1 utility routine.

     CALLING SEQUENCE:

           SCAN_READ_EXTRACT, Startno=startno, Endno=endno, Infile='infile',
               Outfile=outfile, View=view, New=new, Y_PV='scan2.pvname',/XDR

     INPUTS:
           None.

     KEYWORD PARAMETERS:
           INFILE:     Specifies the file name used by the data catcher 1D scan

           STARTNO:    Specifies 1D scan # at the beginning of 2D scan

           ENDNO:      Specifies 1D scan # at the end of 2D scan

           VIEW:       Set this keyword each scan will be sequentially displayed
                       in the data catcher drawing area.

           OUTFILE:    Set this keyword the extracted images will be either
                       appended to the default image file or a new image file.

           NEW:        Set this keyword a new image file will be created.

           XDR:        Specifies the input file is in XDR binary format

           Y_PV:       Specifies the PV name for the 2D scan outer loop

     OUTPUTS:
           During 2D image construction the images are display on screen.

     COMMON BLOCKS:
           COMMON CATCH1D_COM
           COMMON realtime_block
           COMMON w_viewscan_block
           COMMON CATCH1D_2D_COM
           COMMON CATCH1D_2D_COMXY

     SIDE EFFECTS:
           The data catcher is automatically loaded into IDL.

     RESTRICTIONS:
           The data catcher must be loaded into IDL. Make sure the entered
           startno and endno are consistant with the 1D scan data.
           All the 1D scan should have same positioner array in order to
           have a meaningful 2D image data generated.

     PROCEDURE:
           This routine is automatcally loaded into IDL by loading toImage.pro

     EXAMPLE:
           Extract the scan # 31 to 109 from the file 'cancer21.scans'

           1) Screen preview only

              scan_read_extract,startno=31,endno=109,infile='cancer21.scans'

           2) Append images to default file 'cancer21.scans.image'

              scan_read_extract,startno=31,endno=109,infile='cancer21.scans', $
                     /OUTFILE

           2) Create new image file 'test.image'

              scan_read_extract,startno=31,endno=109,infile='cancer21.scans', $
                     outfile='test',/NEW

     MODIFICATION HISTORY:
           Written by:     Ben-chin Cha, 08-06-97.
    	xx-xx-xx   iii	comment

(See toImage.pro)

## TOIMAGE

[Previous Routine] [List of Routines]

     NAME:
           TOIMAGE

     PURPOSE:
           This program provides the data catcher user a way of creating 2D
           images from the 1D scans.  Normally, 2D image are automatically
           saved by the data catcher.  Only if something abnomal happened
           during data acqusition and 2D images did not get saved, then
           this program can be used to create the images.

     CATEGORY:
           Widgets.

     CALLING SEQUENCE:

           TOIMAGE

     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 TOIMAGE.
         VIEWONLY: To construct and view the 2D images from the 1D scan data

     OUTPUTS:
           During 2D image construction the images are display on screen.

     COMMON BLOCKS:
           COMMON TOIMAGE_BLOCK,widget_ids

     SIDE EFFECTS:
           The data catcher is automatically loaded into IDL.

     RESTRICTIONS:
           Same environment and IDL setup as the data catcher is required.
           Source the setup_ezcaIDL from the EPICS_EXTENSIONS/bin/$HOST_ARCH.

     PROCEDURE:
           This program is automatcally loaded into IDL by loading toImage.pro

     EXAMPLE:

           .run toImage
           TOIMAGE

     MODIFICATION HISTORY:
           Written by:     Ben-chin Cha, 08-06-97.
          05-15-1998  bkc  Automatically check the binary data type selected
          06-02-1998  bkc  Add the support of merging of two 2D images due to error;                       at 2D scan

(See toImage.pro)