Extended IDL Help

panimage.pro

At APS this program is installed in the /usr/local/epics/extensions/idllib directory for EPICS R3.14. This is a utility routine for generating the panImage on a plot device.

List of Routines

Routine Descriptions

PANIMAGE

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

 PURPOSE:
       This method pops up a new PanImage window for a given 2D scan 
       image_array.

 CALLING SEQUENCE:
       panImage, Image_array [,Id_def] [,Factor=1]  [,TIFF='tifname',/reverse]
		  [,TITLE='description'] [,DETNM=DetNm] [,ISEL=Isel]
                 [,NUMD=NumD]
                 [,GIF='pngname'] [,PICT='pictname'] [,ERROR=error]

 ARGUMENTS:
  Image_array:  Image_array(Width,Height,Ndets) specifies the 2D 
                image_array for all detectors, where each image has
                dimension of WidthxHeight, Ndets is the number of detectors
  id_def:       Id_def(Ndets) defines the vector of indicators for detector 
                image presence, 0 not present , 1 present 
  factor:       Specifies the multiplication factor for TV image, default
                TV image size is 60x60

 KEYWORDS:
     TITLE:   Specifies the title of the panImage window
     PNG:     Specifies the output png filename. If specified the
              panImage window will be saved in the png output file.
     PICT:    Specifies the output pict filename. If specified the
              panImage window will be saved in the pict output file.
     TIFF:    Specifies the output tiff filename. If specified the
              panImage window will be saved in the tiff output file.
     XDR:     Specifies the output XDR filename. If specified, 
              an XDR image_array will be saved.
     REVERSE: Specifies whether the reverse tiff should be saved.
     LABELON: Specifies whether to label the image.
     NEW_WIN: Returns the new window number of the panImages
     ISEL:    Specifies the image_array is an extracted subarray from the
              original array
     NUMD:    Specifies the number of image in a row 
     DETNM:   Override the detname used
     BID:     Return the top base widget id
     WID:     Returns the window id number

 EXAMPLE:
     
     panImage, image_array

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha, Mar 29, 2000.
       10-02-2001 bkc  Add window position keywords
	05-05-2003 bkc  Use slide_image window, add di/row button,
			add ascii report button etc..

(See panimage.pro)

PANIMAGE_SEL

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

 PURPOSE:
       This method pops up a PanImage selection dialog for a given 2D scan
       image_array.

 CALLING SEQUENCE:
       panImage_sel, Image_array, det_def [,TITLE='description'] [,DETNM=detnm]

 ARGUMENTS:
  Image_array:  Image_array(Width,Height,Ndets) specifies the 2D
                image_array for all detectors, where each image has
                dimension of WidthxHeight, Ndets is the number of detectors
  Det_def:      Det_def(Ndets) defines the vector of indicators for detector
                image presence, 0 not present , 1 present

 KEYWORDS:
     TITLE:     Specifies the title of the panImage window
     TIFF:      Specifies the output tiff file name 
     PATH:      Specifies the output data path
     DETNM:     Specifies the Ndets image ID names
     VERS:      Specifies the VERS contorl indicator 

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha, Mar 29, 2000.
       04-21-2003 bkc  Add ASCII... report generation button for selected image
       10-30-2003 bkc  Add version control

(See panimage.pro)

PANIMAGE_SLIDER

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

 PURPOSE:
       This method pops up a new PanImage window for a given 2D scan 
       image_array.

 CALLING SEQUENCE:
       panImage, Image_array [,Id_def] [,Factor=1]  [,TIFF='tifname',/reverse]
		  [,TITLE='description'] [,DETNM=DetNm] [,ISEL=Isel]
                 [,NUMD=NumD]
                 [,GIF='pngname'] [,PICT='pictname'] [,ERROR=error]

 ARGUMENTS:
  Image_array:  Image_array(Width,Height,Ndets) specifies the 2D 
                image_array for all detectors, where each image has
                dimension of WidthxHeight, Ndets is the number of detectors
  id_def:       Id_def(Ndets) defines the vector of indicators for detector 
                image presence, 0 not present , 1 present 
  factor:       Specifies the multiplication factor for TV image, default
                TV image size is 60x60

 KEYWORDS:
     TITLE:   Specifies the title of the panImage window
     PNG:     Specifies the output png filename. If specified the
              panImage window will be saved in the png output file.
     PICT:    Specifies the output pict filename. If specified the
              panImage window will be saved in the pict output file.
     TIFF:    Specifies the output tiff filename. If specified the
              panImage window will be saved in the tiff output file.
     XDR:     Specifies the output XDR filename. If specified, 
              an XDR image_array will be saved.
     REVERSE: Specifies whether the reverse tiff should be saved.
     LABELON: Specifies whether to label the image.
     NEW_WIN: Returns the new window number of the panImages
     ISEL:    Specifies the image_array is an extracted subarray from the
              original array
     NUMD:    Specifies the number of image in a row 
     DETNM:   Override the detname used
     BID:     Return the top base widget id
     WID:     Returns the window id number

 EXAMPLE:
     
     panImage_slider, image_array

 MODIFICATION HISTORY:
 	Written by:	Ben-chin Cha, Feb 23, 2003.
	xx-xx-xxxx bkc  comment

(See panimage.pro)