Spitzer Documentation & Tools
MOPEX User's Guide

 

4.3.1        Overlap Modules: Initial Setup

Command Line Equivalent: N/A

Default Output Directory: N/A

Depends On: None

 

Important Notes: None

 

PURPOSE

Set up the input and output files for the loaded flow.

 

INPUT

Image Stack File: The text file containing the list of input data files for the pipeline. For Spitzer data, these are typically the *bcd.fits or *cbcd.fits files that you download from the Spitzer data archive. See Chapter 3 and Table 3.1 for more information on the input file requirements and format.

 

Output Directory: The directory that you want to set as your output directory for this run.

 

Multi-processing Mode:  Switch to use multi-processing.  See Discussion.

 

Processors for Multi-processing:  Number of processors to use.  See Discussion.

 

Optional Input and Mask Files:

 

Sigma List File: The text file containing the list of uncertainty images that correspond to the input data files (for Spitzer data, these are usually the *bunc.fits or *cbunc.fits files; see Table 3.1 for more information).

 

DCE Status Mask List: The text file containing the list of mask images that flag temporarily-bad pixels in the input data images. There should be a mask file for each of the input data files (for Spitzer data these depend on the instrument, but will be labeled something like *msk.fits; see Table 3.1 for more information).

 

Fatal Mask Bit Pattern: This is the bit pattern that defines which type of flagged problems that you wish to set as fatal when combining the input images. See §8.11 for more information. There is a separate Fatal Bit Pattern for each type of mask that is being used as input (i.e. for the DCE Status masks, the RMasks and the PMask).

 

Rmask List File: The text file containing a list of outlier mask images. Usually this will be left blank, as the RMask images are created during the mosaicking process. This option allows you to specify a previously created list of RMask images as input on second and subsequent runs of the pipeline, to save having to re-generate them.

 

Pmask FITS File: The permanently-damaged pixel mask for the detector. This is a single FITS image, flagging the permanently damaged pixels in the instrument arrays. These files are stored in the <mopex_dir>/cal/ directory. See §3.1.2 for more information.

 

FIF file: The Fiducial Image Frame file. This is an optional input file, as it is often generated from the input data using the Fiducial Image Frame module. There are, however, a number of cases in which you might wish to use a user-specified FIF (e.g. if you are trying to match the field of view to the other data channels).

 

 COMMAND LINE INPUT

These parameters are set in the Global Parameters part of the namelist.

IMAGE_STACK_FILE_NAME = <working_dir>/imagelist.txt

OUTPUT_DIR = <working_dir>/output

SIGMALIST_FILE_NAME = <working_dir>/sigmalist.txt

DCE_STATUS_MASK_LIST = <working_dir>/masklist.txt

DCE_Status_Mask_Fatal_BitPattern = 32544

RMASK_LIST = <working_dir>/rmasklist.txt

RMask_Fatal_BitPattern = 7

PMASK_FILE_NAME = <mopex_dir>/cal/sep07/sep07_ch1_bcd_pmask.fits

PMask_Fatal_BitPattern = 32767

FIF_FILE_NAME = <working_dir>/FIF.tbl

verbose = 1

NICE = 1

save_namelist = 1

 

Verbose, NICE and save_namelist are only available on the command line. See §9.4.2.3 for more information.

 

OUTPUT

None

 

DISCUSSION

This module sets up the input files and top-level output directory for the first pipeline in the flow. Subsequent pipelines that have been inserted into the flow will use the output from the previous one (i.e. if you have inserted Overlap and Mosaic into your reduction flow, Overlap will use the Initial Settings files as input, but Mosaic will use the modified files output by Overlap). Only Input Image Stack and Output Directory are required, but Sigma File List, DCE Status Mask List and Pmask FITS File are recommended.