Parameter | Mand | Type | Default | Constraints |
srclist | yes | dataset | srclist.ds | |
Source definition list: a dataset containing the SRCLIST
table, and to which the region extensions will be added.
| ||||
evlist | no | dataset | ||
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.*.
| ||||
maxorder | no | integer | 2 | 1- |
The number of reflection orders to be processed for each selected
source. One order region is added for each order, starting from
first order.
| ||||
spatialres | no | integer | 5 | 2- |
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.
| ||||
orderres | no | integer | 3 | 2- |
The dispersion-axis spacing of vertices for order regions,
specified as the number of vertices across a node.
| ||||
xpsfbelow | no | real | 90 | 0-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.
| ||||
xpsfabove | no | real | 90 | 0-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.
| ||||
xpsfexcl | no | real | 95 | 0-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.
| ||||
pdistincl | no | real | 90 | 0-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.
| ||||
withpicutoff | no | boolean | no | If true, enable the PI cutoff. |
| ||||
picutoff | no | real | ||
Minimum PI cutoff. Create a excluded region between 0 and PI
to filter possible events that fall into the tail of the system peak
| ||||
procsrcsexpr | no | string | ||
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.
| ||||
exclsrcsexpr | no | string | ||
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.
| ||||
setflags | no | boolean | no | |
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.
| ||||
protect | no | boolean | no | |
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.
| ||||
xdspregions | no | reallist | no | |
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.
| ||||
xdspbackground | no | reallist | no | |
Pair of values defining a rectangular cross dispersion
background regions in arcmin. | ||||
spectrumbinning | no | choice | lambda | lambda beta |
Region binning type. Used to accumulate the spectrum in rgsspectrum.
| ||||
Parameter | Mand | Type | Default | Constraints |
XMM-Newton SOC -- 2023-04-16