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


omfchain (omfchain-1.43.1) [xmmsas_20211130_0941-20.0.0]

Parameters

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

All parameters are optional.
ParameterMand Type Default Constraints
inpdirectorynostringnone 
Directory path-name of the input files directory - defaults to the current directory.
 
outdirectorynostringnone 
Directory path-name of the output files directory - defaults to inpdirectory
 
boxscalenoint2boxscale$\geq1$
Sliding box size for detection by omdetect
 
contrastnoreal0.001contrast$\geq0$
Contrast parameter for the source detection algorithm (it is O.K. if $flux \geq confused source / total flux $
 
maxscalenoint1maxscale$\geq1$
Maximum power of 2 to search to by omdetect
 
nsigmanoreal6nsigma$\geq1$
Number of $\sigma$ for source detection by omdetect
 
smoothsizenoreal64$1 \geq$smoothsize$\geq 264$
Smooth size (in pixels) used for smoothing image and background by omdetect
 
srcradiusnoreal$-6$$-12 \geq$srcradius$\geq12$
Radius of the source extraction circle. If it is negative, it is expressed in pixels, and its value will be fixed during the extraction of counts. If it is positive, it is expressed in FWHMs, and its value could be reduced by omregion if there is any contaminating source near by the target.
 
bkginnernoreal1.2bkginner$\geq1$
Inner radius of the background annulus in terms of source radius (srcradius)
 
bkgouternoreal1.8bkgouter$\geq1$
Outer radius of the background annulus in terms of source radius (srcradius)
 
timebinsizenoreal10timebinsize$\geq0.5$
Size of the time bins (in seconds) for the time series files
 
bkgfromimagenoboolean“yes”bkgfromimage=yes/no
Condition for using the background obtained from the accompanying imaging data (passed to the task omlcbuild)
 
psfphotometryenablednoboolean“no”psfphotometryenabled=yes/no
Condition for using PSF-fitting for measuring the photometric parameters of the source by the task omdetect
 
maxrawcountratenoreal50maxrawcountrate$\geq0$
A count-rate threshold used for limiting the number of sources processed with the PSF-photometry method, required by omdetect
 
ignoremod8noisenoboolean“no”ignoremod8noise=yes/no
Condition for ignoring the information about the presence of the modulo-8 noise around the source (if it is found)
 
subtractbkgnoboolean“yes”subtractbkg=yes/no
Condition for background subtraction
 
rawattitudenointeger10:2
Specifies the usage of attitude data by the task omprep: if set to 0, the attitude data is used according to the system variable SAS_ATTITUDe (either RAF or AHF); if set to 1, the raw attitude data (RAF) averaged over the first 20 seconds of exposure are used, if set to 2 then the raw atitude data are used averaged over the entire exposure. If the tracking history file is not found then the parameter is reset to 2.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30