XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


eoptloadmask (ebkgmap-2.10.1) [xmmsas_20211130_0941-20.0.0]

Parameters

This section documents the parameters recognized by this task (if any).

ParameterMand Type Default Constraints
srclisttabyesdataset list  
The list of input (optical) source-list FITS file tables (in $<$dataset name$>$:$<$table name$>$ format).
 
masksetnodatasetoptloadmask.ds 
Filename of the output mask image dataset.
 
templatesetyesdataset  
This file should contain an image in the primary extension, which is used to define the pixel dimensions and World Coordinates of the output mask image.
 
temporarysetnodataseteoptloadmask_tmpimage.ds 
Name of a temporary, internally-accessed dataset to hold the filtered source list. It is only of importance for pcms (or other parallel) calls of eoptloadmask (or when the current working directory is not writable for the user).
 
radiusstylenostringfixedfixed|column
Specify how to give the radius or radii of the masked area for each (optical) source.
 
radiusyesreal200$\le$radius
Radius in arcsecond for masking the area around bright sources. Mandatory if radiusstyle=fixed.
 
colradiusnostringRADIUS 
Column name in the input FITS tables for the radius in arcsecond to mask. This is only read if radiusstyle=column.
 
colnamestylenostringdefaultdefault|user
If `default', `RA' and `DEC' are assumed to be the column name for the coordinates used in the input FITS tables. If `user', colra and coldec are read. If `file', colnamefile must be given.
 
colrayesstring list  
Column name list for the `RA' (Right Ascension) in the input FITS tables. The unit has to be in degree. The equinox and epoch of the coordinates must match those in the given source list (srclisttab).
 
coldecyesstring list  
Column name list for the `DEC' (Declination) in the input FITS tables. The unit has to be in degree. The equinox and epoch of the coordinates must match those in the given source list (srclisttab).
 
withexpressionsnobooleanno 
Whether specify expression or not.
 
expressionsnostring list  
A selection expression used to filter the source list. The selection expression should adhere to the selectlib grammar and should contain as arguments only keywords and column names actually present in the source list table. The list (as opposed to a single string) is allowed for this parameter, each of element of which corresponds to each input source-list; for that reason, spaces must be used only to separate the expressions among selection-expressions for the different source lists.
 
withexpressionsnobooleanno 
Whether specify expression or not.
 
isinvertednobooleanyesyes|no
If true, the pixels affected with optical-loading in the output mask file are zero, if not, one. For the later use of the output mask file with dpssflag, isinverted=yes is more convenient (default).
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30