1 PCMS Processing
-----------------

Full release note for prod configuration xxxxxxxxxxxxxxxxxxxxxxx
================================================================

PCMS Infrastructure Version: x.y 
Pipeline Version: xxxxxxxxxxxxxxxxxxxxxxx
Pipeline Name: cat9.0
Release Date: 2012-xx-yy

SAS Manifest: xmmsas_yyyyyyyyyyy
SAS Version: x.y.z ppstrack


Summary
=======

This pipeline represents a major change with respect to the previous
prod8.4 pipeline (version:det_13_prod8.4_20120118.095500), embodying both
a substantial number of changes to the PCMS processing system itself and 
incorporation of version 12.0.1 of the SAS (with additional package updates). 

The most significant changes to the pipeline include:

i) Use of an empirical 2D PSF. This PSF provides a much improved 
description of the polygonal core structures of each of the instrumental 
PSFs and also the spoke patterns, compared to the previous Medium accuracy 
PSF - see Read et al., 2011, A&A, 534, 34 (http://adsabs.harvard.edu/abs/2011A%26A...534A..34R)

ii) Extraction of source-specific products (SSP) (time-series and spectra) for 
individual sources is redesigned. Firstly, the size of the (circular) source 
extraction aperture is now optimized (using eregionanalyse) to yield maximum 
signal-to-noise - previously a fixed aperture of radius 28" was used. The 
aperture is restricted to a radius (r) where 12" < r < 40". Secondly, the 
previous annular background region (60" < r_back < 180", co-centred on the 
source position) is replaced by a circular region of comparable area but it is now 
offset from the source so as to ensure there is sufficient background signal 
in all circumstances. A minimum of 70% useful area is required, except in 
exceptional circumstances. This, in particular, resolves problems 
found with negligible background data being available for sources in MOS SW 
modes in earlier processing.

Spectra and time-series are now extracted for all sources whose spectra (source 
plus background) contain > 100 good counts (cf the original process which 
demanded > 500 EPIC counts).

iii) The background flare filtering now uses a S/N optimization approach and 
operates on an in-band (0.5-7.5 keV) light-curve from which prominent sources 
(eboxdetect likelihood > 50) have been masked out. The algorithm discards, in 
declining order, high count-rate time-bins, computing the S/N of the residual 
data, to find the cut rate at which the S/N peaks. This can result in 
significant increases and decreases of usable exposure time. The flare 
background time-series is now exposure corrected and the file contains the 
S/N v rate-cut curve. The PDF graphic also shows the S/N v rate-cut curve.

iv) Astrometric correction is now performed by the task catcorr. This makes 
use of a number of enhancements over the previous task, eposcorr. A 
notable change is its ability to make use of multiple reference catalogues. 
In the pipeline the task catprep now generates a file that contains upto 3 
reference catalogue extracts (SDSS-DR9 where available, USNO B1.0 and 2MASS). 
Each, where available, is used to determine the field offset correction and 
the 'best' solution is adopted for the correction if it meets the 
application criteria. The task also employs an algorithm that takes account 
of the local density of reference sources and performs fitting to find the 
solution rather than a grid technique. In principle, use of the 2MASS 
catalogue allows the process to find solutions in more fields, particularly in 
the galactic plane, than the previous USNO B1 -only approach.

v) A number of astrometry issues have been addressed since 2XMM. In particular, 
a time-dependent boresight (CCF) is now employed that removes a 1-2" time-dependent 
pointing variation. This is important in fields that can not be corrected by catcorr. 

 vi) Masks are generated to identify OOT and scattered RGA features from 
piled-up sources. These masks are used to 1) flag detections centred within 
the mask and 2) to avoid locating SSP background regions on them.

vii) RGS spectra are now computed in wavelength space

viii) RGS time-series are generated for the first time.



The cat9.0 pipeline is being used to perform a bulk reprocessing of all the 
XMM data that will feed in to the 3XMM X-ray source catalogue. The pipeline, 
SAS and calibration data used in this bulk reprocessing are static. The SAS 
being used is a pipeline-specific manifest, ppstrack xxxxxxxxxxxxxxxx. This 
is based on the public SAS release 12.0.1, described at  
http://xmm.esac.esa.int/sas/current/documentation/releasenotes/xmmsas_12.0.1.shtml. 
A number of further SAS task upgrades were required for the cat9.0 
pipeline, hence the need for a specific ppstrack. The SAS tasks used in the 
cat9.0 pipeline are specified below. 




Documentation
=============

Documentation for this pipeline can be found at:

 <url: ????????????????????????????????????????????????????????>

see also 

http://xmm.esac.esa.int/external/pipeline/ 

and links therein, which will become active in 2013 and ultimately 
replace the SSC page. 

Documentation for the pipeline products can be accessed via the 
Specification for individual SSC data products, issue 4.0.

http://xmm.esac.esa.int/external/xmm_user_support/documentation/index.shtml



Pipeline Summary
================

i.    Products Created.
ii.   SAS Tasks.
iii.  Calibration Files.
iv.   Response Matrices.
v.    Energy Bands.
vi.   Energy Conversion Factors.
vii.  Source Position Rectification.




i. Products Created
===================

The following table summarises all possible product files created by
this pipeline. Withdrawn products are noted for completeness.

Product file names are subdivided into components:

        Pooooooooooiiseeeccccccbnnn.ttt

where:
oooooooooo is the Observation Identifier.
ii         is the instrument.
s          is the scheduled flag.
eee        is the exposure number.
cccccc     is the file identifier given in the table below.
b          is the instrument specific field (ISF):
               Energy band for EPIC instruments.
               OM science window or OM filter code for OM products.
               Spectral order for RGS products.
nnn        is the hexidecimal source number or 000.
ttt        is the file type.



|=============|========================================|===================|=========|==============|========|==============|
| Status/notes| Product Index Description              | File Identifier   | Class   | File Types   | ISF    | Per Source   |
|=============|========================================|===================|=========|==============|========|==============|
|             | EPIC OBSERVATION BOX-LOCAL SOURCE LIST | OBLSLI            | EPICOBS | FIT          |        |              |
|             | EPIC OBSERVATION BOX-MAP SOURCE LIST   | OBMSLI            | EPICOBS | FIT          |        |              |
|             | EPIC OBSERVATION SENSITIVITY MAP       | OSNSMP            | EPICOBS | FIT          | BAND   |              |
|             | EPIC SOURCE DS9 REGIONS                | REGION            | EPICOBS | ASC          |        |              |
|             | EPIC OBSERVATION ML SOURCE LIST        | OMSRLI            | EPICOBS | FIT          |        |              |
|             | EPIC SUMMARY SOURCE LIST               | OBSMLI            | EPICOBS | FIT,HTM      |        |              |
|             | EPIC DETECTION MASK                    | DETMSK            | EPICOBS | FIT          | BAND   |              |
|             | EPIC MERGED BACKGROUND MAP             | BKGMAP            | EPICOBS | FIT          | BAND   |              |
|  (1)NEW     | EPIC MERGED EXPOSURE MAP               | MEXPMP            | EPICOBS | FIT          | BAND   |              |
|             | EPIC OBSERVATION BACKGROUND MAP        | OBKGMP            | EPICOBS | FIT,PNG      | BAND   |              |
|             | EPIC OBSERVATION EXPOSURE MAP          | OEXPMP            | EPICOBS | FIT,PNG      | BAND   |              |
|             | EPIC OBSERVATION IMAGE                 | OIMAGE            | EPICOBS | FIT,PNG      | BAND   |              |
|             | EPIC OBSERVATION SUMMARY               | SUMMAR            | EPICOBS | HTM          |        |              |
|             | EPIC MOS IMAGING MODE EVENT LIST       | MIEVLI            | EPICEXP | FIT          |        |              |
|             | EPIC PN IMAGING MODE EVENT LIST        | PIEVLI            | EPICEXP | FIT          |        |              |
|             | EPIC TIMING MODE EVENT LIST            | TIEVLI            | EPICEXP | FIT          |        |              |
|             | EPIC FLARE BACKGROUND TIMESERIES       | FBKTSR            | EPICEXP | FIT,PDF      |        |              |
|             | EPIC EXPOSURE MAP                      | EXPMAP            | EPICEXP | FIT,PNG      | BAND   |              |
|             | EPIC IMAGE                             | IMAGE_            | EPICEXP | FIT,PNG      | BAND   |              |
|             | EPIC SOURCE DS9 REGION                 | SRCREG            | EPICSRC | ASC          |        | Y            |
|             | EPIC ANCILLARY RESPONSE FUNCTION       | SRCARF            | EPICSRC | FIT          |        | Y            |
|             | EPIC SOURCE BACKGROUND SPECTRUM        | BGSPEC            | EPICSRC | FIT          |        | Y            |
|             | EPIC SOURCE SPECTRUM                   | SRSPEC            | EPICSRC | FIT          |        | Y            |
|             | EPIC SOURCE TIMESERIES                 | SRCTSR            | EPICSRC | FIT          | BAND   | Y            |
|             | EPIC SOURCE SPECTRUM PLOT              | SPCPLT            | EPICSRC | PDF          |        | Y            |
|             | EPIC SOURCE TIMESERIES PLOT            | STSPLT            | EPICSRC | PDF          | BAND   | Y            |
|             | OM FULL-FRAME IMAGE                    | FIMAG_            | OMEXP   | FIT          |        |              |
|             | OM TRACKING STAR TIMESERIES            | TSTRTS            | OMEXP   | FIT          |        |              |
|             | OM FULL-FRAME SKY IMAGE                | FSIMAG            | OMEXP   | FIT,PNG      |        |              |
|             | OM TRACKING HISTORY PLOT               | TSHPLT            | OMEXP   | PDF          |        |              |
|             | OM OBSERVATION SOURCE LIST             | OBSMLI            | OMOBS   | FIT          |        |              |
|             | OM FULL-FRAME HIRES SKY IMAGE MOSAIC   | HSIMAG            | OMOBS   | FIT,PNG      | FILTER |              |
|             | OM FULL-FRAME LORES SKY IMAGE MOSAIC   | LSIMAG            | OMOBS   | FIT,PNG      | FILTER |              |
|             | OM RUDI-5 SKY IMAGE MOSAIC             | RSIMAG            | OMOBS   | FIT,PNG      | FILTER |              |
|             | OM USER WINDOWS SKY IMAGE MOSAIC       | USIMAG            | OMOBS   | FIT,PNG      | FILTER |              |
|             | OM OBSERVATION SUMMARY                 | SUMMAR            | OMOBS   | HTM          |        |              |
|             | OM OSW SOURCE TIMESERIES               | TIMESR            | OMSRC   | FIT,PDF      | OSW    | Y            |
|             | OM GRISM DS9 REGIONS                   | SGSREG            | OMSW    | ASC          | OSW    |              |
|             | OM GRISM DS9 SPECTRUM REGIONS          | SPCREG            | OMSW    | ASC          | OSW    |              |
|             | OM OSW FAST REGION FILE                | SFSREG            | OMSW    | ASC          | OSW    |              |
|             | OM OSW REGION FILE                     | SWSREG            | OMSW    | ASC          | OSW    |              |
|             | OM FAST MODE OSW IMAGE                 | IMAGEF            | OMSW    | FIT          | OSW    |              |
|             | OM FAST MODE OSW SKY IMAGE             | SIMAGF            | OMSW    | FIT          | OSW    |              |
|             | OM GRISM SPECTRA LIST                  | SPECLI            | OMSW    | FIT          | OSW    |              |
|             | OM OSW FAST SOURCE LIST                | SFSRLI            | OMSW    | FIT          | OSW    |              |
|             | OM OSW GRISM SOURCE LIST               | SGSRLI            | OMSW    | FIT          | OSW    |              |
|             | OM OSW IMAGE                           | IMAGE_            | OMSW    | FIT          |        |              |
|             | OM OSW SOURCE LIST                     | SWSRLI            | OMSW    | FIT          |        |              |
|             | OM GRISM SOURCE SPECTRUM               | SPECTR            | OMSW    | FIT,PDF      | OSW    | Y            |
|             | OM GRISM-ALIGNED IMAGE                 | GIMAGE            | OMSW    | FIT          | OSW    |              |
|             | OM OSW SKY IMAGE                       | SIMAGE            | OMSW    | FIT,PNG      |        |              |
|             | RGS BACKGROUND MODEL                   | BGMODL            | RGSEXP  | FIT          | ORDER  |              |
|             | RGS EVENT LIST                         | EVENLI            | RGSEXP  | FIT          |        |              |
|             | RGS EXPOSURE MAP                       | EXPMAP            | RGSEXP  | FIT          |        |              |
|             | RGS SOURCE LIST                        | SRCLI_            | RGSEXP  | FIT          |        |              |
|             | RGS WHOLE FIELD RESPONSE MATRIX        | WREMAT            | RGSEXP  | FIT          | ORDER  | Y            |
|             | RGS ENERGY-DISPERSION IMAGE            | ORDIMG            | RGSEXP  | FIT,PNG      |        |              |
|             | RGS FLARE BACKGROUND TIMESERIES        | FBKTSR            | RGSEXP  | FIT          |        |              |
|             | RGS IMAGE                              | IMAGE_            | RGSEXP  | FIT,PNG      |        |              |
|             | RGS WHOLEFIELD SPECTRUM                | WFSPEC            | RGSEXP  | FIT,PDF      | ORDER  |              |
|             | RGS FLUXED SPECTRUM                    | FLUXED            | RGSOBS  | FIT,PDF      | ORDER  | Y            |
|             | RGS OBSERVATION SUMMARY                | SUMMAR            | RGSOBS  | HTM          |        |              |
|             | RGS CROSS-DISPERSION HISTOGRAM         | DSPHIS            | RGSSRC  | FIT          | ORDER  | Y            |
|             | RGS RESPONSE MATRIX                    | RSPMAT            | RGSSRC  | FIT          | ORDER  | Y            |
|             | RGS SOURCE BACKGROUND SPECTRUM         | BGSPEC            | RGSSRC  | FIT          | ORDER  | Y            |
|             | RGS SOURCE SPECTRUM                    | SRSPEC            | RGSSRC  | FIT,PDF      | ORDER  | Y            |
|             | RGS BACKGROUND SPECTRUM                | SBSPEC            | RGSSRC  | FIT          | ORDER  | Y            |
|   (2)NEW    | RGS SOURCE BACKGROUND TIMESERIES       | SRBTSR            | RGSSRC  | FIT          |        | Y            |
|   (2)NEW    | RGS SOURCE TIMESERIES                  | SRCTSR            | RGSSRC  | FIT          |        | Y            |
|             | MAIN CROSS CORRELATION PAGE            | XCORRE            | CATOBS  | HTM          |        |              |
|             | CATALOGUE DESCRIPTIONS                 | Dxxxxa            | CATCAT  | HTM          |        |              |
|             | EPIC FOV CROSS-CORRELATION RESULTS     | FOVRES            | CATCAT  | HTM          |        |              |
|             | EPIC FOV CROSS-CORRELATION RESULTS     | Fxxxxa            | CATCAT  | FIT          |        |              |
|             | EPIC SOURCE CROSS-CORRELATION RESULTS  | Sxxxxa            | CATOBS  | FIT          |        |              |
|             | EPIC SOURCE CROSS-CORRELATION RESULTS  | SRCRES            | CATOBS  | HTM          |        |              |
|             | EPIC SOURCE CROSS-CORRELATION SUMMARY  | SRCSUM            | CATOBS  | HTM          |        |              |
|             | EPIC SOURCE CROSS-CORRELATION SUMMARY  | SRCSUM            | CATOBS  | FIT          |        |              |
|             | EPIC FOV CROSS-CORRELATION SUMMARY     | FOVSUM            | CATOBS  | FIT          |        |              |
|             | EPIC FOV CROSS-CORRELATION SUMMARY     | FOVSUM            | CATOBS  | HTM          |        |              |
|             | EPIC CATALOGUE PLOT                    | CATPLT            | CATOBS  | PDF          |        |              |
|             | SEARCHED CATALOGUES                    | SRCHD_            | CATOBS  | HTM          |        |              |
|             | SEARCHED CATALOGUES                    | SRCHD_            | CATOBS  | FIT          |        |              |
|             | XMM-ROSAT IMAGE                        | ROSIMG            | CATOBS  | PDF          |        |              |
|             | FINDING CHART                          | FCHART            | CATSRC  | PDF          |        | Y            |
|             | PPS RUN MESSAGE                        | PPSMSG            | PPSOBS  | ASC          |        |              |
|             | PPS SCRIPT LOG                         | SCRLOG            | PPSOBS  | ASC          |        |              |
|             | ATTITUDE TIME SERIES                   | ATTTSR            | PPSOBS  | FIT          |        |              |
|    (3)      | REFERENCE CATALOGUE                    | REFCAT            | PPSOBS  | FIT          |        |              |
|             | CALIBRATION INDEX FILE                 | CALIND            | PPSOBS  | FIT          |        |              |
|             | PPS PRODUCT INDEX                      | PINDEX            | PPSOBS  | FIT          |        |              |
|             | PPS OBSERVATION SUMMARY                | SUMMAR            | PPSOBS  | HTM          |        |              |
|             | PPS RUN SUMMARY                        | PPSSUM            | PPSOBS  | HTM          |        |              |
|             | SSC LOGO 1                             | SSCLG1            | PPSOBS  | PNG          |        |              |
|             | SSC LOGO 2                             | SSCLG2            | PPSOBS  | PNG          |        |              |
|             | CDS LOGO 1                             | CDSLG1            | PPSOBS  | PNG          |        |              |
|             | CDS LOGO 2                             | CDSLG2            | PPSOBS  | PNG          |        |              |
|             | CDS LOGO 3                             | CDSLG3            | PPSOBS  | PNG          |        |              |
|=============|========================================|===================|=========|==============|========|==============|


Notes

(1) - A per-EPIC-camera exposure-merged exposure map is now made
(2) - New time-series products of sources extracted from the RGS instruments
(3) - The astrometric reference catalogue file now contains multiple extensions (up to 3), 
      containing the USNO-B1.0, 2MASS and, where available, SDSS catalogue extracts for the 
      field.  


The EPIC SOURCE FFT PLOT   PDF graphic (SFFTPL) from the EPICSRC group, is no longer made.
The files from the CAT* classes, are products generated by the Archival Catalogue and Database 
Subsystem (ACDS) at the Observatoire Astronomique de Strasbourg (OAS) - they are the result of 
cross-correlations of XMM sources with archival catalogues by the ACDS. They have been made 
previously but are outlined here for the first time. Those files with xxxxa tags are generated 
for each external catalogue that the XMM sources are correlated with.


ii. SAS Tasks
=============

The current pipeline uses a pipeline-specific SAS manifest, ppstrack 
xmmsas_xxxxxxxx_yyyy  


This manifest is built upon the version 12.0.1 release of the SAS 
(manifest xmmsas_20120621_1321 - see 
http://xmm.esac.esa.int/sas/current/documentation/releasenotes/xmmsas_12.0.1.shtml.
for details of the SAS task versions and changes relative to the previous 
SAS releases) but includes a number of specific task patches identified as essential 
for the cat9.0 pipeline and the bulk reprocessing for 3XMM.

SAS tasks from this manifest, used in the pipeline for the bulk reprocessing are 
shown in the table below, along with the relevant versions of the tasks in the 
ppstrack and the public SAS12.0.1 manifest. The second column indicates whether the 
task has a newer (>) or the same (=) version number in the ppstrack cf SAS12.0.1. 


|===============|===|=================|============|
| TASK          |   | PUBLIC (12.0.1) | CAT9.0     |
|===============|===|=================|============|
|  addattribute | = |   2.2.6         |   2.2.6    |
|  arfgen       | > |   1.83.4        |   1.84     |
|  attcalc2     | = |   1.3.3         |   1.3.3    |
|  attcalc      | > |   4.32.2        |   4.33     |
|  attfilter    | = |   1.3.2         |   1.3.2    |
|  atthkgen     | = |   1.20.1        |   1.20.1   |
|  badpix       | = |   2.32.1        |   2.32.1   |
|  badpixfind   | > |   1.37          |   1.38     |
|  bkgfilter    | > |   1.1           |   1.6      |
|  catcorr      | > |   0.4.4         |   0.7      |
|  catprep      | > |   0.3.2         |   0.3.8    |
|  cifbuild     | = |   4.7.2         |   4.7.2    |
|  daltools     | = |   1.9.1         |   1.9.1    |
|  dpssflag     | > |   10.4          |   11.2     |
|  dpsssrc      | = |   1.1           |   1.1      |
|  dscalc       | = |   2.6.2         |   2.6.2    |
|  ebkgmap      | > |   2.6.1         |   2.7      |
|  eboxdetect   | > |   4.22.3        |   4.22.4   |
|  eexpmap      | = |   4.6.5         |   4.6.5    |
|  efftplot     | = |   2.18.2        |   2.18.2   |
|  ekstest      | > |   2.4.1         |   2.5      |
|  elcplot      | = |   2.5.2         |   2.5.2    |
|  emask        | = |   2.13.3        |   2.13.3   |
|  embadpixfind | = |   2.3           |   2.3      |
|  emenergy     | = |   8.6.2         |   8.6.2    |
|  emevents     | = |   8.4           |   8.4      |
|  emeventsproj | = |   1.5.2         |   1.5.2    |
|  emframes     | = |   5.8.1         |   5.8.1    |
|  emldetect    | = |   5.17.4        |   5.17.4   |
|  emosaic      | = |   1.16          |   1.16     |
|  emtaglenoise | = |   1.0.5         |   1.0.5    |
|  epevents     | = |   6.43          |   6.43     |
|  epexposure   | > |   0.10          |   0.12     |
|  epframes     | > |   8.92.2        |   8.93     |
|  epiclccorr   | > |   1.7.2         |   1.9      |
|  epnoise      | > |   0.7.2         |   0.7.3    |
|  eposcorr     | = |   3.12.2        |   3.12.2   |
|  epreject     | = |   5.14.4        |   5.14.4   |
|  esensmap     | = |   3.11.1        |   3.11.1   |
|  esources     | = |   1.4.1         |   1.4.1    |
|  especget     | = |   1.31.4        |   1.31.4   |
|  esplinemap   | = |   4.4.2         |   4.4.2    |
|  evalcorr     | = |   0.7.1         |   0.7.1    |
|  evlistcomb   | = |   4.19.2        |   4.19.2   |
|  evselect     | = |   3.61.1        |   3.61.1   |
|  gtialign     | = |   2.10          |   2.10     |
|  gtimerge     | = |   1.7.2         |   1.7.2    |
|  hkgtigen     | = |   1.14.2        |   1.14.2   |
|  implot       | = |   2.18          |   2.18     |
|  lccorr_pcms  | = |   1.6.1         |   1.6.1    |
|  lcplot       | = |   1.20          |   1.20     |
|  merge        | = |   0.13.1        |   0.13.1   |
|  odfingest    | = |   3.28.3        |   3.28.3   |
|  omatt        | = |   2.52.1        |   2.52.1   |
|  omcomb       | = |   2.4.5         |   2.4.5    |
|  omcosflag    | = |   1.29          |   1.29     |
|  omdetect     | = |   5.28          |   5.28     |
|  omdrifthist  | = |   1.28.2        |   1.28.2   |
|  omfastflat   | = |   1.21          |   1.21     |
|  omfastshift  | = |   1.25.1        |   1.25.1   |
|  omflatfield  | = |   2.6.3         |   2.6.3    |
|  omflatgen    | = |   1.12.2        |   1.12.2   |
|  omgprep      | = |   1.9           |   1.9      |
|  omgrism      | = |   1.25.1        |   1.25.1   |
|  omgrismplot  | = |   1.5.3         |   1.5.3    |
|  omlcbuild    | = |   1.37.4        |   1.37.4   |
|  ommag        | = |   3.10.2        |   3.10.2   |
|  ommodmap     | = |   2.22          |   2.22     |
|  ommosaic     | = |   2.5.17        |   2.5.17   |
|  omprep       | = |   2.44          |   2.44     |
|  omregion     | = |   2.11.2        |   2.11.2   |
|  omsrclistcomb| = |   2.16.1        |   2.16.1   |
|  omthconv     | = |   1.34.1        |   1.34.1   |
|  ppssumm      | = |   3.4.11        |   3.4.11   |
|  region       | = |   7.12.1        |   7.12.1   |
|  rgsangles    | = |   4.7.1         |   4.7.1    |
|  rgsbadpix    | = |   2.18.3        |   2.18.3   |
|  rgsbkgmodel  | = |   1.3.4         |   1.3.4    |
|  rgsenergy    | = |   2.0.4         |   2.0.4    |
|  rgsevents    | = |   3.12.3        |   3.12.3   |
|  rgsfilter    | = |   1.17.1        |   1.17.1   |
|  rgsfluxer    | = |   1.8           |   1.8      |
|  rgsframes    | = |   3.17.2        |   3.17.2   |
|  rgsimplot    | = |   1.17.1        |   1.17.1   |
|  rgslccorr    | = |   0.52.1        |   0.52.1   |
|  rgsoffsetcalc| = |   1.18.1        |   1.18.1   |
|  rgsregions   | = |   1.19.4        |   1.19.4   |
|  rgsrmfgen    | = |   1.11.2        |   1.11.2   |
|  rgssources   | = |   6.2.2         |   6.2.2    |
|  rgsspecplot  | = |   2.21          |   2.21     |
|  rgsspectrum  | = |   2.7.5         |   2.7.5    |
|  slconv       | = |   2.4           |   2.4      |
|  srcmatch     | > |   3.15.20       |   3.16     |
|  tabgtigen    | = |   2.12.3        |   2.12.3   |
|  tools        | = |   1.64.2        |   1.64.2   |
|  xcolorcod    | = |   1.22.2        |   1.22.2   |
|===============|===|=================|============|



iii. Calibration Files
======================

Pipeline processing generally accesses an evolving set of CCFs (current 
calibration files). For each observation, a subset of the full set of CCFs 
is used in processing that pertains to the epoch of the observation; the 
CCF components/versions used are identified in the calibration index file
(PooooooooooOBX000CALIND0000.FIT) that is included in the delivered 
observation data product set.

However, for the bulk reprocessing, a fixed set of calibration files are used. 
A complete list of CCFs used in the bulk processing is given here:



|==============================|=============|
| Calibration File             | Issue range | 
|==============================|=============|
| EMOS1ADUCONV                 |  0070-0085  |       
| EMOS1BACKGROUND              |  0001       |
| EMOS1BADPIX                  |  0025-0034  |        
| EMOS1CALSOURCEDATA           |  0001       |
| EMOS1CTI                     |  0058-0073  |
| EMOS1DARKFRAME               |  0011-0033  |
| EMOS1EFFICIENCY              |  0001       |
| EMOS1FILTERTRANSX            |  0014       |
| EMOS1HKPARMINT               |  0008-0009  |
| EMOS1LINCOORD                |  0018       |
| EMOS1MODEPARAM               |  0006       |
| EMOS1PATTERNLIB              |  0005       |
| EMOS1QUANTUMEF               |  0018       |
| EMOS1REDIST                  |  0093-0105  |
| EMOS1SCREENTHRESH            |  0001       |
| EMOS1TIMECORR                |  0003       |
! 			       |             |
| EMOS2ADUCONV                 |  0071-0086  |
| EMOS2BACKGROUND              |  0001       |
| EMOS2BADPIX                  |  0017-0026  |
| EMOS2CALSOURCEDATA           |  0001       |
| EMOS2CTI                     |  0059-0074  |
| EMOS2DARKFRAME               |  0011-0031  |
| EMOS2EFFICIENCY              |  0001       |
| EMOS2FILTERTRANSX            |  0014       |
| EMOS2HKPARMINT               |  0008-0009  |
| EMOS2LINCOORD                |  0018       |
| EMOS2MODEPARAM               |  0006       |
| EMOS2PATTERNLIB              |  0005       |
| EMOS2QUANTUMEF               |  0018       |
| EMOS2REDIST                  |  0093-0105  |
| EMOS2SCREENTHRESH            |  0001       |
| EMOS2TIMECORR                |  0003       |
|			       |             |
| EPNADUCONV                   |  0077-0141  |
| EPNBACKGROUND                |  0001       |
| EPNBADPIX                    |  0093-0144  |
| EPNBUCLOSEDODI               |  0001-0005  |
| EPNCALSOURCEDATA             |  0001       |
| EPNCTI                       |  0026       |
| EPNDARKFRAME                 |  0001       |
| EPNEFFICIENCY                |  0001       |
| EPNFILTERTRANSX              |  0018       |
| EPNHKPARMINT                 |  0005       |
| EPNLINCOORD                  |  0009       |
| EPNMODEPARAM                 |  0003       |
| EPNPATTERNLIB                |  0001       |
| EPNQUANTUMEF                 |  0017       |
| EPNREDIST                    |  0011       |
| EPNREJECT                    |  0006       |
| EPNTICLOSEDODI               |  0001-0013  |
| EPNTIMECORR                  |  0011-0015  |
|			       |             |
| OMASTROMET                   |  0012       |
| OMBADPIX                     |  0005       |
| OMCOLORTRANS                 |  0010       |
| OMDARKFRAME                  |  0003       |
| OMDIFFUSEGALA                |  0001       |
| OMGRISMCAL                   |  0004       |
| OMHKPARMINT                  |  0004       |
| OMLARGESCALESENS             |  0002       |
| OMLINCOORD                   |  0001       |
| OMPHOTTONAT                  |  0005       |
| OMPIXTOPIXSENS               |  0003       |
| OMPSF1DRB                    |  0010       |
| OMQUICKMAG                   |  0002       |
| OMZODIACAL                   |  0001       |
|			       |	     |
| RGS1ADUCONV                  |  0006-0024  |
| RGS1BACKGROUND               |  0001       |
| RGS1BADPIX                   |  0012-0032  |
| RGS1CALSOURCEDATA            |  0001       |
| RGS1CLOCKPATTERNS            |  0001       |
| RGS1COOLPIX                  |  0001       |
| RGS1CROSSPSF                 |  0004       |
| RGS1CTI                      |  0001-0012  |
| RGS1DARKFRAME                |  0005       |
| RGS1EFFAREACORR              |  0008       |
| RGS1EXAFS                    |  0005       |
| RGS1HKPARMINT                |  0009-0013  |
| RGS1LINCOORD                 |  0008       |
| RGS1LINESPREADFUNC           |  0005       |
| RGS1MODEPARAM                |  0004-0005  |
| RGS1QUANTUMEF                |  0015       |
| RGS1REDIST                   |  0004       |
| RGS1TEMPLATEBCKGND           |  0006       |
| RGS2ADUCONV                  |  0006-0027  |
| RGS2BACKGROUND               |  0001       |
| RGS2BADPIX                   |  0012-0032  |
| RGS2CALSOURCEDATA            |  0001       |
| RGS2CLOCKPATTERNS            |  0001       |
| RGS2COOLPIX                  |  0001       |
| RGS2CROSSPSF                 |  0004       |
| RGS2CTI                      |  0001-0013  |
| RGS2DARKFRAME                |  0006       |
| RGS2EFFAREACORR              |  0008       |
| RGS2EXAFS                    |  0005       |
| RGS2HKPARMINT                |  0008-0012  |
| RGS2LINCOORD                 |  0008       |
| RGS2LINESPREADFUNC           |  0005       |
| RGS2MODEPARAM                |  0004-0005  |
| RGS2QUANTUMEF                |  0016       |
| RGS2REDIST                   |  0004       |
| RGS2TEMPLATEBCKGND           |  0007-0008  |
|			       |	     |
| XMMABSCOEFS                  |  0004       |
| XMMBORESIGHT                 |  0023       |
| XMMMISCDATA                  |  0022       |
| XMMSPECQUAL                  |  0002       |
| XRT1XAREAEF                  |  0008       |
| XRT1XENCIREN                 |  0003       |
| XRT1XPSF                     |  0014       |
| XRT2XAREAEF                  |  0009       |
| XRT2XENCIREN                 |  0003       |
| XRT2XPSF                     |  0014       |
| XRT3XAREAEF                  |  0011       |
! XRT3XENCIREN                 |  0003       |
! XRT3XPSF                     |  0014       |
|==============================|=============|





iv. Response Matrices
=====================

The pipeline accesses a set of canned response matrices (RMFs) which are 
generally updated from time to time. EPIC MOS RMFs are defined via a set of 
epoch-dependent files (13 epochs to date). They are further divided by 
instrument mode and by detector position - in particular, MOS RMFs are 
available to reflect the impacts of changes occurring in the core (c) and 
wings (w) of a small patch known to have suffered degradation, as well as 
off-patch (o) locations (i.e. everywhere else on the detector). PN RMFs are 
divided by instrument mode and position along the Y-direction of the CCDs. 
For EPIC PN, the bulk reprocessing uses version 11.0. Both MOS and PN RMFs 
used in the bulk reprocessing were released in April 20011. 

The canned EPIC response matrices used in the bulk reprocessing are shown below.


|==============================|
| Canned RMFs                  |
|==============================|
|  m<I>_e<i>_im_p0_c.rmf       |
|  m<I>_e<i>_im_p0_w.rmf       |
|  m<I>_e<i>_im_pall_o.rmf     |
|  m<I>_e<i>_tu_p0_c.rmf       |
|  m<I>_e<i>_tu_p0_w.rmf       |
|  m<I>_e<i>_tu_pall_o.rmf     |
|  m<I>_e<i>_im_p0_o.rmf       |
|  m<I>_e<i>_im_pall_c.rmf     |
|  m<I>_e<i>_im_pall_w.rmf     |
|  m<I>_e<i>_tu_p0_o.rmf       |
|  m<I>_e<i>_tu_pall_c.rmf     |
|  m<I>_e<i>_tu_pall_w.rmf     |
|                              |
|  epn_bu23_dY9_v11.0.rmf      |
|  epn_bu23_sdY9_v11.0.rmf     |
|  epn_bu23_sY9_v11.0.rmf      |
|  epn_ef20_dY<j>_v11.0.rmf    |
|  epn_ef20_sdY<j>_v11.0.rmf   |
|  epn_ef20_sY<j>_v11.0.rmf    |
|  epn_ff20_dY<j>_v11.0.rmf    |
|  epn_ff20_sdY<j>_v11.0.rmf   |
|  epn_ff20_sY<j>_v11.0.rmf    |
|  epn_lw20_dY<m>_v11.0.rmf    |
|  epn_lw20_sdY<m>_v11.0.rmf   |
|  epn_lw20_sY<m>_v11.0.rmf    |
|  epn_sw20_dY<n>_v11.0.rmf    |
|  epn_sw20_sdY<n>_v11.0.rmf   |
|  epn_sw20_sY<n>_v11.0.rmf    |
|  epn_ti40_sdY9_v11.0.rmf     |
|==============================|

where <I> = 1 (MOS1) or 2 (MOS2), 
<i>, i=1-13 (epochs); 
and 
<j>, j=0-9 (Y-positions); 
<m>, m=5-9 (Y-positions);
<n>, n=7-9 (Y-positions);

 
The latest available canned response files are described at, and available from,  
http://xmm2.esac.esa.int/external/xmm_sw_cal/calib/index.shtml. See also 
http://xmm2.esac.esa.int/external/xmm_sw_cal/calib/epic_files_updates.shtml#up:2012 
for further details on changes to EPIC RMFs



v. Energy Bands
===============

|======|===================|
| Band | Energy Range (eV) |
|======|===================|
| 1    |   200 -   500     |
| 2    |   500 -  1000     |
| 3    |  1000 -  2000     |
| 4    |  2000 -  4500     |
| 5    |  4500 - 12000     |
| 6    |   200 -  2000     |
| 7    |  2000 - 12000     |
| 8    |   200 - 12000     |
| 9    |   500 -  4500     |
|======|===================|

Note band 6 (soft) and band 7 (hard) are not used in routine processing. Band 9 is 
also referred to as the XID band. 



vi. Energy Conversion Factors
=============================

EPIC energy conversion factors (ECFs) are used to derive simple flux 
estimates from measured count rates. The ECFs are computed using the instrument 
response files (PN version 11.0) for an assumed absorbed power law model with 
Gamma=1.7 and an absorbing column density of 3x10^20/cm2. 

ECFs used in pipeline processing are not computed as functions of
position or epoch but are fixed values, computed for each EPIC
instrument and filter, for each energy band. They are presented in the
table below. For PN they are based on the full-frame, on-axis
position. For MOS they are based on the Full-frame (imaging) mode,
off-patch RMF from epoch 13. Epoch 13 was chosen because the
epoch-dependence contains a step-transition which is not sampled by
any specific epoch.  Rather than compute an average ECF over time,
a single epoch was chosen so as to relate to a specific epoch RMF. The largest 
epoch-dependence is in band 1 and amounts to a range of about 15%. The
off-patch position was chosen to reflect the majority of sources -
RMFs for the core and wings of the MOS 'patch' are only relevant to a
very small number of objects in the field.



|============|========|======================================================================================|
| Instrument | Filter |                                       Band                                           |
|            |        | 1       | 2       | 3       | 4        | 5       | 6      | 7      | 8      |   9    |
|============|========|=========|=========|=========|==========|=========|========|========|========|========|
| epn        | Open   | 16.9783 | 10.0696 | 6.1551  | 1.9844   | 0.5782  | 9.631  | 1.1216 | 4.124  | 5.098  | 
| epn        | Thin   |  9.5248 |  8.121  | 5.867   | 1.9527   | 0.5774  | 7.3868 | 1.1089 | 3.3245 | 4.5586 |
| epn        | Medium |  8.3696 |  7.8681 | 5.7673  | 1.929    | 0.5764  | 7.03   | 1.0992 | 3.1924 | 4.4602 |
| epn        | Thick  |  5.1065 |  6.0479 | 4.9893  | 1.8282   | 0.5698  | 5.4091 | 1.0561 | 2.5929 | 3.7636 |
| emos1      | Open   |  3.0896 |  2.1152 | 2.1387  | 0.7491   | 0.1452  | 2.3661 | 0.3791 | 1.0823 | 1.5035 |
| emos1      | Thin   |  1.7345 |  1.7461 | 2.0407  | 0.7375   | 0.145   | 1.9237 | 0.3745 | 0.9232 | 1.3843 |
| emos1      | Medium |  1.5258 |  1.6974 | 2.0058  | 0.7292   | 0.1451  | 1.8492 | 0.3713 | 0.8949 | 1.3584 |
| emos1      | Thick  |  0.9977 |  1.3792 | 1.7871  | 0.6991   | 0.143   | 1.5293 | 0.3585 | 0.7736 | 1.2035 |
| emos2      | Open   |  3.1094 |  2.1309 | 2.1407  | 0.7531   | 0.1528  | 2.3769 | 0.3853 | 1.0901 | 1.5097 |
| emos2      | Thin   |  1.7336 |  1.7572 | 2.0426  | 0.7418   | 0.1528  | 1.9286 | 0.381  | 0.9292 | 1.3894 |
| emos2      | Medium |  1.5223 |  1.7082 | 2.0079  | 0.7333   | 0.1524  | 1.8536 | 0.3775 | 0.9004 | 1.3634 |
| emos2      | Thick  |  0.9907 |  1.3869 | 1.7887  | 0.703    | 0.1502  | 1.5316 | 0.3644 | 0.7782 | 1.2076 |
|============|========|=========|=========|=========|==========|=========|========|========|========|========|





vii. Source Position Rectification
==================================

In the bulk reprocessing, astrometric field rectification (where possible) is performed against extracts from 
the USNO-B1.0, SDSS-DR9 or 2MASS catalogues as the astrometric reference frame.

2 Data Product Screening Report
-------------------------------

These data were processed as part of the bulk reprocessing of
XMM-Newton observations, performed in December 2012, a subset of which
are used in the 3XMM catalogue. If available from previous processing,
the screening report is attached, but note that due to changes in some
of the processing algorithms, there may well be differences between
the new data and issues raised in the earlier screening reports.

2 Data Product Screening Report
-------------------------------

XMM SSC data-product screening log
Version: 15-Jun-07
 
Revolution  1203
Obs Seq.    0405200201
Target      ISCSJ1438+3414
Seq_id      035429
 
Maximum shift in EPIC attitude:
Pointing difference: 21648.5 arcsec = 5412 pixels
RA: 0.0 arcsec
Dec: 0.0 arcsec
  
Percentage of flaring time:
--
  
EPIC exposures used in the source detection:
-- 
 
 
** GENERAL COMMENTS
 
 
No science data at all
 
EPIC comments refer, in general, to Energy-band 8.
 
 
 
** EPIC MOS1
 
 
Not active
 
 
 
** EPIC MOS2
 
 
Not active
 
 
** EPIC PN
 
 
 
 
 
** epic
 
 
 
 
**  RGS1, RGS2 
 
 
Not active
 
 
** OM
 
 
Not active
 
 
** Catalogue cross-correlation products
 
 
 
 

