mBgExec

Description:

Runs mBackground on all the images in a metadata table, using the corrections generated by mFitExec.

Syntax:

mBgExec [-p projdir] [-s statusfile] [-d] [-n(o-areas)] images.tbl corrections.tbl corrdir

Switches:

-p projdir

Specifies the path to the directory containing the projected images.

-s statusfile

Writes output message to statusfile instead of to stdout

-d

Turns on debugging

-n

Indicates that no area images are present (assumes equal weighting for each pixel)

Arguments:

images.tbl

Image metadata table generated by mImgtbl.

corrections.tbl

Table of corrections generated by mFitExec

corrdir

Directory where output images should be written

Results:

Output FITS images will be created in the directory specified by corrdir, with names that are the same as the uncorrected images.

Examples:

In this example, images.tbl describes the unprojected or projected images (filenames are the same if mProjExec was used), and corrections.tbl was generated using mBgModel after running mDiffExec and mFitExec on those images.

$ mBgExec -p proj images.tbl corrections.tbl corr

[struct stat="OK", count=16, failed=0]

corr now contains the images with background removal applied.

Return Codes:

• [struct stat="OK", count=num-images, nocorrection=num-skipped, failed=num-failed]
• [struct stat="ERROR", msg="Usage: mBgExec [-p projdir] [-s statusfile] [-d] [-n(o-areas)] images.tbl corrections.tbl corrdir"]
• [struct stat="ERROR", msg="MPI initialization failed"]
• [struct stat="ERROR", msg="Cannot open status file: statusfile"]
• [struct stat="ERROR", msg="Cannot access corrdir"]
• [struct stat="ERROR", msg="corrdir is not a directory"]
• [struct stat="ERROR", msg="Invalid image metadata file: images.tbl"]
• [struct stat="ERROR", msg="Need columns: cntr and fname in image list"](columns missing from image metadata table)
• [struct stat="ERROR", msg="Too many entries in image list for compiled program"](columns missing from corrections table)
• [struct stat="ERROR", msg="mBackground error"]