Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/5.4.1/doc/rgsprods.ps.gz
Дата изменения: Fri Jan 10 23:45:01 2003
Дата индексирования: Tue Oct 2 04:37:29 2012
Кодировка:

XMM-Newton Science Analysis System Page: 1
rgsprods
January 10, 2003
Abstract
This is a chain task that creates rgs data products by making use of the calibrated
event list and the extraction region specications.
1 Instruments/Modes
Instrument Mode
RGS spectroscopy
2 Use
pipeline processing yes
interactive analysis yes
3 Description
The task takes, for its input, les produced by rgsproc, namely: (i) an event list, (ii) a le containing
both a source list and information on selection regions, and (iii) an exposure map. The event list and the
region specications in the source list are used to create the RGS image and spectrum products. After
these are made, rgsprods adds a CONTENT keyword to each of the three input les, copies them into
the correct PPS lenames, and moves the resulting les to the directory designated by the parameter
prodsdir.
Although rgsprods, a perl script, has been designed primarily as a pipeline development tool, it can also
be used interactively.
Note that there is some overlap between this task and rgsproc. Both tasks create source and background
spectra. However this causes no problems in practice. With default parameter settings, rgsprods will
not overwrite les that rgsproc has written.
The method of submitting the names of the three input les to rgsprods has been designed to be
convenient, at some sacrice to generality. The fact is that nearly all the time these lenames occur in
one of two basic styles:
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 2
Style: File template:
rgsproc RRRROOOOOOOOOOIITEEE00 .ds,
where can be `ltered', `sources' or
`expmap'.
pcms POOOOOOOOOOIITEEEnnnnnn0000.FIT,
where nnnnnn can be EVENLI, SRCLI or
EXPMAP.
In these templates, RRRR is the rev number, OOOOOOOOOO is the observation identier, II the
instrument (either R1 or R2), EEE the exposure number and T the exposure type (either S or U)).
A parameter has only been provided for the name of the source list. If this le name follows either of the
templates above, rgsprods will attempt construct the names of the other two. If not, then the task will
fail.
4 Parameters
This section documents the parameters recognized by this task (if any).
Parameter Mand Type Default Constraints
evlistset yes dataset `'
The event list product created by rgsproc.
mode no string `spectrum' `spectrum'/`htr'
Instrument mode. The task may be changed later to determine this from the event list.
orders no string `1 2'
List of the spectrum orders for which products are required..
rebin no integer 1
Passed to rgsspectrum.
edgechannels no integer 2
Passed to rgsspectrum.
prodsdir no string '.'
Directory in which to write the product les.
cleanup no boolean no
Unlink temporary les after completion.
clobbertemps no boolean no
Overwrite temporary les.
clobberprods no boolean no
Overwrite product les.
astest no boolean no
Run in test mode (no invocation of tasks).
writelog no boolean no
Write to a log le called rgsprods.log, as well as to STDOUT.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 3
harsh no boolean no
When this is set, the task itself fails the rst time any of its invoked tasks fail; whereas if harsh=no, the
task attempts to keep going if at all possible.
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.
(error)
Event list name does not have the correct format.
(error)
Couldn't run evselect to make `banana' ts image.
(error)
Couldn't run rgsimplot to make `banana' gif image.
(error)
Couldn't move `banana' image to product path.
(error)
Couldn't convert `banana' plot from GIF to PNG.
(error)
Couldn't run evselect to make `banana' ts image.
(error)
Couldn't run rgsimplot to make `banana' gif image.
(error)
Couldn't move detplane image to product path.
(error)
Couldn't convert `banana' plot from GIF to PNG.
(error)
Can't nd prime source in the sources le header.
(error)
Couldn't run rgsspectrum to make ts background spectrum.
(error)
Source number too large - must be between 1 and 999 inclusive.
(error)
Couldn't run rgsspectrum to make ts source spectrum.
(error)
Couldn't run rgsspecplot to make source spectrum pdf plot.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 4
(error)
Couldn't copy event list to product path.
(error)
Couldn't copy exposure map to product path.
(warning)
Task output exists and clobbertemps or clobberprods not set.
corrective action: Task is not run.
(warning)
Task input not found.
corrective action: Task is not run.
Note: The task does not at present use the error interface, but uses internal message, warning and error
functions. The warning and error labels are therefore not relevant and have been omitted.
6 Input Files
1. Calibrated event list made by rgsproc.
2. Source list dataset, with associated region extensions, made by rgsproc.
3. Exposure map made by rgsproc.
7 Output Files
Products as follows:
1. POOOOOOOOOOIITEEEBIMAGE0000.FIT: BETA CORR vs. PI FITS image (known as the
banana plot).
2. POOOOOOOOOOIITEEEBIMAGE0000.PNG: BETA CORR vs. PI PNG image.
3. POOOOOOOOOOIITEEEIMAGE 0000.FIT: BETA CORR vs. XDISP CORR (ie, detector plane)
FITS image (only made in spectrum mode).
4. POOOOOOOOOOIITEEEIMAGE 0000.PNG: BETA CORR vs. XDISP CORR PNG image (only
made in spectrum mode).
5. POOOOOOOOOOIITEEESRSPECOSSS.FIT: for each order, for each source, an OGIP-
compliant FITS spectrum.
6. POOOOOOOOOOIITEEESPECTR0SSS.PDF: for each source, a PDF spectral plot (out-
put of rgsspecplot).
7. POOOOOOOOOOIITEEEBGSPECO000.FIT: for each order, an OGIP-compliant FITS
background spectrum.
8. POOOOOOOOOOIITEEEEVENLI0000.FIT: calibrated event list.
9. POOOOOOOOOOIITEEEEXPMAP0000.FIT: exposure map.
10. POOOOOOOOOOIITEEESRCLI 0000.FIT: source list (with extraction regions).
The characters have the same meaning as in described earlier.
xmmsas\_20030110\_1802-5.4.1

XMM-Newton Science Analysis System Page: 5
8 Algorithm
run evselect to make banana_fits
run rgsimplot to make banana_gif
mv banana_fits products_dir/banana_fits.FIT
giftopnm banana_gif | pnmtopng > products_dir/banana.PNG
if (param{mode} eq 'spectrum') {
run evselect to make detplane_fits
run rgsimplot to make detplane_gif
mv detplane_fits products_dir/detplane_fits.FIT
giftopnm detplane_gif | pnmtopng > products_dir/detplane.PNG
}
foreach (order) {
run rgsspectrum to make background_fits
} end foreach order
foreach (source) {
foreach (order) {
run rgsspectrum to make spectrum_fits
} end foreach order
run rgsspecplot with list of fits spectra as input, to make PDF spectrum plot
mv spectrum.PDF products_dir/spectrum.PDF
foreach (order) {
cp spectrum_fits products_dir/spectrum_fits.FIT
} end foreach order
} end foreach source
cp evlist to products_dir
cp expmap to products_dir
cp srclist to products_dir
9 Comments

References
xmmsas 20030110 1802-5.4.1