Data Analysis Home
Manual Contents
Getting Started
Input Files
Background Matching (overlap.pl)
Mosiacking (mosaic.pl)
Point Source Extraction (apex*.pl)
PRF Estimate (prf_estimate.pl)
Basic Concepts
Appendix 1: Full List of MOPEX Scripts
Appendix 2: Fatal Bit Patterns
Appendix 3: Full List of MOPEX Modules
Helpdesk / FAQ
|
PRF Estimate Namelist Options
This page gives a full list of the options available in the Global Parameters section of the PRF Estimate namelist. If you specify any mask files as input, you must also specify a corresponding Fatal Bit Pattern. See MOPEX Input Namelist for the format of the namelist and for more information.
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 PRF Estimate. 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.
IMAGE_STACK_FILE_NAME (string; either this or INPUT_FILE_NAME is required)
The text file containing the list of data frames from which to measure the PRF. If the PRF is to be measured from a single image (e.g. a mosaic) then this should not be set (see INPUT_FILE_NAME). The default location for this file is in the current working directory.
INPUT_FILE_NAME (string; either this or IMAGE_STACKFILE_NAME is required)
The name of the fits image (usually a mosaic) from which the PRF is to be measured. This should not be set if the PRF is to be measured from a stack of images (see IMAGE_STACK_FILE_NAME). The default location is in the current working directory.
POINT_SOURCE_LIST (string; required)
The name of the input table containing the list of point sources to be used by PRF Estimate. Typically, this file is the *extract.tbl file generated by APEX. The file must be in IPAC table format. The file must contain the input positions, though they may be specified in either RA, Dec or X,Y coordinates. In the latter case, a Fiducial Image Frame (FIF.tbl) file will be required to define the cartesian reference frame. Optionally, the flux of each source can be given in this table in a column, "flux"; if this column is not present, the pipeline will estimate the flux by summing all the pixels in the postage stamp of each source.
DCE_STATUS_MASK_LIST (string; optional)
The text file containing the list of mask images flagging temporarily bad pixels. This list corresponds to the list of input images specified in IMAGE_STACK_FILE_NAME. Default location is the current working directory.
PMASK_FILE_NAME (string; optional)
The relevant PMask file, flagging permanently bad pixels in the array. The default location for the PMask file is in a subdirectory, cal/ of the current working directory.
RMASK_FILE_NAME (string; optional)
The text file containing the list of outlier mask (RMask) images corresponding to the list of images specified in IMAGE_STACK_FILE_NAME. This has usually been generated during a previous run of APEX.
FIF_FILE_NAME (string; optional)
OUTPUT_DIR (string; optional)
The default output directory is the current working directory. The default directories for the individual module outputs can also be changed - see the pages for the individual modules for the default output directory and the namelist keyword required to change it.
AnnealStatus_file_name (string; optional)
The output file name of a table containing diagnostic information about the fitting used to estimate point source flux and position. The default file name is FitStat.tbl.
PRF_Coverage_file_name (string; optional)
The name of the output coverage map corresponding to the output PRF image. Default is PRFCov.fits.
PRF_FILE_NAME (string; optional)
The name of the output PRF image. Default is PRF.fits.
PRF_MAP_FILE_NAME (string; optional)
Normally the software will create a single PRF image for the entire array, but there is the option to estimate a different PRF for different parts of the array. The mapping of the detector array into sectors is specified in a PRF Map, which must be given as an input to PRF Estimate.
PRF_Sigma_file_name (string; optional)
The name of the output uncertainty image corresponding to the output PRF. Default is PRFSigma.fits
Star_file_name (string; optional)
The name of an optional output image file created using the computed PRF and placing the point source at the center of the central pixel of the image.
StatusList_file_name (string; optional)
The name of the status file listing all the input images, along with whether or not they were used to create the PRF. If they were not used, the reason for rejection is also listed.
B: Fatal Bit Patterns
See MOPEX Input Namelist and 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 PRF Estimate namelist are all listed below. In order to activate these options, they must be specified with a value of 1 unless otherwise noted, e.g. adding a line into your PRF Estimate 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.
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.
NICE (switch)
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
prompt> prf_estimate.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.
USE_REFINED_POINTING (switch)
Use the alternate FITS pointing keywords created by the offline pointing refinement script (pointing_refine.pl). Do not switch this on unless you have manually run pointing refinement outside of the normal BCD pipeline products.
|