XMM-Newton Science Analysis System


emldetect (emldetect-6.0.4) [xmmsas_20160201_1833-15.0.0]

Meta Index / Home Page

Parameters

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

Parameter	Mand	Type	Default	Constraints
imagesets	yes	filename list	image.fits
Names of input EPIC fits images$^{1,2}$ or event lists$^3$ (if useevents = true; event-list mode not yet implemented)
boxlistset	yes	filename	eboxlist.fits
Name of input eboxdetect source list
mllistset	yes	filename	emllist.fits
Name of output emldetect source list
withexpimage	no	boolean	true
Use exposure maps
expimagesets	no	filename list	expimage.fits
Names of exposure maps$^{1,2}$
withdetmask	no	boolean	false
If true, only sky pixels inside the detection mask will be used in the PSF fits.
detmasksets	no	filename list	detmask.fits
Names of detection masks$^{3}$
bkgimagesets	yes	filename list	bkgimage.fits
Names of background images$^{1,2}$
withsourcemap	no	boolean	false
Controls whether source maps (one per input image) will be written
sourceimagesets	no	filename list	srcmap.fits
Names of source maps$^{3}$ (one per input image)
mergedlistset	no	filename	mergedlist.fits
Name of merged source list - obsolete
mlmin	no	float	10.0	[1.0$<$param$<$50.0]
Minimum detection likelihood for including a source in the output list
dmlextmin	no	float	10.0	[1.0$<$param$<$100.0]
Required likelihood improvement for source extent
scut	no	float	0.9	[0.4$<$param$<$100.0]
Source selection radius for multi-source fitting (expressed as fraction of the normalized PSF integrated to the desired radius).$^4$ Values larger than 1.0 are interpreted as a fixed radius given in units of image pixels.
ecut	no	float	0.68	[0.4$<$param$<$100.0]
Source cut-out radius for PSF-fitting (expressed as fraction of the normalized PSF integrated to the desired cut-out radius).$^4$ Values larger than 1.0 are interpreted as a fixed event cut-out radius given in units of image pixels.
ecf	no	float	1.0	[0.001$<$param$<$1000]
Energy conversion factors, given in units of $10^{11}$ counts cm$^2$/erg $^{1,2}$
xidecf	no	float	1.0	[0.001$<$param$<$1000]
XID-band energy conversion factors, given in units of $10^{11}$ counts cm$^2$/erg $^3$
useevents	no	boolean	false
Photon mode flag (mode not yet implemented)
fitposition	no	boolean	true
Fit source positions
fitextent	no	boolean	false
Fit source extent
fitcounts	no	boolean	true
Fit source counts (not yet implemented)
fitnegative	no	boolean	false
Allow fitted count rates to become negative
determineerrors	no	boolean	true
Determine statistical errors
withoffsets	no	boolean	false
Flag for reading offsets from eident source list - obsolete
withxidband	no	boolean	false
Controls whether XID band output will be written
usecalpsf	no	boolean	true
Read PSF from the calibration database. This parameter is obsolete and has no effect anymore.
extentmodel	no	string	gaussian	gaussian|beta
Model function for source extent
psfmodel	no	string	ellbeta	ellbeta|medium|slew
Model PSF: fully 2d parameterized analytical EPIC PSFs (ellbeta, default from version 5.17.2 on) or medium accuracy PSF for observations in pointing mode; slew for pn observations in slew mode
minextent	no	float	1.5	[0.0$<$param$<$300.]
Minimum allowed value for the extent parameter of an extent model in image pixels
maxextent	no	float	20.0	[0.1$<$param$<$300.]
Maximum allowed value for the extent parameter of an extent model in image pixels
withhotpixelfilter	no	boolean	false
If true, the likelihood contribution of the brightest pixel will be ignored (i.e., detections relying on a single pixel will be disregarded).
nmaxfit	no	integer	1	1,10
Maximum number of neighbouring sources to be fit simultaneously (nmaxfit$*$nmulsou$\leq 10$)
nmulsou	no	integer	1	1,3
Allow fit to split up one input source in maximum nmulsou sources (nmaxfit$*$nmulsou$\leq 10$)
pimin	no	integer	2000	[0$<$param$<$30000]
Lower energy boundaries of exposure images; units: eV; one value per input image
pimax	no	integer	4500	[0$<$param$<$30000]
Higher energy boundaries of exposure images; units: eV; one value per input image
hrpndef	no	integer	1 2 2 3 3 4 4 5	0,10
Array of up to eight indices (integer) specifying the upper and lower energy band for each of the hardness ratios for PN; i.e. two numbers per energy band.
hrm1def	no	integer	1 2 2 3 3 4 4 5	0,10
Array of up to eight indices (integer) specifying the upper and lower energy band for each of the hardness ratios for MOS1; i.e. two numbers per energy band.
hrm2def	no	integer	1 2 2 3 3 4 4 5	0,10
Array of up to eight indices (integer) specifying the upper and lower energy band for each of the hardness ratios for MOS2; i.e. two numbers per energy band.
xidpndef	no	integer	2 3 4	0,10
Index of the energy band(s) from which the images / start values for the XID band are taken for PN
xidm1def	no	integer	2 3 4	0,10
Index of the energy band(s) from which the images / start values for the XID band are taken for MOS1
xidm2def	no	integer	2 3 4	0,10
Index of the energy band(s) from which the images / start values for the XID band are taken for MOS 2
xidfixed	no	boolean	false
Run emldetect on XID-band image with positions and source extent fixed to input values
withthreshold	no	boolean	false
Allow splitting up into multi-PSF fitting only for sources above threshold
threshold	no	float	20	[param$>$0.0]
Value of threshold for multi-PSF fitting
threshcolumn	no	string	LIKE	LIKE|SCTS|RATE
Column in input list on which threshold will be applied
withtwostage	no	boolean	false
Use two-stage process for multi PSF (nmulsou$>$ 1) fitting
imagebuffersize	no	integer	640	100$<$param$<$10000
Parameter that controls memory requirements for mosaic images.
withimagebuffersize	no	boolean	no
Allow user-defined values of imagebuffersize.
Parameter	Mand	Type	Default	Constraints

$^1$ Space-separated list, sorted by instrument and energy band. I.e., energy band one to energy band $n$ of instrument one is followed by energy band one to $n$ of instrument two.
$^2$ One per instrument per energy band; space-separated list.
$^3$ One per instrument; space-separated list.
$^4$ A parameter value of $1.0$ would thus correspond to an infinite radius.