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


emchain (emchain-11.20) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
 
General parameters 
ingtisetnostring none
user-supplied good time intervals
 
filterattnobooleannoyes/no
filter data on bad attitude
 
filterhknobooleannoyes/no
filter data on bad housekeeping
 
badpixfindalgonostringEMnone
EP for badpixfind, EM for embadpixfind, NO for nothing
 
randomizenostringPET 
randomize multiswitch (P for position, E for energy, T for time). ” for no randomisation at all
 
applyflaregtinobooleannoyes/no
apply the proton flare GTI
 
 
Selection parameters 
odfnostringSAS_ODFnone
input directory name (this is a standard SAS parameter)
 
exposuresnolist of stringsallnone
selected exposures (like S004, or simply 4 if non ambiguous)
 
instrumentsnolist of stringsbothM1/M2
selected instruments
 
ccdsnolist of integersall1-7
selected CCDs
 
 
Parameters for running part of emchain 
runccdloopnobooleanyesyes/no
loop over CCDs
 
startfromodfnobooleanyesyes/no
analyse raw ODF files
 
stopafterbadpixfindnobooleannoyes/no
stop just after bad pixels detection to investigate
 
runevlistcombnobooleanyesyes/no
merge the CCD-specific events files
 
makeflaregtinobooleanyesyes/no
build GTI for proton flare rejection
 
 
Parameters for debugging or calibration 
rejectbadeventsnobooleanyesyes/no
reject events with any of the flags in rejectionflag set
 
rejectionflagnostring762aa000none
hexadecimal representation of the flags triggering deletion
 
writeccdbackgroundnobooleannoyes/no
save CCD background for offset calibration (one file per CCD)
 
processlowgainnobooleannoyes/no
process data obtained in low gain read-out mode (as well as normal)
 
fulloutputnobooleannoyes/no
keep all columns in event list (rather than only the ones in SSC products)
 
applyccdgtinobooleanyesyes/no
apply the CCD-specific GTI
 
keepintermediatenobooleannoyes/no
keep intermediate files (or remove them on output)
 
stoponerrornobooleannoyes/no
stop at first error in task call
 
clobbernobooleanyesyes/no
overwrite existing output files
 
 
Parameters for individual tasks 
withatthkgennobooleannoyes/no
rerun atthkgen
 
atttolnoreal0.05$>$ 0
tolerance for attitude filtering (degrees)
 
withbadpixnobooleanyesyes/no
run badpix
 
withemeventsnobooleanyesyes/no
run emevents
 
withattcalcnobooleanyesyes/no
run attcalc
 
withemenergynobooleanyesyes/no
run emenergy
 
lowenerbadpixnobooleanyesyes/no
run embadpixfind a second time for energies $<$ 500 eV
 
addtaglenoisenobooleanyesyes/no
run emtaglenoise
 
addvigweightnobooleannoyes/no
run evigweight
 
globalflarenobooleanyesyes/no
build single flare screening timeseries for the whole observation
 
flaretimebinnoreal52.0$>$ 2.6
time bin for flare rejection (s)
 
flaremaxratenoreal2.0$>$ 0
threshold on rate of truncated singles for tabgtigen (cts/ks/arcmin$^2$)
 
 
The syntax taskname:parametername=soandso may be used to pass parameters to individual tasks called by emchain. See Sect. 3.5 for details. 
 
Standard SAS parameters 
 
Because emchain is a standalone Perl script, it does not deal with the standard SAS parameters (see taskmain) in exactly the same way as normal SAS tasks do:
  • It does not support the '-d' (dialog) option. Actually emchain may not be called at all via the SAS GUI.
  • It does not support the '-c' (noclobber) option because some constituent tasks do not work with that option set. That option is replaced by the clobber parameter specific to emchain.
  • It emulates the '-h' (help), '-m' (manpage), '-p' (param), '-v' (version) parameters giving information on emchain itself.
  • It passes all other standard SAS parameters to its constituent tasks. Specific OAL ('-o') and CAL ('-a','-f','-i') options are passed only to the tasks making use of the OAL or CAL, respectively. By default constituent tasks are called with '-w 10' (at most 10 warnings per task).
  • All syntaxes (e.g. '-o your_odf_dir', 'odf=your_odf_dir', '-–odf your_odf_dir') are supported.
Some SAS options are also interpreted at emchain level before being passed to its constituent tasks:
  • '-V' (verbosity) is used in the same way as the SAS_VERBOSITY environment variable (see Sect. 3.1).
  • '-o' (odf) is used to define the directory where the data resides in the same way as the SAS_ODF environment variable (see Sect. 3.1).
  • '-i' (ccf) is used in the same way as the SAS_CCF environment variable to append a CALINDEX extension to the output file.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30