Return to Post-BCD pages
 
Manual Contents
 
Getting Started
 
Input Files
 
Background Matching (overlap.pl)
 
Mosaicking (mosaic.pl)
 
Point Source Extraction (apex*.pl)
 
Basic Concepts
 
Appendix 1: Full List of MOPEX Scripts
 
Appendix 2: Fatal Bit Patterns
 
Appendix 3: Full Lit of MOPEX Modules

APEX Namelist Options

For the format of the namelist, see MOPEX Input Namelist. This page gives a full list of the options available in the Global Parameters section of the APEX namelists (apex.pl, apex_1frame.pl, apex_qa.pl). If you specify any mask files as input, you must also specify a corresponding Fatal Bit Pattern. See MOPEX Input Namelist for more information.

Quick Links on this page



A: Input/Output Files

The following input filenames can be set within the namelist rather than having to specify them on the command line each time you run APEX. See MOPEX Input Files for a description and the format of the input files, and see MOPEX Input Namelist for more details on how to include these keywords in the namelist. If the files are kept anywhere other than the default locations listed below, the keywords must include the full path to the file. The input/output files that can be specified vary according to the APEX script you are running. Be sure to refer to the correct section below.


1.1 Multiframe Point Source Extraction (apex.pl)

    IMAGE_STACK_FILE_NAME = <data filename>
    where <data filename> = text file containing the list of data frames. The default location for this file is in the current working directory.

    SIGMALIST_FILE_NAME = <uncertainty filename> (optional)
    where <uncertainty filename> = text file containing the list of corresponding uncertainty images. Default location is the current working directory

    DCE_STATUS_MASK_LIST = <DCE mask filename>
    where <DCE mask filename> = text file containing the list of corresponding mask imges, flagging temporarily bad pixels. Default location is the current working directory.

    PRF_MAP_FILE_NAME = <PRF map filename>
    where <PRF map filename> = the table identifying the variable PRF (PRFmap.tbl) to be used if the PSF changes across the field of view. Default location is a subdirectory, cal/ of the current working directory.

    PRF_file_name = <PRF filename>
    where <PRF filename> = name of the PRF image for the individual input images. Default location is a subdirectory, cal/ of the current working directory. Standard PRF files are available in the cal/ directory provided with MOPEX. Users may choose to produce their own PRFs using the command-line Perl script prf_estimate.pl distributed with MOPEX.

    MOSAIC_PRF_file_name = <mosaic PRF filename>
    where <mosaic PRF filename> = name of the PRF image to be used with the mosaic created by apex.pl. Default location is a subdirectory, cal/ of the current working directory. Standard PRF files are available in the cal/ directory provided with MOPEX. Users may choose to produce their own PRFs using the command-line Perl script prf_estimate.pl distributed with MOPEX.

    PMASK_FILE_NAME = <pmask filename>
    where <pmask filename> = relevant PMask file, flagging permanently bad pixels in the array. Default location is a subdirectory, cal/ of the current working directory. The PMasks can be found in the cal/ directory of the MOPEX distribution.

    RMASK_LIST = <rmask filename>
    where <rmask filename> = text file containing a list of the corresponding mask images flagging pixels rejected as outliers. Default location is the current working directory.

    FIF_FILE_NAME = <FIF filename>
    where <FIF filename> = name of the FIF.tbl file. Default location is the output directory.

    OUTPUT_DIR = <output directory>
    The default output directory is the current working directory.

1.2 Multiframe Residual Image Creation (apex_qa.pl)

    IMAGE_STACK_FILE_NAME = <data filename>
    where <data filename> = text file containing the list of data frames. The default location for this file is in the current working directory.

    EXTRACTION_TABLE = <extract table>
    where <extract table> = point source list (extract.tbl) from apex.pl SIGMALIST_FILE_NAME = <uncertainty filename> (optional)
    where <uncertainty filename> = text file containing the list of corresponding uncertainty images. Default location is the current working directory

    DCE_STATUS_MASK_LIST = <DCE mask filename>
    where <DCE mask filename> = text file containing the list of corresponding mask imges, flagging temporarily bad pixels. Default location is the current working directory.

    PRF_MAP_FILE_NAME = <PRF map filename>
    where <PRF map filename> = the table identifying the variable PRF (PRFmap.tbl) to be used if the PSF changes across the field of view. Default location is a subdirectory, cal/ of the current working directory.

    PRF_file_name = <PRF filename>
    where <PRF filename> = name of the PRF image for the individual input images. Default location is a subdirectory, cal/ of the current working directory. Standard PRF files are available in the cal/ directory provided with MOPEX. Users may choose to produce their own PRFs using the command-line Perl script prf_estimate.pl distributed with MOPEX.

    PMASK_FILE_NAME = <pmask filename>
    where <pmask filename> = relevant PMask file, flagging permanently bad pixels in the array. Default location is a subdirectory, cal/ of the current working directory. The PMasks can be found in the cal/ directory of the MOPEX distribution.

    RMASK_LIST = <rmask filename>
    where <rmask filename> = text file containing a list of the corresponding mask images flagging pixels rejected as outliers. Default location is the current working directory.

    FIF_FILE_NAME = <FIF filename>
    where <FIF filename> = name of the FIF.tbl file. Default location is the output directory.

    OUTPUT_DIR = <output directory>
    The default output directory is the current working directory.

2.1 Single Frame Point Source Extraction (apex_1frame.pl)

    INPUT_FILE_NAME = <input filename>
    where <input filename> = input image (mosaic.fits).

    PRF_MAP_FILE_NAME = <PRF map filename>
    where <PRF map filename> = the table identifying the variable PRF (PRFmap.tbl) to be used if the PSF changes across the field of view. Default location is a subdirectory, cal/ of the current working directory.

    PRF_file_name = <PRF filename>
    where <PRF filename> = name of the PRF image for the individual input images. Default location is a subdirectory, cal/ of the current working directory. Standard PRF files are available in the cal/ directory provided with MOPEX. Users may choose to produce their own PRFs using the command-line Perl script prf_estimate.pl distributed with MOPEX.

    SIGMALIST_FILE_NAME = <uncertainty filename> (optional)
    where <uncertainty filename> = text file containing the list of corresponding uncertainty images. Default location is the current working directory

    COVERAGE_MAP = <coverage map filename>
    where <coverage map filename> = name of the coverage map for the mosaic (mosaic_cov.fits).

    DCE_STATUS_MASK_LIST = <DCE mask filename>
    where <DCE mask filename> = text file containing the list of corresponding mask imges, flagging temporarily bad pixels. Default location is the current working directory.

    PMASK_FILE_NAME = <pmask filename>
    where <pmask filename> = relevant PMask file, flagging permanently bad pixels in the array. Default location is a subdirectory, cal/ of the current working directory. The PMasks can be found in the cal/ directory of the MOPEX distribution.

    RMASK_LIST = <rmask filename>
    where <rmask filename> = text file containing a list of the corresponding mask images flagging pixels rejected as outliers. Default location is the current working directory.

    OUTPUT_DIR = <output directory>
    The default output directory is the current working directory.

2.2 Single Frame Residual Image Creation (apex_qa.pl)

    MOSAIC_FILE_NAME = <input filename>
    where <input filename> = input image (mosaic.fits).

    EXTRACTION_TABLE = <extract table>
    where <extract table> = point source list (extract.tbl) from apex_1frame.pl PRF_MAP_FILE_NAME = <PRF map filename>
    where <PRF map filename> = the table identifying the variable PRF (PRFmap.tbl) to be used if the PSF changes across the field of view. Default location is a subdirectory, cal/ of the current working directory.

    MOSAIC_PRF_file_name = <mosaic PRF filename>
    where <mosaic PRF filename> = name of the PRF image to be used with the mosaic image. Default location is a subdirectory, cal/ of the current working directory. Standard PRF files are available in the cal/ directory provided with MOPEX. Users may choose to produce their own PRFs using the command-line Perl script prf_estimate.pl distributed with MOPEX.

    SIGMALIST_FILE_NAME = <uncertainty filename> (optional)
    where <uncertainty filename> = text file containing the list of corresponding uncertainty images. Default location is the current working directory

    FIF_FILE_NAME = <FIF filename>
    where <FIF filename> = name of the FIF.tbl file. Default location is the output directory.

    OUTPUT_DIR = <output directory>
    The default output directory is the current working directory.

B: Fatal Bit Patterns

See MOPEX Input Namelist and Appendix 2: Fatal Bit Patterns for more information.

DCE_Status_Mask_Fatal_BitPattern = <DCE Status Mask Fatal Bit Pattern>

PMask_Fatal_BitPattern = <PMask Fatal Bit Pattern>

RMask_Fatal_BitPattern = <RMask Fatal Bit Pattern>


C: Other Options

All other options that can be set in the Global Parameters section of the APEX namelist are all listed below. In order to activate these options, they must be specified with a value of 1, e.g. adding a line into your APEX namelist that reads:

save_namelist = 1

will turn on the "save namelist" option. Note the spaces before and after the "=" sign. The default for all options is "0", i.e. "off", unless otherwise specified. The options are listed in alphabetical order, but can be given in any order in the namelist.


create_residual_images
    apex_qa.pl only in multiframe (apex.pl) mode only. Instructs MOPEX to create the residual images from the input image stack and the point source extraction table output by apex.pl.

create_residual_mosaic
    apex_qa.pl in single frame (apex_1frame.pl) mode only. Instructs MOPEX to create the residual mosaic from the input mosaic and the point source detection table output by apex_1frame.pl.

create_std_mosaic
    Creates a standard deviation output mosaic called mosaic_std.fits.

create_unc_mosaic
    Creates a mosaic of the coadded uncertainty images. The output mosaic is called mosaic_unc.fits.

delete_intermediate_files
    Gives the option to delete all of the intermediate files created in this run, except for the files created by the final module. Useful for saving disk space once you are satisfied with your reduction setup.

MARGIN

    Specifies a margin in terms of the number of pixels around the FIF. Normally this is set to zero or a (small) positive number, except when running Mosaic Geometry, when it should normally be set to a negative number to avoid including input images that have only marginal overlap with the FIF.

MOSAIC_PIXEL_RATIO_X,
MOSAIC_PIXEL_RATIO_Y
    The ratio of the input pixel pixel x, y size to the output mosaic pixel x, y size. Default = "1". The ratio is taken after correction for geometric distortion. This is overridden by MOSAIC_PIXEL_SIZE_X(Y), if specified.

MOSAIC_PIXEL_SIZE_X,
MOSAIC_PIXEL_SIZE_Y
    The size in degrees of the output mosaic pixels in the x- and y-directions. MOSAIC_PIXEL_SIZE_X must be negative according to convention, else an error message will be generated. Specifying these values takes precedence over MOSAIC_PIXEL_RATIO_X(Y). The default pixel sizes depend on the instrument. See the instrument-specific namelists linked from the bottom of the MOPEX page for the default values for each channel.

mosaic_residual_images
    apex_qa.pl in multiframe (apex.pl) mode only. Gives the option to mosaic together the residual images created by apex_qa.pl. Requires the trigger create_residual_images as a prerequisite.

NICE
    NICE runs MOPEX with the UNIX command "nice 19". If you are not familiar with nice, click here for the Wikipedia description.

save_namelist
    The namelist used in the current run is always copied to the output directory. By default, the name of the namelist is not changed. By setting save_namelist = 1, the namelist copied to the output directory is given a unique name, which is created by appending the namelist filename to the time of execution. For example, if you ran mosaic.pl -n myname.nl at 12:32:53, then the namelist will be copied to the output directory as 12h32m53s_myname.nl. The default is 0, in which case the file is copied as myname.nl and will be overwritten in subsequent runs that use the same namelist.

sigma_weighted_coadd
    Warning: This is an input option into the Mosaic Coadder module. It gives the option to co-add the interpolated images by weighting them with the uncertainty images. NOT RECOMMENDED.

use_background_subtracted_image_for_aperture
    Default is 1, in which case the aperture photometry is carried out on the background-subtracted images. Recommended.
use_background_subtracted_image_for_fitting
    Default is 1, in which case the point source extraction is performed on the background-subtracted images. Strongly recommended.

use_psp_to_detect
    Default is 1. If set to 2, point source detection will be performed on the background-subtracted images. If set to 1, detection will be carried out on the PSP (point source probability) images. If set to zero, the detection is carried out on the "Filtered" image (see the Point Source Probability Module page for more information).

use_std_to_detect
use_unc_to_detect
verbose
    Instructs MOPEX to print the output from each individual module. This is extremely useful for troubleshooting. If MOPEX encounters a problem while verbose is turned off, it may stop without printing an error message.




SPITZER HOME || SPITZER SCIENCE || INSTRUMENTS || SCIENCE USER SUPPORT || SEARCH

help@spitzer.caltech.edu

This file was last modified on Tue Jun 10 17:37:40 PDT 2008.

California Institute of Technology Jet Propulsion Laboratory NASA