XMM-Newton Science Analysis System


omscattered (omscattered-1.5) [xmmsas_20230412_1735-21.0.0]

Parameters

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

Parameter	Mand	Type	Default	Constraints
set	yes	string	none
Input OM image file with the central region contaminated by the scattered light feature
scatset	yes	string	none
Name of the input file containing the calibrated scattered light feature
outset	no	string	none
The name for the output file whose image would be cleaned from the central scattered light feature.
scalingfactor	no	real	-1	-1 : 10
The scaling factor for the calibrated image containing the central scattered light feature. If set to a positive value, this scaling factor is used for scaling the calibrated image before subtracting it from the input image. Otherwise, the task will compute the scaling factor automatically.
innerradius	no	real	-1	-1 : $\infty$
The inner radius (in unbinned pixels of the OM-detector) defining the ring-shaped region for measuring the background level of both input and calibrated images. This level is used for automatic calculation of the scaling factor for the calibrated scattered light image. If this parameter is set to a positive value, the task uses the user-defined ring-shaped region for the background evaluation. Otherwise, a default value (currently set to 280 unbinned pixels) is used for the inner radius of this ring-shaped region.
outerradius	no	real	-1	-1 : $\infty$
The outer radius (in unbinned pixels of the OM-detector) defining the ring-shaped region for measuring the background level of both input and calibrated images. This level is used for automatic calculation of the scaling factor for the calibrated scattered light image. If this parameter is set to a positive value, the task uses the user-defined ring-shaped region for the background evaluation. Otherwise, a default value (currently set to 350 unbinned pixels) is used for the outer radius of this ring-shaped region.
mode	no	integer	1	1:3
This parameter switches the task between 3 available modes of calculating the scaling factor (see text).
Parameter	Mand	Type	Default	Constraints