Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/7.0.0/doc/rgssuperrmf.ps.gz
Дата изменения: Thu Jun 29 01:19:27 2006
Дата индексирования: Tue Oct 2 10:00:50 2012
Кодировка:

XMM-Newton Science Analysis System Page: 1
rgssuperrmf
June 28, 2006
Abstract
****WARNING***** This task changes the SAS CCF environment variable from
a list of CCF les. DO NOT run another SAS task in the same terminal/session whilst
this task is running.
Creates one response matrix from one or more pha spectra les, also combining a
list of spectrum les (and background spectrum les) to create a combined spectrum
le and combined background spectrum le, if required.
1 Instruments/Modes
Instrument Mode
2 Use
pipeline processing no
interactive analysis yes
3 Description
The motivation for this task is to create one high resolution response matrix for a set of observations
without the need for creating individual high resolution matrices. The task diers in this aspect from
rgscombine and is designed to minimise the time and space required in producing the intermediary
steps to combine a set of observations, espcially for high resolution matrices of, for example, 50000 rows.
This task creates a single response matrix le using information from a list of spectrum from multiple
observations, and can also combine spectra and background spectra of the same instrument and spectral
order to produce nal les that can be used for futher, quantitative analysis in a tting package such
as Xspec. This diers from rgsfluxer, in that this task is able to produce a single response matrix
for the observation set for spectral analysis. The procedure makes use of the SAS task rgsrmfgen, so
that individual responses relevant to each individual observation are considered appropriately. This task
assumes the spectra have been produced by rgsproc using the attsyle=user parameter, to assure that
all spectra are aligned in wavelength. The call to rgsproc for each of the required observations with the
parameters attstyle, attra, attdec and attapos should be called prior to calling rgssuperrmf. For
example:
xmmsas 20060628 1801-7.0.0

XMM-Newton Science Analysis System Page: 2
rgsproc withsrc=yes srclabel=Capella srcstyle=radec srcra=79.172330 srcdec=+45.997991 attstyle=user
attra=79.172330 attdec=+45.997991 attapos=259.81
The spectrum attributes and response values, bar counts, are weighted prior to addition, in terms of the
exposure time or areascal of the individual observation. In this way the spectra (NET or TOTAL), and
the background spectra, can be combined.
4 Parameters
This section documents the parameters recognized by this task (if any).
Parameter Mand Type Default Constraints
phalist yes list
A list of spectrum les from a set of observations, referring to one RGS instrument and one spectral
order. These spectra les must be produced using the attstyle=user and associated parameters from a
call to rgsproc.
evlist yes list
A list of accompanying event list les, in the same order as the spectra les. Note, the le names are not
derived from the spectra les.
srclist yes list
A list of accompanying source list les, in the same order as the spectra les
bkglist yes list
A list of background spectrum les from a set of observations observations
withspeccombine no boolean yes
If this parameter is set to yes, the spectra les of the input lists will be combined to produced a combined
spectrum le each for both spectra and background spectra les.
lermf no le resultantmatrix.ds
Filename for nal response matrix
lepha no le combinedspectra.ds
Filename for nal spectrum
lebkg no le combinedback.ds
Filename for nal background spectrum
The remaining parameters are exactly the same as those for the task rgsrmfgen, and are used when
calling this task within rgssuperresponse, with the exception that spectra les are compulsory for this
task and therefore the option that appears in rgsrmfgen, withspectrum, has been removed and is always
true.
emax no real 2.8 non-negative
When creating a new response matrix, this is the upper edge of the highest incident-energy bin to be
included.
emin no real 0.3 non-negative
When creating a new response matrix, this is the lower edge of the lowest incident-energy bin to be
included. When overwriting part of an existing matrix (newrmf=no), this identies the lower incident-
xmmsas 20060628 1801-7.0.0

XMM-Newton Science Analysis System Page: 3
energy bin in the interval to be recomputed. This value will be lowered automatically as necessary to
maintain the contiguity of the bins, and can be used to extend the range of the existing matrix.
rows no integer 4000 positive
The number of incident-energy bins to cover the range from emin to emax.
phachannels no integer 3400 positive
The number of pha channels.
withmirrorpsf no boolean yes
Whether to convolve the standard mirror PSF distribution into the LSF. This option should be used with
care and knowledge. An appropriate circumstance for omitting the mirror PSF is when a custom angular
distribution is provided (withangdist=yes) that empirically establishes the PSF contribution.
withangdist no boolean no
Whether to convolve a custom angular distribution into the LSF. This option should be used with care and
knowledge. Enables parameter angdistset. Note that this distribution is one-dimensional, an arbitrary
function of dispersion o-axis angle. It is rebinned onto the dispersion channel space according to the
order and central incident energy of each LSF. The problem of reducing a two-dimensional image to this
one-dimensional distribution is left to the user.
angdistset no le angdist.txt
An ASCII le containing a one-dimensional angular distribution along the axis of dispersion in arc min-
utes. Not modied. Each line of the le describes a distribution bin in terms of the start and stop angles,
and the value assigned to that bin. The distribution may be normalized to any value, though unity is
expected and recommended. See the input les descriptions for further details.
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.
event pairing (error)
The number of event list les does not match the number of spectrum les; there must be
a one-to-one pairing.
bkg pairing (error)
The number of background spectra les does not match the number of spectrum les; there
must be a one-to-one pairing.
source pairing (error)
The number of source list les does not match the number of spectrum les; there must be
a one-to-one pairing.
xmmsas 20060628 1801-7.0.0

XMM-Newton Science Analysis System Page: 4
wrongOrder (error)
Either: The RFLORDER attribute (re ection order) of the background spectra (if applicable)
must match the RFLORDER of the corresponding spectrum.
wrongInstrument (error)
Either: The RGS instrument of the background spectrum le does not match that of the
pha spectra le.
Alignment of spectra (error)
The pha les are not aligned in terms of wavelength. The task rgsproc will have to be
called for each pha le with the appropriate attitude parameters (attastyle, attra, attdec,
attapos).
Environment variable warning,This tasks resets the SAS CCF environment variable (warn-
ing)
Making the user aware that this task uses multiple CCF les, and hence resets the SAS CCF
environment variable
corrective action:
No action required.
Filename parameter (warning)
No lename given for results les for either spectrum or response matrix
corrective action:
No action required. Defaults used.
6 Input Files
1. A list of spectrum les as produced by rgsproc with the option attstyle=user including
the parameters attra, attdec and attapos.
2. A list of event les as produced by rgsproc.
3. A list of source list les as produced by rgssources or rgsproc.
4. A list of background spectrum les as produced by rgsproc with the option attstyle=user
including the parameters attra, attdec and attapos (optional).
7 Output Files
1. A single response matrix le
2. A single combined spectrum le (optional but default)
3. A single combined background le (optional but default)
The output response matrix le is an OGIP-compliant Response Matrix File (RMF) as described in
output les
xmmsas\_20060628\_1801-7.0.0

XMM-Newton Science Analysis System Page: 5
8 Algorithm
ASSESS QUALITY: To apply information per channel
FOR EACH spectrum file:
totalexposure = totalexposure + EXPOSURE
IF withspeccombine
FOR EACH spectrum channel:
IF ( acceptable QUALITY )
channelexp = EXPOSURE * AREASCAL
OR IF SPECTRUM == NET
staterrquad = squared(STAT_ERR)
backscalexp = EXPOSURE * BACKSCAL
totalcounts = totalcounts + COUNTS
Then:
Accumulate counts, backscalexp and channelexp or staterrquad
ELSE
do not add counts
Call rgsrmfgen, creating temporary response onto which the channel quality criterion
is applied
FOR EACH response bin (rows):
FOR EACH response channel (columns) AND IF ( acceptable QUALITY for channel):
IF ( corresponding spectrum channel not discarded )
newresponse = newresponse + MATRIX * EXPOSURE * AREASCAL
FOR EACH spectrum channel:
IF (all quality flag 1 over all spectra files)
Set final quality flag to 1
IF (all quality flag 2 over all spectra files)
Set final quality flag to 2
ELSE
Set final quality flag to 0
IF spectrum == TOTAL
Finalareascal = channelexp / totalexposure
ELSE
Finalstaterr = square-root(staterrquad)
Finalbackscal = backscalexp / totalexposure
Finalresponse = newresponse / Finalareascal
Write to file
Add attributes for DATE-OBS, DATE-END, applicable to observation list
xmmsas 20060628 1801-7.0.0

XMM-Newton Science Analysis System Page: 6
9 Comments

References
xmmsas 20060628 1801-7.0.0