| Parameter | Mand | Type | Default | Constraints |
| imageset | yes | string | image | |
|
The name of the input image.
| ||||
| srcexp | yes | string | ||
|
Expression for extracting the source events.
| ||||
| backexp | no | string | NotSet | |
|
Expression for extracting the background events. If not set the
background value is taken from the parameter backval.
| ||||
| bkgimageset | no | string | NotSet | |
|
The name of the background image
| ||||
| exposuremap | no | string | NotSet | |
|
The name of the exposure map
| ||||
| backval | no | double | 0.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.
| ||||
| ulsig | no | double | 0.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.
| ||||
| psfmodel | no | string | ELLBETA | |
|
The point spread function (PSF) model to use when calculating
the encircled energy correction. Options are ELLBETA, EXTENDED,
HIGH.
| ||||
| xcentroid | no | double | ||
|
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.
| ||||
| ycentroid | no | double | ||
|
Output parameter that contains the Y coordinate centroid. In the units
of the input image.
| ||||
| optradius | no | double | ||
|
Output parameter that contains the optimum extraction radius in the units
of the input image (sky pixels, detector pixels or degrees).
| ||||
| optellipxrad | no | double | ||
|
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.
| ||||
| optellipyrad | no | double | ||
|
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.
| ||||
| optelliprot | no | double | ||
|
Output parameter that contains the rotation angle of the optimum
ellipse in degrees.
| ||||
| srccnts | no | double | ||
|
Output parameter that contains the total src (+backgnd) counts within
the source region.
| ||||
| status | no | boolean | ||
|
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.
| ||||
| Parameter | Mand | Type | Default | Constraints |
XMM-Newton SOC -- 2025-01-27