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


eregionanalyse (especget-1.54) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
imagesetyesstringimage 
The name of the input image.
 
srcexpyesstring  
Expression for extracting the source events.
 
backexpnostringNotSet 
Expression for extracting the background events. If not set the background value is taken from the parameter backval.
 
bkgimagesetnostringNotSet 
The name of the background image
 
exposuremapnostringNotSet 
The name of the exposure map
 
backvalnodouble0.0 
The background value in cnts per square arcsecond. This value is used if a backexp expression has not been set, otherwise the parameter is ignored.
 
ulsignodouble0.954 
The significance for the upper limit calculation. The default is two-sigma (0.954). Set the value to 0.68 for one sigma or 0.997 for three sigma etc.
 
psfmodelnostringELLBETA 
The point spread function (PSF) model to use when calculating the encircled energy correction. Options are ELLBETA, EXTENDED, HIGH.
 
xcentroidnodouble  
Output parameter that contains the X coordinate centroid. This will be in the units of the input image, e.g. sky pixels, detector pixels or degrees.
 
ycentroidnodouble  
Output parameter that contains the Y coordinate centroid. In the units of the input image.
 
optradiusnodouble  
Output parameter that contains the optimum extraction radius in the units of the input image (sky pixels, detector pixels or degrees).
 
optellipxradnodouble  
Output parameter that contains the optimum X radius in the units of the input image (sky pixels, detector pixels or degrees) for an elliptical extraction region.
 
optellipyradnodouble  
Output parameter that contains the optimum Y radius in the units of the input image (sky pixels, detector pixels or degrees) for an elliptical extraction region.
 
optelliprotnodouble  
Output parameter that contains the rotation angle of the optimum ellipse in degrees.
 
srccntsnodouble  
Output parameter that contains the total src (+backgnd) counts within the source region.
 
statusnoboolean  
Output parameter. This is set to false if the input image was from a Timing or Burst mode observation which eregionanalyse can not yet handle. Otherwise it is set true.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30