XMM-Newton Science Analysis System


region (region-7.15.3) [xmmsas_20230412_1735-21.0.0]

Modes

The three possible modes in which the task can work are set via the operationstyle parameter. These are described as follows:

• operationstyle=`single': in this mode, the task constructs just two regions: a source region and a local-background region, both for the same single source. The source region is stored in one file (specified via parameter regionset) and the background region in another (specified via parameter bkgregionset). The source is selected from the list of sources via the parameter usersrcid. This specifies the row number (beginning at 1) of the source as it occurs in the source list after the list is filtered via the selection expression provided in parameter expression. Because it can be difficult to identify a priori which row number a source will have in the filtered source list, it is not recommended to use the source-table filtering capability when region is invoked in this mode.

• operationstyle=`batch': in this mode, a source region/local background region pair is constructed for each source in the (filtered) source list. The source regions are stored in one dataset (specified via parameter regionset) and the background regions in another (specified via parameter bkgregionset). Each region is stored in a different table in its respective dataset.

• operationstyle=`global': in this mode, a single region is constructed which is intended for filtering all but background events from the event list. This global background region is the logical negation of the logical OR of all source regions. This single region is stored in the dataset specified via parameter bkgregionset.

NOTE! In NO case does region construct its output regions so as to exclude events on bad pixels or outside the instrument field of view. Such events must be independently rejected if this is desired.