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


emldetect (emldetect-4.59.1) [xmmsas_20060628_1801-7.0.0]

References Home Page Errors Home Index

Meta Index / Home Page

Parameters

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

ParameterMand Type Default Constraints
imagesetsyesfilename listimage.fits 
Names of input EPIC fits images$^{1,2}$ or event lists$^3$ (if useevents = true; not yet implemented)
 
expimagesetsnofilename listexpimage.fits 
Names of exposure images$^{1,2}$
 
detmasksetsnofilename listdetmask.fits 
Names of detection masks$^{3}$
 
bkgimagesetsyesfilename listbkgimage.fits 
Names of background maps$^{1,2}$
 
boxlistsetyesfilenameeboxlist.fits 
Name of eboxdetect source list
 
mllistsetyesfilenameemllist.fits 
Name of output emldetect source list
 
mergedlistsetnofilenamemergedlist.fits 
Name of merged source list
 
mlminnofloat10.0[1.0$<$param$<$50.0]
Minimum detection likelihood for inclusion of source in output list
 
dmlextminnofloat10.0[1.0$<$param$<$100.0]
Required likelihood improvement for source extent
 
scutnofloat0.9[0.4$<$param$<$0.99]
Source selection radius for multi-source fitting (expressed as fraction of the normalized PSF integrated to the desired radius)
 
ecutnofloat0.68[0.4$<$param$<$0.99]
Event cut-out radius for multi-source fitting (expressed as fraction of the normalized PSF integrated to the desired cut-out radius)$^4$
 
ecfnofloat1.0[0.001$<$param$<$1000]
Energy conversion factors, given in units of $10^{11}$ counts cm$^2$ erg$^{-1}$ $^{1,2}$
 
xidecfnofloat1.0[0.001$<$param$<$1000]
XID band energy conversion factors, given in units of $10^{11}$ counts cm$^2$ erg$^{-1}$ $^3$
 
useeventsnobinaryfalse 
Photon mode flag$^6$
 
fitpositionnobinarytrue 
Fit source positions
 
fitextentnobinaryfalse 
Fit source extent
 
fitcountsnobinarytrue 
Fit source counts
 
fitnegativenobinaryfalse 
Allow fitted count rates to become negative
 
determineerrorsnobinarytrue 
Determine statisitical errors
 
withexpimagenobinarytrue 
Use exposure maps
 
withdetmasknobinaryfalse 
Only sky pixels inside the detection mask will be used in the PSF fits if set to true
 
withoffsetsnobooleanfalse 
Controls whether the merged source list will be read
 
withxidbandnobooleanfalse 
Controls whether XID band output will be written
 
withsourcemapnobooleanfalse 
Controls whether source maps (one per input image) will be written
 
sourceimagesetsnofilename listsrcmap.fits 
Names of source maps (one per input image)
 
usecalpsfnobooleantrue 
True: read PSF from the calibration db; false: use hardcoded PSF$^5$
 
extentmodelnostringgaussiangaussian|beta
Model function for source extent
 
maxextentnofloat20.0[0.1$<$param$<$300.]
Maximum allowed value for the extent parameter of an extent model in image pixels
 
withhotpixelfilternobooleanfalse 
if true, the likelihood contribution of the brightest pixel will be ignored (i.e., detections relying on a single pixel will be disregarded)
 
nmaxfitnointeger11,6
Max. number of sources to be fit simultaneously
 
nmulsounointeger11,3
Allow fit to split up one input source in maximum nmulsou sources
 
piminnointeger2000[0$<$param$<$20000]
Lower energy boundaries of exposure images; units: eV
 
pimaxnointeger4500[0$<$param$<$20000]
Higher energy boundaries of exposure images; units: eV
 
hrpndefnointeger1 2 2 3 3 40,10
Array of six integer numbers specifiying the upper and lower energy band for each of three hardness ratios (PN)
 
hrm1defnointeger1 2 2 3 3 40,10
Array of six integer numbers specifiying the upper and lower energy band for each of three hardness ratios (MOS1)
 
hrm2defnointeger1 2 2 3 3 40,10
Array of six integer numbers specifiying the upper and lower energy band for each of three hardness ratios (MOS2)
 
xidpndefnointeger2 30,10
energy bands used as xid band (PN)
 
xidm1defnointeger2 30,10
energy bands used as xid band (MOS1)
 
xidm2defnointeger2 30,10
energy bands used as xid band (MOS 2)
 
xidfixednobooleanfalse 
Run emldetect on XID band image with positions and source extent fixed to input values
 
withthresholdnobooleanfalse 
Allow splitting up into multi-PSF fitting only for sources above threshold
 
thresholdnofloat20[1.0$<$param$<$50.0]
Value of threshold for multi-PSF fitting
 
threshcolumnnostringLIKELIKE|SCTS|RATE
Column in input list, on which threshold will be applied
 
ParameterMand Type Default Constraints

$^1$ Space separated list, sorted by instrument and energy band. I.e.,energy band 1 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
$^3$ One per instrument
$^4$ A parameter value of 1.0 would thus correspond to an infinite radius.
$^6$ Photon mode is not yet implemented in the current task version.


References Home Page Errors Home Index

XMM-Newton SOC/SSC -- 2006-06-28