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


epframes (epframes-8.116) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
 
General parameters 
setyesdata-setodfset
input EPIC PN ODF (actual or symbolic) data-set name
 
eventsetyesdata-setrawevents.dat
output EPIC PN raw events data-set
 
gtisetyesdata-setgti.dat
output GTI data-set name
 
withsrccoordsnobooleanNY,N
whether to use user-supplied values for RA and DEC for TIMING and BURST modes, default is N. If withsrccoords=Y then withsrcrawy and srcposition are ignored. If both withsrccoords=N and withsrcrawy=N then the RA_OBJ and DEC_OBJ from the ProposalInfo are used as input position.
Warning: For an offset pointing (there may be scientific reasons for this) the values RA_OBJ and DEC_OBJ do not represent the desired source position but just the pointing position, you have to set withsrccoords=Y for this case and supply the proper source coordinates via srcra and srcdec or to provide the pixel position via withsrcrawy=Y and srcposition, otherwise the absolute timing and the energy corrections will be incorrect. There is no other way to handle this offset case, you have been warned. This is irrelevant for all IMAGING modes.
 
srcranoangle0.00 .. 360
source right ascension (J2000) for withsrccoords=Y
 
srcdecnoangle0.0-90 .. +90
source right ascension (J2000) for withsrccoords=Y
 
withsrcrawynobooleanNY,N
whether to use user-supplied value for source RAWY position for TIMING and BURST modes, default is N, if both withsrccoords=N and withsrcrawy=N then the RA_OBJ and DEC_OBJ from the ProposalInfo are used. See the warning at withsrccoords!
 
srcpositionnointeger1901-200; 181-200 should be used for BURST mode
source position for TIMING and BURST mode (in RAWY pixel coordinates)
 
withfinetimenobooleanYY,N
whether to apply fine time correction for TIMING and BURST modes by using source RAWY position, default is Y
 
lowerthresholdnointeger 0-4095
disregard low-energy events (with amplitudes $<$ lowerthreshold [adu]) already at this stage, default lowerthreshold=0 (or 20) preserves recommended (old) behaviour. This may be useful when comparing early mission data with recent observations as the setup was different (lowerthreshold=23 instead of 20 now)
 
guessdeltapnobooleanNY,N
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).
 
withfifogtinobooleanNY,N
whether to search for short duration FIFO overflow data gaps (in preparation)
 
fifogtithreshnoreal76.00-4095
threshold for FIFI GTI search (in preparation)
 
witheventmapnobooleanNY,N
Create several event CCD maps ? These may be useful as they visualize the raw data without any corrections.
 
eventmapsetnodata-seteventmap.dat
Name of output event CCD map fileoutput GTI data-set name
 
nomipthresholdlownointeger400-4095
minimum PHA value for non-MIP events to be included in NOMIPMAP, cf. witheventmap
 
nomipthresholdhighnointeger16000-4095
maximum PHA value for non-MIP events to be included in NOMIPMAP, cf. witheventmap
 
softthresholdlownointeger200-4095
minimum PHA value for non-MIP events to be included in SOFTMAP, cf. witheventmap
 
softthresholdhighnointeger300-4095
maximum PHA value for non-MIP events to be included in SOFTMAP, cf. witheventmap
 
 
Diagnostic and debug parameters 
wrongpixlimitnointeger100-100
allowed percentage of wrong events before stopping to send detailed messages
 
showccxnobooleanNY,N
whether to internally increase the verbosity for CCX related information
 
showauxnobooleanNY,N
whether to internally increase the verbosity for AUX related information
 
showpmhnobooleanNY,N
whether to internally increase the verbosity for PMH related information
 
showpahnobooleanNY,N
whether to internally increase the verbosity for PAH related information
 
showvenobooleanNY,N
whether to internally increase the verbosity for subroutine ValidEvents related information, optimization critical
 
 
MIP rejection (commissioning phase) 
mipthresholdnointeger30000-4095
maximum PHA value for non-MIP events (mainly for commissioning phase and calibration)
 
mipmethodnostringonboardnone onboard sas com
method to flag MIPs in raw data: none = flag only events but not discarded column, sas = flag events and discarded column, com = flag events and discarded column and neighbouring column, onboard = similar to `com' but without full frames rejection (mainly for commissioning phase and calibration)
 
mipdiscardnobooleanYY,N
whether to discard flagged MIP events from the output list (for check of fast instrument modes or in case of no onboard rejection, not active yet)
 
qualmaxnointeger 0-2100000000
maximum value of quality flag to include event in output list (mainly for commissioning phase and calibration). This parameter will be removed, use mipdiscard then.
 
mipdistnobooleanNY,N
whether to create columns MIPDISTR and MIPDISTL in EVENTS extension and histogram extension MIPDHIST (mainly for commissioning phase and calibration)
 
 
PMSFITS parameters (not relevant for GO phase) 
f1294nointeger 0-15
Quadrant wait states [F1294], defines the length of the Extended Full Frame Mode frame time, typical values are 0 (for all modes except eFF), 3, or 5 (will be removed once complete PAH and PMH files in ODF available)
 
f1052nointeger324000-32767
HK value of DTIMAUTRSTPREVAL [F1052], (will be removed once complete PAH and PMH files in ODF available)
 
f1118nostringUNKNOWNUNKNOWN Closed Thin1 Thin2 Medium Thick Open CalClosed CalThin1 CalThin2 CalMedium CalThick CalOpen
HK value of filter wheel [F1118], (will be removed once complete PAH and PMH files in ODF available)
 
anchopnointeger 0-255
An_CHOP [F1534 F1634 F1734 F1834], (will be removed once complete PAH and PMH files in ODF available)
 
ancmlothnointeger5320-4095
An_CMLOTH [F1515 F1516 F1517 F1615 F1616 F1617 F1715 F1716 F1717 F1815 F1816 F1817], (will be removed once complete PAH and PMH files in ODF available)
 
ancmcorrnointeger5120-4095
An_CMCORR [F1525 F1625 F1725 F1825], (will be removed once complete PAH and PMH files in ODF available)
 
aneamipselnointeger10-63
An_EAMIPSEL [F1536 F1636 F1736 F1836], (will be removed once complete PAH and PMH files in ODF available)
 
anmaxmipnointeger630-4095
An_MAXMIP [F1527 F1627 F1727 F1827], (will be removed once complete PAH and PMH files in ODF available)
 
anmipnointeger35120-4095
An_MIP [F1526 F1626 F1726 F1826], (will be removed once complete PAH and PMH files in ODF available)
 
anmaxfrcnointeger200-63
An_MAXFRC [F1538 F1638 F1738 F1838], (will be removed once complete PAH and PMH files in ODF available)
 
ansendmodenostringMIP CORREC.2“NO MIP CORR.” “MIP CORREC.1” “MIP CORREC.2”
An_SENDMODE [F1535 F1635 F1735 F1835], (will be removed once complete PAH and PMH files in ODF available)
 
ecntempqb1noreal-9999.9 
quadrant box temperature [$^\circ$C]: E_Cn_TEMPQB1 [F1576 F1676 F1776 F1876], (will be removed once complete PAH and PMH files in ODF available)
 
hcettmpfpfnoreal-90 
CCD fine temperature [$^\circ$C]: H_CE_TTMPFPFE [F1128], only active in absence of real PMH files (will be removed once complete PAH and PMH files in ODF available)
 
automodenobooleanNY,N
try to determine mode from the data itself
 
autofilternobooleanNY,N
try to determine filter from the HK files itself
 
odfoknobooleanYY,N
Is ODF/SDF correct/nominal (yes/no) (for PMSFITS data setting “N" prevents some warnings)
 
hkoknobooleanYY,N
Is PMH/PAH correct/nominal (yes/no) (for PMSFITS data setting “N" prevents some warnings)
 
ccfoknobooleanYY,N
Is CAL/CCF correct/nominal (yes/no) (for commissioning phase setting “N" enables hard-coded offset shifts as there are no correct CCFs yet for this period; setupbpx must (!) then be correctly set)
 
setupbpxnostringnom3none nom0 nom1 nom2 nom3 nom4 cal4 nom5 nom6
setup for badpix/offset correction vector, activated by ccfok=N (will be removed once complete PAH and PMH and CCF files in ODF available)
 
 
Data check parameters 
withallobtgtinobooleanYY,N
whether to use also frames for the GTI file after the first occurence of the warning “invalidObtValue”. If set to “N” then all events after that time will be lost for this CCD. Has no effect if the warning does not occur.
 
withinvalidobtnobooleanYY,N
whether to use also frames as input to OAL routine that lead to warning “invalidObtValue”. This is for data checks only and should not be changed for processing.
 
 
EPIC Radiation Monitor file(s) 
withradmonnobooleanNY,N
whether to access the EPIC Radiation Monitor file(s).
 
radmonsetnoradmon.datdata-setinput RadMon data-set name
 
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30