XMM-Newton SAS Home Page
XMM-Newton Science Analysis System


epevents (epevents-6.42) [xmmsas_20060628_1801-7.0.0]

Examples Home Page Errors Home Index

Meta Index / Home Page

Parameters

This section documents the parameters recognized by this task (if any).

ParameterMand Type Default Constraints
eventsetyesdata-set  
EPIC PN raw events data-set
 
outsetyesdata-setevents.dat 
EPIC PN events data-set with calibrated and corrected PI channels
 
reemissionthreshnointeger none
selection parameter: trigger threshold (in adu) for preceding events
 
randomizepositionnobooleanYY/N
yes, if the computation of physical camera detector coordinates is done with randomization (former parameter `randomize')
 
randomizeenergynobooleanYY/N
yes, if the raw amplitudes should be randomized within a pulse-height bin
 
testenergywidthnobooleanNY/N
yes, if use non-standard energy bin width, this will yield incorrect scientific results and should only be used for calibration tests, no support
 
gainctiaccuracynointeger20-2
Accuracy of gain/cti correction
 
withphagaincolumnnobooleanNY/N
Whether to create intermediate column PHA_GAIN.
 
lowgainenergyscalenobooleanNY/N
When switching on the energy correction for low-gain mode data then most of the events will fall outside the 2-byte-limit for the PI column (i.e. $> 32757$eV) as the energy range is then about $2-280$keV; if one is interested in this full range the setting ``N" should be used and energy values be multiplied later with 18.4 to obtain ``real" event energies. Only effective for the few low-gain mode exposures, of course.
 
patternanalysisnobooleanYY/N
no, if pattern recognition has been done already (future development, not active yet)
 
withphotonmapnobooleanNY/N
yes, if diagnostic photon map file should be created (see parameter photonmapset)
 
photonmapsetnodata-setphotonmap.dat 
name of optional output diagnostic photon map file, it will have 4 extensions corresponding to 4 user-definable energy bands (see lothresh and hithresh)
 
lothreshnoreal-list0 200 500 0 
lower band limits [eV] for parameter photonmapset
 
hithreshnoreal-list200 500 2000 32000 
upper band limits [eV] for parameter photonmapset
 
mappatterntypenostringsssn 
pattern types for the events of the individual band maps (future development, not fully active yet), s = singles, d = doubles, t = triples, q = quadruples, n = non-singles, r = recognized, u = unrecognized, m = multiples (m = d+t+q), a = all, x = doubles in x-direction, y = doubles in y-direction, v = doubles in y-direction with main near CAMEX (i.e. split backward), w = doubles in y-direction with main away from CAMEX (i.e. split forward)
 
withoutoftimenobooleanNY/N
yes, if ``out-of-time events'' file should be created instead of ``normal events'' file (only meaningful for IMAGING modes) (considered as experimental)
 
withctisrcposnobooleanNY/N
yes, if not the RAWY coordinates but the source position SRCPOS should be used in the energry correction routines (only meaningful for IMAGING modes) (considered as experimental). See Sect.3.2.
 
withctilongtermnobooleanYY/N
yes, if corrections for long-term CTI increase should be applied
 
ctilongtermsoftnobooleanNY/N
yes, if special soft energy function should be included in the long-term CTI corrections (considered as experimental)
 
ctilongtermynobooleanYY/N
yes, if special Y-dependence should be included in the long-term CTI corrections
 
withccdoffsetsnobooleanNY/N
yes, if CCD offset corrections should be applied (considered as experimental)
 
withtempcorrectionnobooleanNY/N
yes, if temperature-gain corrections should be applied (considered as experimental)
 
withframectinobooleanNY/N
yes, if TIME-derived frame numbers should be used in CTI correction for non-imaging modes (TI, BU) instead of the ODF frame numbers. For FF, eFF, LW, SW modes internally always the TIME-derived frame numbers instead of the dummy ODF numbers are used (should not be changed).
 
withgainburstnobooleanYY/N
apply special gain if BURST mode ?
 
withgaintimingnobooleanYY/N
apply special gain if TIMING mode ?
 
withgainffnobooleanNY/N
apply special gain if FULL FRAME mode ?
 
withgaineffnobooleanYY/N
apply special gain if EXTENDED FULL FRAME mode ?
 
ParameterMand Type Default Constraints


Examples Home Page Errors Home Index

XMM-Newton SOC/SSC -- 2006-06-28