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

epproc (epicproc-2.25.3) [xmmsas_20230412_1735-21.0.0]


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

ParameterMand Type Default Constraints
removetemporariesnobtrueyes $\vert$ no
Remove temporary data sets?
removeintermediategtisnobtrueyes $\vert$ no
Remove intermediate GTI data sets?
removeintermediateeventlistsnobtrueyes $\vert$ no
Remove the intermediate CCD/node-based event lists?
whether mode-dependent calibration-related settings should be used automatically, this will use for:
BURST: withrdpha=“N”, withxrlcorrection=“Y”, runepreject=“Y”, runepfast=“Y”
TIMING: withrdpha=“Y”, withxrlcorrection=“Y”, runepreject=“Y”, runepfast=“N”
IMAGING: withrdpha=“N”, withxrlcorrection=“N”, runepreject as user-supplied, runepfast=“N”
selectccdsnobfalseyes $\vert$ no
Select the CCDs to process? false = process all CCDs.
ccd1nobfalseyes $\vert$ no
Process data for CCD 1?
ccd2nobfalseyes $\vert$ no
Process data for CCD 2?
ccd3nobfalseyes $\vert$ no
Process data for CCD 3?
ccd4nobfalseyes $\vert$ no
Process data for CCD 4?
ccd5nobfalseyes $\vert$ no
Process data for CCD 5?
ccd6nobfalseyes $\vert$ no
Process data for CCD 6?
ccd7nobfalseyes $\vert$ no
Process data for CCD 7?
ccd8nobfalseyes $\vert$ no
Process data for CCD 8?
ccd9nobfalseyes $\vert$ no
Process data for CCD 9?
ccd10nobfalseyes $\vert$ no
Process data for CCD 10?
ccd11nobfalseyes $\vert$ no
Process data for CCD 11?
ccd12nobfalseyes $\vert$ no
Process data for CCD 12?
selectmodesnobtrueyes $\vert$ no
Select the modes to process? false = process only imaging.
imagingnobtrueyes $\vert$ no
Process imaging mode exposure?
timingnobtrueyes $\vert$ no
Process timing mode exposures?
burstnobfalseyes $\vert$ no
process burst mode exposures?
timingsrcpositionnoi190$\ge$ 1 – $\le$ 200
Source position for TIMING and BURST modes in RAWY pixel coordinates. [Used in epframes.]
withinstexpidsnobfalseyes $\vert$ no
Select exposures to process?
List of exposures (ie, PNU002)
withgtisetnobfalseyes $\vert$ no
Use an external GTI dataset to be used when filtering the data?
Name of the external GTI dataset to be used when filtering the data.
runhkgtigennobfalseyes $\vert$ no
Generate a GTI dataset based on housekeeping?
runatthkgennobtrueyes $\vert$ no
Pre-process attitude data through atthkgen?
Coordinates of the reference poiting used for the calculation of the sky coordinates
ranou0.0$\ge$ 0.0 – $\le$ 360.0
User-specified right ascension of s/c attitude (deg)
decnou0.0$\ge$ -90.0 – $\le$ 90.0
User-specified declination of s/c attitude (deg)
posanglenou0.0$\ge$ -180.0 – $\le$ 180.0
User-specified astronomical position angle of s/c attitude (deg)
filtereventsnobtrueyes $\vert$ no
Filter the event lists?
Bad events selection expression.
flagfilteredeventsnobfalseyes $\vert$ no
Flag the events that match the filter expression instead of removing them?
rungtimergenobnoyes $\vert$ no
Merge GTIs from each CCD
applygtinobtrueyes $\vert$ no
Apply GTI filter to the event lists?
runevlistcombnobtrueyes $\vert$ no
Merge CCD-level event lists into exposure-level event lists (by mode)?
othertablesnolist of uppercase stringsBADPIX EXPOSURE STDGTI DLIMAP HKAUX:q!none
names of secondary tables or arrays to propagate
deleteexposurecolumnsnobtrueyes $\vert$ no
searchforbadpixelsnobyesyes $\vert$ no
Search for bad pixels?
searchforbadcolumnsnobyesyes $\vert$ no
Look for bad columns?
Thresholds choice - as percentage of PEAK, as count RATE or pure COUNTS [!badpixfind]
lothreshnor0.0$\ge$ 0.0
Low threshold to search for dead pixels [badpixfind]
hithreshnor0.0045$\ge$ 0.0
High threshold to search for hot pixels [!badpixfind]
Columnsearch thresholds choice - refer to TOTAL column value or MEDIAN column value [badpixfind]
locolthreshnor0.0$\ge$ 0.0
Low threshold to search for dead columns [badpixfind]
hicolthreshnor0.00105$\ge$ 0.0
High threshold to search for hot columns [!badpixfind]
flickertimestepsnoi1$\ge$ 1
Number of timesteps to search for flickering pixels [badpixfind]
flickerksthreshnor0.55$\ge$ 0 – $\le$ 1
K-S threshold for low count flickering pixels [badpixfind]
flickerchisqthreshnor15.0$\ge$ 0
Reduced Chi-sq threshold for high count flickering pixels [badpixfind]
Background rate (ct/s/pix) - if negative, mean over entire field assumed [!badpixfind]
narrowerthanpsfnor1.5$\ge$ 0.0
PSF-pixel(s) comparison - 1:equal to PSF, >1:more compact [!badpixfind]
threshabovebackgroundnobnoyes $\vert$ no
High thresholds as values above background [badpixfind]
loenergythreshnor0.14$\ge$ 0 – $\le$ 30.0
Low energy threshold for searching (keV) [!badpixfind]
hienergythreshnor10$\ge$ 0 – $\le$ 30.0
Hi energy threshold for searching (keV) [!badpixfind]
randomizepositionnobyesyes $\vert$ no
Randomize DETX/DETY within one CCD pixel [epevents]
randomizeenergynobyesyes $\vert$ no
Randomize PHA within one ADU bin [epevents]
testenergywidthnobyesyes $\vert$ no
Use an energy width of 1eV [epevents]
gainctiaccuracynoi2$\ge$ 0 – $\le$ 2
Accuracy of gain/cti correction [epevents]
reemissionthreshnoi none
Re-emission trigger threshold [epevents]
withoutoftimenobnoyes $\vert$ no
Perform out-of-time events analysis instead (Y/N) [epevents]
pattern types of the bands for photon maps [!epevents]
no, if pattern recognition has been done already (future development)[!epevents]
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). [!epevents]
epevents: yes, if pattern energy offset corrections should be applied
epevents: yes, if background gain corrections should be applied
epevents: special soft energy function
yes, if a correction for rate-dependent PHA effects for TI and BU modes should be applied. The logical keyword PHA_RDCO indicates whether this correction has been applied or not. If applied, then the keyword PHA_RDCB gives the scaling factor B used in the correction, derived from block RDPHA_DERIV in the CTI.CCF. [!epevents]
time-bin size for rate-dependent PHA correction for TI and BU modes [s] [!epevents]
epevents: yes, if the MIP rejection information obtained by task epframes shall be printed (only meaningful if on-board rejection is switched off, i.e. for SW, TI, BU modes).[!epevents]
epevents: yes, if averaged discarded line value (rather than time resolved) shall be used for background gain corrections
epevents: time bin for averaging time-resolved background level data
wrongpixlimitnoi20$\ge$ 0 – $\le$ 100
Allowed percentage of wrong pixels without producing a warning [!epframes]
withsrccoordsnobnoyes $\vert$ no
Use user-supplied RA,DEC coordinates for TIMING and BURST mode ? [epframes]
srcranou0.0$\ge$ 0.0 – $\le$ 360.0
User-supplied source position RA [deg] [epframes]
srcdecnou0.0$\ge$ -90.0 – $\le$ 90.0
User-supplied source position DEC [deg] [epframes]
mipthresholdnoi3000$\ge$ 0 – $\le$ 4095
maximum PHA for non-MIPs [epframes]
method to reject MIPs [epframes]
mipdistnobnoyes $\vert$ no
Create MIPDIST columns and MIPHIST extension in output (yes/no) ? [epframes]
mipdiscardnobyesyes $\vert$ no
discard MIPs from event list (yes/no) ? [epframes]
setupbpxnostringnom6cal4/nom0/nom1/ nom2/nom3/nom4/ nom5/nom6/none
setup for badpix/offset correction vector (used only if ccfok=N) [epframes]
disregard low-energy events (with amplitudes $<$ lowerthreshold [adu]) already at this stage, default lowerthreshold=0 preserves recommended (old) behavior. This may be useful when comparing early mission data with recent observations as the setup was different (lowertreshold=23 instead of 20 now)[epframes]
whether to estimate the shift of the PN oscillator frequency due to temperature and ageing effects from HK data, could be used to estimate SAS_JUMP_TOLERANCE (divide by 6).[epframes]
withparametersnobfalseyes $\vert$ no
Specify explicit list of HK parameters? [hkgtigen]
List of HK parameters to consider [hkgtigen]
exceptnobfalseyes $\vert$ no
Consider all parameters except those specified [hkgtigen]
withoverrideparametersnobfalseyes $\vert$ no
Specify list of additional parameters? [hkgtigen]
List of override/additional parameters [hkgtigen]
runepnoisenobnoyes $\vert$ no
Run epnoise task
Sigma cut for bright sources
Noise cut (maximum allowed number of soft events in frame)
Save CCDs mask to a file
runeprejectnobnoyes $\vert$ no
Run epreject task.
Name of optional ascii file containing pairs of <ccd nr.> <bad column nr.> (one per line), to be omitted from the offset correction [epreject]
Sigma threshold for offset correction [epreject]
enables noise flagging scheme [epreject]
noiseparametersnoreal0.98 12 $\times$ 1.0 
Noise fraction parameters (cutoff parameter and 12 chip specific correction factors; only for expert use) [epreject]
enables use of offset map to calculate energy shifts [epreject]
turns on X-ray loading correction code for TI+BU modes, only meaningful if offset maps are availbale in the ODF and use of offset map is not switched off. [epreject]
enables soft flare screening (TI mode) [epreject]
threshold for flare screening in units of counts/0.1 s [epreject]
threshold for flare screening [epreject]
smoothing method for flare screening [epreject]
softflareenergyrangenolist of int40 50 
energy range for flare screening (in ADU units) [epreject]
softflaresmoothparamsnolist of real2 1 1 
smoothing parameters [epreject]
runepexposurenobyesyes $\vert$ no
Run epreject task
runepxrlcorrnobnoyes $\vert$ no
Run epxrlcorr task
runepfastnobnoyes $\vert$ no
Run epfast task
Set up the configuration to analyze SciSim data with epproc
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2023-04-16