Extended IDL Help

scan2d_convert.pro

At present this program is installed in the /usr/local/epics/extensions/idllib directory for EPICS R3.14. This program is specially written for scan2d object, it provides the user with flexible object methods of reading / writing TIFF or GIF images for a list of desired image numbers.

List of Routines


Routine Descriptions

SCAN2D::READ_GIF

[Next Routine] [List of Routines]
 NAME:
       scan2d::READ_GIF

 PURPOSE:
       This method allows the user to read the GIF image from an GIF image
       file.  The GIF file must be created by the IDL WRITE_GIF routine.

 CALLING SEQUENCE:
       Obj->[scan2d::]READ_GIF, START_NO [,END_NO,GIF=gif] 
                 [,IMARRAY=imArray [,/NOVIEW]]

 ARGUMENTS:
    START_NO: the desired GIF image number selected  
    END_NO:   the terminated GIF image number from a multiple GIF image file 

 KEYWORDS:
    GIF:      specifiies the GIF file name to be used. If not given
              it is figured out from the START_NO and 2D image filename 
    IMARRAY:  return the 3D image array(500,500,end_no-start_no+1)
    NOVIEW:   if specified, no gif image verification is desired 
              

 EXAMPLE:
    Example 1 create and display the 20 gif image for the 'junk2.image' file. 

         v2=obj_new('scan2d',file='junk2.image')
	  v2->write_gif,20
         v2->read_gif,20

    Example 2 read images 4 to 8 from the gif file previously created by
    the obj->write_gif,/all method and return the extracted gif images
    in IMARRAY varible.

         v2=obj_new('scan2d',file='junk2.image')
         v2->write_gif,/all
         v2->read_gif,4,8,gif='junk2.image.gif',imarray=imarray,/noview

 MODIFICATION HISTORY:
       Written by:     Ben-chin Cha, May 4, 1999.
       xx-xx-xxxx      comment

(See scan2d_convert.pro)


SCAN2D::READ_TIFF

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       scan2d::READ_TIFF

 PURPOSE:
       This method allows the user to read a TIFF image file based on
       eishter the image seq no or the user specified tiff name.

 CALLING SEQUENCE:
       Obj->[scan2d::]READ_TIFF [,NO] [,TIFF=tiff]

 ARGUMENTS:
    NO:       a int variable to specify the input image sequence number.
    IM:       returns the im(500,500) array

 KEYWORDS:
    TIFF:     specifiies the output TIFF file name to be used. If not given
              the tiff file is automatically generated from the image filename.

 EXAMPLE:
    Save images 8 from the 'junk2.image' as a TIFF file.
    The junk2.image8.tiff will be saved by this command.
    The object v2 need to be defined only if it is not yet defined.

         v2 = obj_new('scan2d',file='junk2.image')
         v2->read_tiff,8

 MODIFICATION HISTORY:
       Written by:     Ben-chin Cha, May 4, 1999.
       xx-xx-xxxx      comment

(See scan2d_convert.pro)


SCAN2D::WRITE_GIF

[Previous Routine] [Next Routine] [List of Routines]
 NAME:
       scan2d::WRITE_GIF

 PURPOSE:
       This method allows the user to create a list of GIF image files
       based on the user specified list of image numbers. The name convention
       of each GIF file will be the image file suffixed with its image number 
       plus the '.gif'.

 CALLING SEQUENCE:
       Obj->[scan2d::]WRITE_GIF, LIST

 ARGUMENTS:
    LIST:     a string variable to specify the input image list
              each image will be saved as a separate gif file.

 KEYWORDS:
    GIF:      specifiies the output GIF file name to be used. If not given
              the gif file is automatically generated from the image filename.
    ALL:      If specified, then all the gif images of the 2D object will be 
              saved in the same output gif file.
    TYPE:     specifies the 2D view plot type

 EXAMPLE:
    Save images 1, 4 to 8 from the 'junk2.image' as separate GIF files.
    At the completion of write_gif, the following gif files will be
    created:
	   junk2.image1.gif
	   junk2.image4.gif
	   junk2.image5.gif
	   junk2.image6.gif
	   junk2.image7.gif
	   junk2.image8.gif
    The object v2 need to be defined only if it is not yet defined.

         v2 = obj_new('scan2d',file='junk2.image')
         v2->write_gif,'1,4:8'

 MODIFICATION HISTORY:
       Written by:     Ben-chin Cha, May 4, 1999.
       xx-xx-xxxx      comment

(See scan2d_convert.pro)


SCAN2D::WRITE_TIFF

[Previous Routine] [List of Routines]
 NAME:
       scan2d::WRITE_TIFF

 PURPOSE:
       This method allows the user to create a TIFF image file with a 
       user requested image seq no. The default file name created will
       be ended with '.tiff' suffix. 

 CALLING SEQUENCE:
       Obj->[scan2d::]WRITE_TIFT,no 

 ARGUMENTS:
    NO:       a int variable to specify the input image sequence number.

 KEYWORDS:
    TIFF:     specifiies the output TIFF file name to be used. If not given
              the tiff file is automatically generated from the image filename.
  TOP2BOTTOM: TIFF to be saved in reverse order, ie from top to bottom row
    TYPE:     Specify plot type, can be contour,surface,or shade_surf

 EXAMPLE:
    Save images 8 from the 'junk2.image' as a TIFF file.
    The junk2.image8.tiff will be saved by this command.
    The object v2 need to be defined only if it is not yet defined.

         v2 = obj_new('scan2d',file='junk2.image')
         v2->write_tiff,8

 MODIFICATION HISTORY:
       Written by:     Ben-chin Cha, May 4, 1999.
       xx-xx-xxxx      comment

(See scan2d_convert.pro)