NAME

USAGE

DESCRIPTION

This program takes an XMM/OM image file and converts the header and image data to simulate a Swift/UVOT image file. Uvotsim will allow the user to

• specify units for the output image (ARCMIN/PIXEL) and specify the x and y dimension values
• specify the number of arcmin per pixel value
• override the FILTER keyword with a user supplied string

PARAMETERS

infile [filename]

Input XMM/OM FITS file containing the template image

outfile [filename]

Output Swift/UVOT image file name. Precede it with an exclamation point, !, (or \! on the Unix command line), to overwrite a preexisting file with the same name (or set the clobber parameter to YES).

(imgunit = ARCMIN) [string ARCMIN|PIXEL]

If imgunit = ARCMIN (the default) then the ximgsiz and yimgsiz parameters will have the unit ARCMIN If imgunit = PIXEL then the ximgsiz and yimgsiz are in PIXEL units

(ximgsiz = 8) [integer]

the length of the x axis in ARCMIN or PIXEL

(yimgsiz = 8) [integer]

the length of the y axis in ARCMIN or PIXEL

(forcefilter = "") [string]

If forcefilter = "" (the default) then the FILTER keyword is from the XMM/OM file is converted from a numeric value into a string value. If forcefilter = a non-blank string then the FILTER keyword value is overwritten with the supplied string.

(platescale = 3.984) [double]

The arcmin per pixel value used to convert ARCMIN to PIXELs. If imgunit = ARCMIN otherwise this value isn't used.

(sensecase = no) [string]

If sensecase = no then input strings aren't casesensitive. If sensecase = yes then input strings are casesensitive.

(clobber = NO) [boolean]

If outfile already exists, then "clobber = yes" will overwrite it.

(history = NO) [boolean]

If history = YES, then a set of HISTORY keywords will be written to the header of the output file to record the value of all the ftcopy task parameters that were used to produce the output file.

(chatter = 1) [integer, 0 - 5]

Controls the amount of informative text written to standard output. Setting chatter = 5 will produce detailed diagnostic output, otherwise this task normally does not write any output.

(mode = ql) [string, ql|h]

If mode = ql then . If mode = h then .

EXAMPLES

Note that when commands are issued on the Unix command line, strings containing special characters such as '[' or ']' must be enclosed in single or double quotes.

The following example is a typical uvotsim run.

1. Read an 8 x 8 pixels from the center of the images found in the XMM/OM input file and write them to the specified file

uvotsim "OM_IMI.FIT" "UVOT_IMAGE.FIT" "PIXEL" 8 8 " " 3.984375 "no" 

Alternatively you could just run uvotsim and be prompted for the inputs

LAST MODIFIED