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


esplinemap (esplinemap-5.4.1) [xmmsas_20230412_1735-21.0.0]

Parameters

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

ParameterMand Type Default Constraints
boxlistsetyesfilenameeboxlist.fits 
Name of eboxdetect source list
 
imagesetyesfilenameimage.fits 
Names of input EPIC fits images
 
bkgimagesetyesfilenamebkgimage.fits 
Name of output spline background map
 
fitmethodnostringsplinespline|model|smooth
Fitting method: spline fit, 2-component background model, or adaptive smoothing.
 
expimagesetnofilenameexpimage.fits 
Name of input exposure map
 
expimageset2nofilenameexpimage.fits 
Name of second input exposure map for option “fitmethod=model”
 
detmasksetnofilenamedetmask.fits 
Name of input detection mask
 
scutnofloat0.01[0.0 $\le param \le$ 10.0]
Source cut-out flux level; [counts/arcsec$^2$]
 
idbandnointeger1[0 $\le param \le$ 9]
Band id from eboxdetect source list
 
mlminnofloat1.0[0.0 $\le param \le$ 50.0]
Minimum single band detection likelihood for sources to be cut out
 
nsplinenodesnointeger16[10 $\le param \le$ 20]
Number of spline nodes
 
excesssigmanofloat4.0[1.0 $\le param \le$ 6.0]
Threshold for excesses sigmas with respect to background spline fit
 
nfitrunnointeger3[1 $\le param \le$ 5]
Number of iterations for removal of excesses, nfitrun=1 means no removal
 
withdetmasknobooleantrue 
Flag to use detection mask
 
withexpimagenobooleantrue 
Flag to use exposure map
 
withexpimage2nobooleantrue 
Flag to use second exposure map for option “fitmethod=model”
 
snrminnofloat30.0[1.0 $\le param \le$ 1000.0]
Desired minimum signal to noise ratio during adaptive smoothing
 
smoothsigmanofloat6.0[0.0 $\le param \le$ 100.0]
Minimum width of Gaussian smoothing kernel
 
withcheesenobooleanfalse 
Controls optional output of photon image where sources have been masked out and, if withootset=true for EPIC/pn, the modelled out-of-time events have been subtracted (so called cheesed image)
 
cheeseimagesetnofilenamecheese.fits 
Name of diagnostic output cheesed image.
 
withcheesemasknobooleanfalse 
Controls optional output of mask image, value=0 for masked areas, value=1 for valid image areas
 
cheesemasksetnofilenamecheesemask.fits 
Name of diagnostic output cheese mask image.
 
withootsetnobooleanfalse 
Flag to use event table to calculate background due to out-of-time events.
 
ooteventsetnofilenameevents.fits 
Name of photon event table used for background due to out-time-events
 
piminnointeger1[1$<$param$<$30000]
Lower PI channel limits of input images.
 
pimaxnointeger30000[1$<$param$<$30000]
Upper PI channel limits of input images.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2023-04-16