Function Arguments
/*-***********************************************************************/ /* */ /* mImgtbl */ /* */ /* Montage is a set of general reprojection / coordinate-transform / */ /* mosaicking programs. Any number of input images can be merged into */ /* an output FITS file. The attributes of the input are read from the */ /* input files; the attributes of the output are read a combination of */ /* the command line and a FITS header template file. */ /* */ /* This module, mImgtbl, makes a list (with WCS information) of all */ /* FITS image files in the named directory (and optionally recursively) */ /* */ /* mImgtbl supports a lot of variation in input (and a little in */ /* output) so there are lot of parameters on the call, most of which */ /* can be "defaulted" (i.e. set to zero / NULL). The full parameter */ /* list is: */ /* */ /* char *pathname Directory (or top of tree) for image file */ /* search (default to current directory). */ /* char *tblname Output table file name (no default). */ /* */ /* int recursiveMode Search for images recursively (default just */ /* top directory). */ /* int processAreaFiles Include "area" files in the list (not */ /* normally advisable). */ /* int haveCubes False if we know we don't have datacubes */ /* (fewer table columns) */ /* int noGZIP mImgtbl normally includes analysis of */ /* .fits.gz files. This turns that off. */ /* int showCorners Include ra1,dec1, ... dec4 image corner */ /* columns in output. */ /* int showinfo For HDUs that are are rejected, emit an */ /* INFO message. Best used in application */ /* mode or when debugging. */ /* int showbad Show running "INFO" messages for FITS files */ /* that cannot be opened by CFITSIO. */ /* */ /* char *imgListFile Rather than searching through directories, */ /* get the list of images from a table file. */ /* char *fieldListFile List of FITS keywords to include in output */ /* table (in addition to the standard WCS info. */ /* */ /* int debug Turn on debugging output (not for general */ /* use). */ /* */ /*************************************************************************/ struct mImgtblReturn *mImgtbl(char *pathnamein, char *tblname, int recursiveModein, int processAreaFilesin, int haveCubes, int noGZIPin, int showCornersin, int showinfo, int showbadin, char *imgListFile, char *fieldListFile, int debugin)
Return Structure
struct mImgtblReturn { int status; // Return status (0: OK, 1:ERROR) char msg [1024]; // Return message (for error return) char json[4096]; // Return parameters as JSON string int count; // Number of images found with valid headers (may be more than one per file). int nfile; // Number of FITS files found. int nhdu; // Total number of HDSs in all files. int badfits; // Number of bad FITS files. int badwcs; // Number of images rejected because of bad WCS information. };