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


eboxdetect (eboxdetect-4.28.4) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
imagesetsyesfilenameimage.fits 
Names of EPIC fits images$^{1,2}$
 
boxlistsetyesfilenameeboxlist.fits 
Name of output source list
 
bkgimagesetsnofilenamebkgimage.fits 
Names of spline background maps$^{1,2}$ (task esplinemap)
 
expimagesetsnofilenameexpimage.fits 
Names of exposure images$^{1,2}$ (task eexpmap)
 
detmasksetsnofilenamedetmask.fits 
Name of detection mask$^3$ (task emask)
 
mergedlistsetnofilenamemergedlist.fits 
Name of merged source list (not yet implemented)
 
usemapnobooleanfalse 
true: map mode; false: local mode
 
usematchedfilternobooleanfalse 
Matched filter flag; not supported in current version
 
withdetmasknobooleanfalse 
Detection mask flag
 
withexpimagenobooleanfalse 
Exposure image flag
 
withoffsetsnobooleanfalse 
Controls whether the offsets will be read from the merged (eident) source list – obsolete.
 
boxsizenointeger53 or 5
Size of detection box (3x3 or 5x5 pixels)
 
nrunsnointeger31$\leq$param$\leq$4
Number of detection runs (detection box size is doubled after each run)
 
likeminnofloat10.0[1.0$<$param$<$50.0]
Minimum detection likelihood
 
ecfnofloat1.0[0.0$<$param$<$1000]
Energy conversion factors, given in units of $10^{-11}$ counts cm$^2$ erg$^{-1}$
 
hrdefnointeger1 2 2 3 3 40,10
Array of six integer numbers specifying the upper and lower energy band for each of (up to) three hardness ratios
 
piminnointeger2000[1$<$param$<$30000]
Lower PI channel limits of input images$^{2}$ in eV. Up to six different energy bands are allowed per instrument.
 
pimaxnointeger4500[1$<$param$<$30000]
Upper PI channel limits of input images$^{2}$ in eV. Up to six different energy bands are allowed per instrument.
 
imagebuffersizenointeger640100$<$param$<$10000
Parameter that controls memory requirements for mosaic images (cf. emldetect description).
 
withimagebuffersizenobooleanno 
Allow user-defined values of imagebuffersize.
 
obsmodenostringnopointing|slew
Observation mode of input data: pointing (default) or slew. Parameter introduced with task version 4.24 (2015).
 
ParameterMand Type Default Constraints

$^1$ File names must be ordered by instrument and energy band; maximum of six energy bands per instrument.
$^2$ One per energy band per instrument.
$^3$ One per instrument.

XMM-Newton SOC -- 2021-11-30