Parameter | Mand | Type | Default | Constraints |
set | yes | dataset | ||
Name of the input FITS data set. If datatype=`column', the table name should be added, following the `:', such as, `input1.ds:SRCLIST'.
| ||||
datatype | no | string | image | image|column |
The datatype of interest in the input FITS file.
| ||||
column | yes | string | ||
This parameter is read only if datatype=`column'.
This specifies the name of the column of interest.
| ||||
withregion | no | boolean | no | |
If set, the task reads regionstyle and relevant parameters to determine the region to calculate the statistics. Note the two parameters minareacoords and maxareacoords are completely independent of this switch.
| ||||
regionstyle | no | string | circle | circle|annulus |
This parameter is read only if withregion=yes.
This specifies the shape of the region. At the moment, only circle and annulus are allowed, and they mean practically identical.
| ||||
centrecoords | yes | real list | ||
This parameter is read only if withregion=yes.
It is the list of the image pixel coordinates for the (x,y) axes.
| ||||
radii | yes | real list | ||
This parameter is read only if withregion=yes.
It specifies a radius (or maybe radii in the future) of the region.
| ||||
radiiinner | no | real list | 0.0 | |
This parameter is read only if withregion=yes.
It specifies a inner radius (or maybe radii in the future) of the annuluar region.
| ||||
withmincoords | no | boolean | no | |
If set, the task reads minareacoords.
| ||||
minareacoords | no | real list | ||
This parameter is read if withmincoords=true.
The area where the coordinates are equal to or larger than these will be taken
into account in the calculation of the statistics.
| ||||
withmaxcoords | no | boolean | no | |
If set, the task reads maxareacoords.
| ||||
maxareacoords | no | real list | ||
This parameter is read if withmaxcoords=true.
The area where the coordinates are equal to or smaller than these will be taken
into account in the calculation of the statistics.
| ||||
withvallower | no | boolean | no | |
If set, the task reads vallower.
| ||||
vallower | no | real | ||
This parameter is read if withvallower=true.
The pixels of which the value is equal to or larger than this value
will be taken into account in the calculation of the statistics.
| ||||
withvalupper | no | boolean | no | |
If set, the task reads valupper.
| ||||
valupper | no | real | ||
This parameter is read if withvalupper=true.
The pixels of which the value is equal to or smaller than this value
will be taken into account in the calculation of the statistics.
| ||||
Parameter | Mand | Type | Default | Constraints |
XMM-Newton SOC -- 2025-01-27