FLCAM -- IPAC ISO First Look Tools

Version 5.0

First look conversion of CAM FITS Binary Files to regular FITS image files.

Usage :

flcam [-short_headers] [-quiet] [-cube] [-d `directory`] `tablefile` [`starting_index ending_index` [`step_size`]]

flcam -info `tablefile`

Description:

FLCAM takes an ISO CAM binary FITS tablefile as input, and splits it into multiple simple FITS image files suitable for viewing with skyview, saoimage, or other FITS-compatible image display program. FLCAM also can transform the binary FITS tablefile into a FITS cube file.

Input Files :

The program accepts as input any of the following ISO CAM file formats:

CCIM
CIER
CISP
CMAP
CMOS
other (generic)

flcam looks in the primary FITS header of the specified input file at the keyword FILENAME to decide which format it is in. If the keyword FILENAME is missing or the first 4 characters of its value are not one of the first 5 formats listed above, then the first 4 characters of the input FITS filename are checked. If these 4 characters are not in the set (ccim, cier, cisp, cmap, cmos) the program attempts to translate the file assuming a generic format (see GENERIC below).

Output Files :

The input filename is used as the base of the output filename. The directory portion of the input filename is removed. Then the filename is searched for the string `.fits' or `.FITS' or `.fit' or `.FIT'. If that string is found, the base filename is truncated just before that string. Then each filename is produced by appending a string of the form `_0001.fits' or `_0002.fits' to the base input filename, where the integer is the row number. (see NOTE below about `row number'). If the -d option is used, the specified directory is prepended to each output filename.

For example:

flcam cier08000212.fits.310 5 6

would produce 2 files named:
cier08000212_0005.fits
cier08000212_0006.fits

Additionally, when the input file is of CISP format the program produces a second output FITS file containing the reset data as an image. The filename of this second output contains the word `reset' after the convention specified above is followed:
cisp26500136_reset_0010.fits

If the -short_header option is NOT selected, arrays appearing in the data are placed into the output header all with the same keyword. For example, CISP format contains a two element array GPSCRPID. If the 2 values were 12 and 45, its appearance in the output file would look like:

GPSCRPID=                   12
GPSCRPID=                   45

Options :

-short_headers: (which can be abbreviated -s) limits the headers in the output files to only the header lines necessary for display of the image and computation of the coordinates of the pixels. Without this option, the program copies all of the information from the primary and extended FITS headers plus all of the binary data (except for the image pixels) to each output FITS file header.
-quiet: (abbreviated -q) suppresses messages giving output filenames as they are created.
-cube: create one FITS cube (NAXIS = 3) rather than multiple planar FITS files (NAXIS = 2).
-d directory: create the output files in the specified directory, instead of the current directory.
-info: reports how many image files would be produced from the specified input file and the approximate size of each of the image files.
tablefile: Name of the input FITS Binary Table file of CAM data
starting_index ending_index step_size: optional numerical values that allow the user to specify for conversion a subset of the rows in the input file. The starting_index defaults to 1, ending_index defaults to the last row in the input file, and step_size is the increment value, much like a Fortran DO loop. (see NOTE below about `row number').

Generic Format :

If the file is not one of the 5 cam products (ccim, cier, cisp, cmap, cmos), then an attempt is made to translate the file using some generic rules. The file must have a data set named ARRAY, which must contain values of type I (16-bit integers) or type J (32-bit integers). The following keywords and values are used if present, otherwise the values default as shown:

BITPIX 16 for ARRAY type I, 32 for type J
NAXIS   2
NAXIS1 32
NAXIS2 32

Note: the -cube option in not available for generic format.

Examples :

flcam cier08000212.fits.310 5 6

would produce 2 output files, from rows 5 and 6 of the input file.

Another example: If only the 5th row is desired, the number 5 should be used for both the beginning_index and the ending_index:

flcam cier08000212.fits.310 5 5

Notes :

NOTE on `row number': If the keyword INDEX appears in the input file, then the value of that index is used for the `row number'. If no INDEX keyword appears, then the `row number' is merely the row number from the input file. (In the sample files seen so far, if INDEX does appear, it is exactly the same as the row number, but the program does not require this correspondence.)