.help displayset kevin Jun2004
.ih
NAME
displayset -- Sequentially display a group of images
.ih
USAGE 
displayset @filelist 
.ih 
PARAMETERS
.ls inputimages 
The name of the images to be displayed.  It can be a wildcard expression, a 
list of image names separated by commas, or the name of a file listing the 
images to be displayed prefixed by "@".
.le
.ls framenumber = 1
The frame number in which the image is to be displayed, normally from 1 to 4.
.le
.ls sleeptime = 0.0 
A time, in seconds, to pause after the display of each image.
.le
.ls meffile = yes
A flag for whether the image is a multi-extension fits (MEF) file.  If this 
value is set to "yes" then the \fmetext\R parameter is used to determine the 
extension of each input file to be displayed.
.le
.ls mefext = 1
An integer value for the number of the extension in the file that is to be 
displayed.  The same extension is used for all files listed by the 
.finputimages.R value.
.le
.ls imsect = ""
An image section to be used for each image that is displayed.
.le
.ls examine = no
A flag for whether to interactively examine each image that is displayed.  If 
set to "yes", then .fimexam.R is called after each image is displayed.  After 
.fimexam.R is exited via the "q" key the next image is displayed.
.le
.ls scanfile = ""
Internal use only.
.le
.ih
DESCRIPTION
.sp
This task is used to display a set of images to the image display device 
one by one.  The task reads the image names from the .finputimages.R parameter,
and proceeds to display each one using the .fdisplay.R command.  This continues
for as many files as are listed up to a maximum of 300.
.sp
The script pauses for a time period set by the .fsleeeptime.R parameter, a 
value in seconds, between the display of one image and the display of the next 
image.  This gives the user time to look at the individual images if the 
display process is too fast.
.sp
This script can handle MEF files either by specifying the MEF extension in the 
image name passed to the routine or by specifying .rmeffile.R as "yes" and 
also specifying the .fmefext.R value.  In such a case extension .fmefext.R 
of each named imput image is displayed.  To handle regular FITS files each 
with a single image extension set .fmeffile.R to "no".
.sp
It is also possible to use .fimexam.R on each iamge after it is displayed, by 
setting the .fexamine.R flag to "yes".
.sp
Finally, it is possible to enter an image section string for the .fimsect.R 
parameter, and then that section is display for each image in the list.
.sp The parmeters for the .fdisplay.R and .fimexam.R routines are not set 
within the script, so whatever parameters are current for these routines will 
be applied for each image in the list.
.ih
EXAMPLES
.sp
1. Display the first extension of all files matching "rS20040526" in the 
current directory:

.nf
    cl> displayset rS20040626*
.fi

2. Display the inner portion of all T-ReCS stacked images in a directory, and 
pause 2 seconds between each image display:

.nf 
    cl> displayset rS* imsect="[81:240,61:180]" sleep=2.0
.fi

3. Display a set of normal files listed in file "files.list" and examine 
each one as it is displayed:

.nf
    cl> displayset @files.list examine+ meffile-
.fi

.ih
BUGS AND LIMITATIONS
The script uses zscale=no, zrange=yes, since that is the most useful set of 
options for T-ReCS stacked files.  At present there is no way to change this 
in the invokation of the script.  The number of files is limited to 300 or 
less.
.ih
SEE ALSO
imexamine, display
.endhelp
