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


rgsfilter (rgsfilter-1.19) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
mergedsetyesdatasetmerged.ds 
The input combined event list. It must contain the EVENTS table, and for each EXPOSU0n table that it contains it must also contain the REJPIX0n and REJPIX1n pair of tables. For exposure map generation the BADPIX0n and BADPIX1n pair of tables is also required. This dataset is not modified.
 
evlistnodataset  
The output event list, a filtered copy of the input mergedset. The default file name is inferred from the input mergedset name as: *EVENLI????.* if there are ten characters before the suffix, and otherwise just evlist.*.
 
auxgtitablesnolist of tables  
A list of OGIP compliant auxiliary GTI tables for filtering the event list in conjunction with its internal STDGTI0n tables.
 
rejflagsnolist of strings“BAD_SHAPE ON_NODE_INTERFACE ON_BADPIX NEXT_TO_BADPIX ON_WINDOW_BORDER BELOW_ACCEPTANCE”BAD_SHAPE $\mid\,$ ON_NODE_INTERFACE $\mid\,$ ON_BADPIX $\mid\,$ NEXT_TO_BADPIX $\mid\,$ ON_WINDOW_BORDER $\mid\,$ BELOW_ACCEPTANCE
A list of rejection flags for filtering the events. See rgsevents for the meaning of each flag.
 
withexpmapsnobooleanyes 
If true, an exposure map for each node is added to the output dataset, overwriting any previous versions of the maps. The maps are constructed to be consistent with the filtering of the events. Chips without an EXPOSU0n table in the event list are not considered. Requires Spectroscopy mode data.
 
withcombmapnobooleanyes 
If true, parameter expimageset specifies a second output dataset in which the combined exposure map is placed as the primary image. Requires withexpmaps=true.
 
expimagesetnodataset  
The output combined exposure map. The default file name is inferred from the input mergedset name as: *EXPMAP????.* if there are ten characters before the suffix, and otherwise just expmap.*. Requires withcombmap=true.
 
driftbinsizenoreal10-
The size in arcseconds of the square bins used to group frames according to their aspect drift in dispersion and cross-dispersion. Requires withexpmaps=true.
 
spectrumbinningnochoicelambdalambda beta
dispersion direction binning type. Used to accumulate the exposure maps.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30