Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/5.4.1/doc/rgsrmfgen.ps.gz Дата изменения: Fri Jan 10 22:28:57 2003 Дата индексирования: Tue Oct 2 06:44:49 2012 Кодировка: Поисковые слова: http www.badastronomy.com bad index.html

XMM-Newton Science Analysis System Page: 1
rgsrmfgen
January 10, 2003
Abstract
Creates a response matrix le for use with XSPEC and rgs uxer.
1 Instruments/Modes
Instrument Mode
RGS Spectroscopy
2 Use
pipeline processing no
interactive analysis yes
3 Description
rgsrmfgen creates an OGIP-compliant response matrix le as required for spectrum analysis within
XSPEC. Because a certain level of compatibility between the spectrum and response matrix is required,
it is typical and convenient (but not required) to create the spectrum rst and provide it as in input to
the response generator. The instrument's response within each incident (photon) energy bin is calculated
for every dispersion channel. The size of the matrix is determined, therefore, by the size of the spectrum
and the number of incident energy bins (ebins) specied on the command line. A matrix of one hundred
energy bins can be computed fairly quickly (about ten minutes) and is good for visual inspection, but is
not good for analysis. Two hundred fty bins is a minimum for use with rgs uxer, and three thousand is
probably acceptable for use with XSPEC. Be prepared to wait a while, and for periodic progress updates
set the verbosity level to four.
4 Parameters
This section documents the parameters recognized by this task (if any).
Parameter Mand Type Default Constraints
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 2
evlist yes dataset evlist.ds
The input events list, ltered or unltered. It must contain the EVENTS table and exposure map exten-
sions. Not modied. If the name of this dataset conforms with SAS conventions, then all other le names
required by this task are inferred by default.
le no le
The output response matrix le: OGIP-compliant format. The default le name is inferred from the
input evlist name as: *matrix.* if there are ten characters before the suфx, and
otherwise just srco.rmf.
srclist no dataset
The input sources list. It must contain the SOURCES table and the relevant ASC region extensions. Not
modied. The default le name is inferred from the input evlist name as: *SRCLI ????.* if there are
ten characters before the suфx, and otherwise just srclist.*.
source no integer 0 non-negative
The index number of an entry in the sources list. This determines the incidence angle and extraction
regions for the response matrix. The default value, zero, indicates the SOURCEID attribute of the EVENTS
table. If the input spectrum is enabled, its SOURCEID attribute supersedes this parameter, which is only
used for the default spectrum le name.
order no integer 1 positive
The re ection order number. This selects the energy extraction region for the response matrix. It is also
used in calculating the output EBOUNDS table. If the input spectrum is enabled, its RFLORDER attribute
supersedes this parameter, which is only used for the default spectrum le name.
emax no real 2.8 non-negative
The upper edge of the highest incident-energy bin in the response matrix.
emin no real 0.3 non-negative
The lower edge of the lowest incident-energy bin in the response matrix.
ebins no integer 4000 positive
The number of incident-energy bins in the response matrix. These are the rows of the matrix. The
columns are determined by the dispersion channel space, as specied in the input spectrum, if applicable,
or else the events list. A value of at least 3000 is recommended for use in XSPEC.
withbackground no boolean no
Negation enables the background correction to the response matrix, and the input sources list must
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 3
contain the background extraction region. If the input spectrum is enabled, its HDUCLAS2 attribute su-
persedes this parameter, which is only used for the default spectrum le name.
withspectrum no boolean yes
Assertion enables the input spectrum, which must have been generated by rgsspectrum. The response
matrix is made compatible with this spectrum, with regard to source, order, withbackground, and
response channel binning.
spectrumset no dataset
The input spectrum le, as generated by rgsspectrum. The default le name is inferred from the input
evlist name as: *SRSPEC.* if there are ten characters before the suфx, and otherwise
just srco.pha.
tdim no integer 3 1-5
The wings of the various distributions that are convolved together to form the narrow features of the
line-spread function are truncated to limit the size of the convolution space. An increment of one in
this parameter doubles the size of the convolution space; the larger the convolution space, the slower the
computation and the less power is lost to the truncation.
5 Errors
This section documents warnings and errors generated by this task (if any). Note that warnings and
errors can also be generated in the SAS infrastructure libraries, in which case they would not be docu-
mented here. Refer to the index of all errors and warnings available in the HTML version of the SAS
documentation.
nullExposure (error)
Either the input events list contains no exposure map extensions at all, or none of the
exposure maps enclose a non-zero area.
badEventSpace (error)
The channel denitions in the EVENTS table must align with the channel denitions in the
exposure map extensions.
badRebinning (error)
The channel denitions in the spectrum must align with some integral rebinning of the
dispersion channel denitions in the EVENTS table.
bkgResponse (error)
This task is not designed to generate a response matrix consistent with a BKG-type spec-
trum.
badInstrument (error)
The events list must be designated RGS1 or RGS2.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 4
badSource (error)
The SOURCES table has no entry with the specied source index number.
badBanana (error)
The energy extraction region must comprise only one cross-dispersion line segment at each
dispersion channel.
matrixBounds (error)
This error should never occur, and indicates a programming error.
6 Input Files
 An events list containing an EVENTS table and at least one exposure map extension, as
produced by rgslter.
 The sources list. Must contain the SOURCES table and all applicable extraction region exten-
sions, as produced by rgsregions. The background region need not be present if background
correction is not performed.
 A spectrum le is optional, but if provided must be of type NET or TOTAL, as produced
by rgsspectrum.
7 Output Files
 An OGIP-compliant response matrix le.
8 Algorithm
9 Comments
 This task is still in development.
References
xmmsas 20030110 1802-5.4.1