XMM-Newton Science Analysis System


emchain (emchain-12.0.1) [xmmsas_20230412_1735-21.0.0]

Parameters

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

Parameter	Mand	Type	Default	Constraints
General parameters
ingtiset	no	string		none
user-supplied good time intervals
filteratt	no	boolean	no	yes/no
filter data on bad attitude
filterhk	no	boolean	no	yes/no
filter data on bad housekeeping
badpixfindalgo	no	string	EM	none
EP for badpixfind, EM for embadpixfind, NO for nothing
randomize	no	string	PET
randomize multiswitch (P for position, E for energy, T for time). ” for no randomisation at all
applyflaregti	no	boolean	no	yes/no
apply the proton flare GTI
Selection parameters
odf	no	string	SAS_ODF	none
input directory name (this is a standard SAS parameter)
exposures	no	list of strings	all	none
selected exposures (like S004, or simply 4 if non ambiguous)
instruments	no	list of strings	both	M1/M2
selected instruments
ccds	no	list of integers	all	1-7
selected CCDs
Parameters for running part of emchain
runccdloop	no	boolean	yes	yes/no
loop over CCDs
startfromodf	no	boolean	yes	yes/no
analyse raw ODF files
stopafterbadpixfind	no	boolean	no	yes/no
stop just after bad pixels detection to investigate
runevlistcomb	no	boolean	yes	yes/no
merge the CCD-specific events files
makeflaregti	no	boolean	yes	yes/no
build GTI for proton flare rejection
Parameters for debugging or calibration
rejectbadevents	no	boolean	yes	yes/no
reject events with any of the flags in rejectionflag set
rejectionflag	no	string	762aa000	none
hexadecimal representation of the flags triggering deletion
writeccdbackground	no	boolean	no	yes/no
save CCD background for offset calibration (one file per CCD)
processlowgain	no	boolean	no	yes/no
process data obtained in low gain read-out mode (as well as normal)
fulloutput	no	boolean	no	yes/no
keep all columns in event list (rather than only the ones in SSC products)
applyccdgti	no	boolean	yes	yes/no
apply the CCD-specific GTI
usecanonicalnames	no	boolean	yes	yes/no
give product-like names (starting with T) to intermediate files
keepintermediate	no	boolean	no	yes/no
keep intermediate files (or remove them on output)
stoponerror	no	boolean	no	yes/no
stop at first error in task call
clobber	no	boolean	yes	yes/no
overwrite existing output files
Parameters for individual tasks
withatthkgen	no	boolean	no	yes/no
rerun atthkgen
atttol	no	real	0.05	$>$ 0
tolerance for attitude filtering (degrees)
withbadpix	no	boolean	yes	yes/no
run badpix
withemevents	no	boolean	yes	yes/no
run emevents
withattcalc	no	boolean	yes	yes/no
run attcalc
withemenergy	no	boolean	yes	yes/no
run emenergy
lowenerbadpix	no	boolean	yes	yes/no
run embadpixfind a second time for energies $<$ 500 eV
addtaglenoise	no	boolean	yes	yes/no
run emtaglenoise
addvigweight	no	boolean	no	yes/no
run evigweight
globalflare	no	boolean	yes	yes/no
build single flare screening timeseries for the whole observation
flaretimebin	no	real	52.0	$>$ 2.6
time bin for flare rejection (s)
flaremaxrate	no	real	2.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.
Parameter	Mand	Type	Default	Constraints