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


rgsregions (rgsregions-1.23) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
srclistyesdatasetsrclist.ds 
Source definition list: a dataset containing the SRCLIST table, and to which the region extensions will be added.
 
evlistnodataset  
Event list: a dataset containing the EVENTS table and exposure map extensions. Not modified. The default file name is inferred from the input srclist name as: *EVENLI????.* if there are ten characters before the suffix, and otherwise just evlist.*.
 
maxordernointeger21-
The number of reflection orders to be processed for each selected source. One order region is added for each order, starting from first order.
 
spatialresnointeger52-
The dispersion-axis spacing of vertices for image regions and the spatial background region, specified as the number of vertices across a node. Not applicable in HTR mode.
 
orderresnointeger32-
The dispersion-axis spacing of vertices for order regions, specified as the number of vertices across a node.
 
xpsfbelownoreal900-100
Downward size of image regions, specified by the percentage of the cross-dispersion PSF covered between the source cross-dispersion off-axis angle and the lower of each pair of vertices with the same dispersion coordinate. Not applicable in HTR mode.
 
xpsfabovenoreal900-100
Upward size of image regions, specified by the percentage of the cross-dispersion PSF covered between the source cross-dispersion off-axis angle and the upper of each pair of vertices with the same dispersion coordinate. Not applicable in HTR mode.
 
xpsfexclnoreal950-100
Size of the exclusion regions in the spatial background region, specified by the percentage of the cross-dispersion PSF covered between each pair of vertices with the same dispersion coordinate and associated source. Not applicable in HTR mode.
 
pdistinclnoreal900-100
Size of order regions, specified by the percentage of the pulse-height distribution covered between each pair of vertices with the same dispersion coordinate.
 
withpicutoffnobooleanno If true, enable the PI cutoff.
 
 
picutoffnoreal  
Minimum PI cutoff. Create a excluded region between 0 and PI to filter possible events that fall into the tail of the system peak
 
procsrcsexprnostring  
Selection expression indicating which sources to process for image and order regions. The default specifies the sources flagged with SOURCE_SELECT in the SRCLIST table.
 
exclsrcsexprnostring  
Selection expression indicating which sources to exclude from the spatial background region. The default specifies the sources flagged with BACK_SELECT in the SRCLIST table. Not applicable in HTR mode.
 
setflagsnobooleanno 
If true, the selection expressions given by procsrcsexpr and exclsrcsexpr are used to set the respective SRCLIST table flag columns, SOURCE_SELECT and BACK_SELECT. In HTR mode the inapplicable BACK_SELECT is simply set to false for all sources.
 
protectnobooleanno 
Value for the PROTECT attribute in each region added or replaced. Regions created with protect=yes cannot be replaced by rgsregions without prior manual intervention.
 
xdspregionsnoreallistno 
Pair(s) of values defining the rectangular cross dispersion limits of source regions in arcmin. So, a [-1.0 1.0] tuple defines a 2 arcmin rectangular region in cross dispersion.
 
xdspbackgroundnoreallistno 
Pair of values defining a rectangular cross dispersion background regions in arcmin.
 
spectrumbinningnochoicelambdalambda beta
Region binning type. Used to accumulate the spectrum in rgsspectrum.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30