mShrinkCube

Description:
A utility for reducing the size of a FITS cube, by averaging blocks of pixels by any factor spatially and by integer factors in the third dimension.
Syntax:
mShrinkCube [-f] [-d level] [-h hdu] [-m factor] [-s statusfile] in.fits out.fits factor

Switches:

-f
Fixed-size flag - specify output size of image, instead of the size of blocks of pixels to be averaged
-d level
Turns on debugging to the specified level (1-4).
-h hdu
Use the specified FITS extension (default is to use the first HDU with image data)
-m factor
The (positive integer) factor by which to compress the cube in the third (usually wavelength-related) dimension.
-s statusfile
Output and errors are sent to statusfile instead of to stdout

Arguments:

in.fits
Input FITS cube
out.fits
Path to output FITS cube.
factor
Size of blocks, in (fractional) pixels, to average. File size will be reduced by 1/factor squared. If the -f (fixed-size) flag is used, factor is the desired width of the output image.
Results:
[Normal mode]: FITS output image, reduced in size by a factor of (1/factor)^2 .
[Fixed-size mode]: FITS output image of width factor

Examples

$ mShrinkCube final/out.fits final/out-lowres_5.fits 5
[struct stat="OK"]

Return Codes:

  • [struct stat="OK"]
  • [struct stat="ERROR", msg="Usage: mShrink [-f(ixed-size)] [-d level] [-m factor] [-s statusfile] in.fits out.fits factor"]
  • [struct stat="ERROR", msg="Cannot open status file: statusfile"]
  • [struct stat="ERROR", msg="Image size factor cannot be interpreted as an real number"]
  • [struct stat="ERROR", msg="Shrink factor factor cannot be interpreted as an real number"]
  • [struct stat="ERROR", msg=\"Shrink factor factor must be positive"]
  • [struct stat="ERROR", msg="HDU value (n) must be a non-negative integer"]
  • [struct stat="ERROR", msg="Third axis compression factor (n) must be a positive integer"]
  • [struct stat="ERROR", msg="Image file in.fits missing of invalid FITS."]
  • [struct stat="ERROR", status=n, msg="FITS library error"]