mAddCube

Description:
Coadd the reprojected cubes in an input list to form an output mosaic with FITS header keywords specified in a header file. Creates two output files, one containing the coadded pixel values for each cube plane, and the other containing coadded pixel area values. The pixel area values can be used as a weighting function if the output cube values are themselves to be coadded with other projected cubes, and may also be used in validating the fidelity of the output pixel values.
Syntax:
mAddCube [-p imgdir] [-n(o-areas)] [-a mean|median|count] [-e(xact-size)] [-d level] [-s statusfile] images.tbl template.hdr out.fits

Switches:

-p imgdir
Specifies path to directory containing reprojected images. If the -p switch is not included, mAddCube will look for the input images in the current working directory.
-n
Co-addition ignores weighting by pixel areas and performs coaddition based only on pixel postions. Will not output an area image for the output image.
-a type
Select type of averaging to be done on accumulated pixel values (either mean or median). To generate a map showing counts of how many times each pixel was overlapped by the input images, use count.
-e
Enables exact size mode. The output image will match the header template exactly, instead of shrinking the output to fit the data.
-d level
Turns on debugging to the specified level (1-3).
-s statusfile
mAddCube output and errors will be written to statusfile instead of stdout.

Arguments:

images.tbl
ASCII table (generated by mImgtbl) containing metadata for all images to be coadded. For cubes, mImgtbl needs to be run with the -C option which picks up the third dimension parameters (and fourth if they exist).
template.hdr
FITS header template to be used in generation of output FITS cube.
out.fits
Name of output FITS image.
Results:
If successful, mAddCube creates a FITS datacube file out.fits that is a coadd of all the FITS cubes in the table images.tbl, according to the header template given. A corresponding out_area.fits is also created.

Examples:

The following example runs mAddCube on 4 FITS images, generating the output file mosaic.fits. Related files are images.tbl and template.hdr.

$ mAddCube -p proj images.tbl template.hdr output/mosaic.fits
[struct stat="OK", time=1]

Return Codes:

  • [struct stat = "OK", time=time]
  • [struct stat="ERROR", msg="Usage: mAddCube [-p imgdir] [-n(o-areas)] [-a mean|median|count] [-e(xact-size)] [-d level] [-s statusfile] images.tbl template.hdr out.fits"]
  • [struct stat="ERROR", msg="Invalid argument for -a flag"]
  • [struct stat="ERROR", msg="Cannot open status file: statusfile"]
  • [struct stat="ERROR", msg="Invalid image metadata file: filename"]
  • [struct stat="ERROR", msg="Need columns: cntr,fname, crpix1, crpix2, cdelt1, cdelt2, naxis1, naxis2, crval1, crval2, naxis3 in image list"]
  • [struct stat="ERROR", msg="Too many open files"]
  • [struct stat="ERROR", msg="Input wcsinit() failed."]
  • [struct stat="ERROR", msg="Bad WCS in header template."]
  • [struct stat="ERROR", status=stat, msg="FITS library error"]
  • [struct stat="ERROR", msg="general error message"]
  • [struct stat="ERROR", msg="Allocation failed for file info (realloc)"]
  • [struct stat="ERROR", msg="Allocation failed for file info structs"]
  • [struct stat="ERROR", msg="Allocation failed for area file info structs"]
  • [struct stat="ERROR", msg="Allocation failed for input buffer"]
  • [struct stat="ERROR", msg="Allocation failed for input area buffer"]
  • [struct stat="ERROR", msg="Allocation failed for start/end info"]
  • [struct stat="ERROR", msg="Allocation failed for data line pointers"]
  • [struct stat="ERROR", msg="Allocation failed for data line"]
  • [struct stat="ERROR", msg="Allocation failed for area line pointers"]
  • [struct stat="ERROR", msg="Allocation failed for area line"]
  • [struct stat="ERROR", msg="Allocation failed for data counts"]
  • [struct stat="ERROR", msg="Allocation failed for output data line"]
  • [struct stat="ERROR", msg="Allocation failed for output area line"]
  • [struct stat="ERROR", msg="Allocation failed for data line (realloc)"]
  • [struct stat="ERROR", msg="Allocation failed for area line (realloc)"]
  • [struct stat="ERROR", msg="Allocation failed for median array"]
  • [struct stat="ERROR", msg="Allocation failed for median array (realloc)"]
  • [struct stat="ERROR", msg="Allocation failed for linked list structs"]
  • [struct stat="ERROR", msg="Allocation failed for linked list structs (additions)"]