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


rgsspectrum (rgsspectrum-2.9) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
evlistyesdatasetevlist.ds 
The input filtered event dataset. It must contain the EVENTS table and exposure map extensions. Not modified. All other file names required by this task are inferred by default from this one.
 
srclistnodataset  
The input source definition dataset. It must contain the SRCLIST table and the relevant selection region extensions. Not modified. The default file name is inferred from the input evlist name as: *SRCLI_????.* if there are ten characters before the suffix, and otherwise just srclist.*.
 
sourcenointeger non-negative
The INDEX number of an entry in the SRCLIST table. This determines the incidence angle and selection regions. The default value, zero, indicates the SOURCEID attribute of the EVENTS table.
 
ordernointeger1positive
The reflection order number. This determines the energy selection region.
 
withspectrumnobooleanyes 
Enables output of the source spectrum (parameter spectrumset). The type of this spectrum is controlled by parameter bkgcorrect.
 
bkgcorrectnobooleanno 
Enables background-correction of the source spectrum.
 
spectrumsetnodataset  
The output source spectrum dataset (OGIP-compliant format). The default file name is inferred from the input evlist name as: *SRSPEC $<\!\!order\!\!>$ $<\!\!source\!\!>$.* if there are ten characters before the suffix, and otherwise just src $<\!\!source\!\!>$o $<\!\!order\!\!>$.pha.
 
spectrumbinningnochoicelambdalambda beta
Spectrum binning type. Used to accumulate the spectrum.
 
withbkgsetnobooleanyes 
Enables output of the background spectrum (parameter bkgset).
 
bkgsetnodataset  
The output background spectrum dataset (OGIP-compliant format). The default file name is inferred from the input evlist name as: *BGSPEC $<\!\!order\!\!>$ $<\!\!source\!\!>$.* if there are ten characters before the suffix, and otherwise just bkg $<\!\!source\!\!>$o $<\!\!order\!\!>$.pha.
 
rebinnointeger1positive
The channel rebinning factor. The events and exposure are rebinned going into the histogram, which gives a more stable result than if the full-resolution spectrum is rebinned later (a very minor point).
 
edgechannelsnointeger2non-negative
The number of channels at the edges of each chip to be marked as bad in the output QUALITY column. For reasons not well understood at this time, the two channels at either edge of every chip do not seem to be properly calibrated.
 
exposednoreal0.10-1
Channels with less than this fraction of full exposure are marked as bad in the output QUALITY column.
 
withfracexpnobooleanno 
Enables addition of the non-standard (but harmless) FRAC_EXP column to the output spectra. This is the fraction of full exposure in each channel.
 
badqualitynointeger10-5
The QUALITY column value used to indicate a bad channel. The default causes bad channels to be discarded automatically by XSPEC. Advanced users of XSPEC may prefer to change this for diagnostic purposes.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30