The SAS package xmmextractor
can be used to process data from EPIC
MOS and PN, RGS and OM instruments, starting at the ODF level. xmmextractor
only needs the environmental SAS_ODF pointing to the location of the ODF data to run.
has only one input parameter paramfile, this parameter is an
XML file produce by odfParamCreator
task, for more information about the XML structure
and content, please read the odfParamCreator
and the end of this chapter we have added the explanation of the XML tag analisisoption for completion.
If the user leaves this parameter empty, the xmmextractor
task runs automatically the odfParamCreator
generating the XML file.
Firt of all, xmmextractor runs cifbuild and odfingest, setting the corresponding environmental variables SAS_CCF and SAS_ODF to the right values. xmmextractor comprises calls to several metatasks, epproc, emproc, rgsproc, omichain, thus performing the whole data reduction corresponding to any combination of chosen data within an observation with the final products of all those metatasks. In addition it allows the user to perform in a semi-automatic way the usual analysis corresponding to a point source by the EPIC data, starting from the source coordinates, and including source extraction radius, background region, and eventual measures to avoid pile-up. Interactivity for optimization of all these parameters can be enabled, which allows the user to select a source and a background regions. For GTI filtering, there are two alternative ways for optimization, the default choice is the use of eregionanalyse, which is applied also automatically in the non interactive case. The alternative to it is an optimization based on maximization of the signal to noise ("MaxSNR") described in the Appendix A of [Pic2004]. In this case the user has to define graphically source and background regions. The final products are spectra with corresponding response matrices and exposure corrected light curves. General source detection can be also enabled for the EPIC data, including control of the main parameters corresponding to edetect_chain. If processing of RGS data is enabled, the whole of rgsproc runs up with eventually defined source coordinates, otherwise the proposal coordinates will be used. For OM analysis, the dedicated chain omichain is ran.
For EPIC spectral and light curve analysis, the standard filtering is applied to the calibrated event list. For PN analysis, the following filter parameters are applied: PATTERN 4, FLAG == 0 and #XMMEA_EP. For MOS analysis, the following filter parameters are applied: PATTERN 12 (Imaging) and PATTERN == 0 (Timing) , FLAG == 0 and #XMMEA_EM.
xmmextractor creates the following directory structure:
\[workingDirectory] \pn:: epproc products \mos:: emproc products \rgs:: rgsproc and rgslccorr products \om:: omchain products \gti:: GTI filtering products \epatplot:: epatplot products \images:: edetectchain products \spectra:: eregionanalyse and especget products \lcurve:: epiclccorr products \results:: output log files
One of the most important parameter in the XML file is: analisisoption. There are 6 different analysis options:
xmmextractor produces as output a new XML file with the same structure as the input parameter file but with additional information gathered during the execution of the task. This new information is mainly the expressions used for spectral and light curve production. The output parameter file can be used as input to the xmmextractor task.
XMM-Newton SOC -- 2021-11-30