mFlattenExec
- Description:
- Runs both mFitPlane and mBackground on a set of images.
- Syntax:
- mFlattenExec [-p imgdir] [-d] [-n(o-areas)] [-s statusfile] images.tbl flatdir
Switches:
- -p imgdir
- Specifies path to directory containing images to be flattened.
- -d
- Turns on debugging.
- -n
- No-area-images flag, indicating that mFlattenExec should not require area images for all the input FITS images.
- -s statusfile
- Output and errors are sent to statusfile instead of to stdout
Arguments:
- images.tbl
- Metadata table (generated by mImgtbl) describing images to be flattened.
- flatdir
- Path to directory where output files should be created.
- Results:
- Creates "flattened" versions of each input FITS image.
Examples:
- $ mFlattenExec output/images.tbl output/flattened
- [struct stat="OK", count=5, failed=0, warning=0]
Return Codes:
- [struct stat="OK", count=nimages, failed=nfailed, warning=nwarnings]
- [struct stat="ERROR", msg="Usage: mFlattenExec [-p imgdir] [-d] [-n(o-areas) [-s statusfile] images.tbl flatdir"]
- [struct stat="ERROR", msg="Cannot open status file: statusfile"]
- [struct stat="ERROR", msg="Cannot access flatdir"]
- [struct stat="ERROR", msg="flatdir is not a directory"]
- [struct stat="ERROR", msg="Invalid image metadata file: filename"]
- [struct stat="ERROR", msg="Need column 'file' in image metadata file filename"]
- [struct stat="ERROR", msg="mDiff or mBackground error"]
