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


fitsstat (fitsutils-1.10.1) [xmmsas_20230412_1735-21.0.0]

Parameters

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

ParameterMand Type Default Constraints
setyesdataset  
Name of the input FITS data set. If datatype=`column', the table name should be added, following the `:', such as, `input1.ds:SRCLIST'.
 
datatypenostringimageimage|column
The datatype of interest in the input FITS file.
 
columnyesstring  
This parameter is read only if datatype=`column'. This specifies the name of the column of interest.
 
withregionnobooleanno 
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.
 
regionstylenostringcirclecircle|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.
 
centrecoordsyesreal list  
This parameter is read only if withregion=yes. It is the list of the image pixel coordinates for the (x,y) axes.
 
radiiyesreal list  
This parameter is read only if withregion=yes. It specifies a radius (or maybe radii in the future) of the region.
 
radiiinnernoreal list0.0 
This parameter is read only if withregion=yes. It specifies a inner radius (or maybe radii in the future) of the annuluar region.
 
withmincoordsnobooleanno 
If set, the task reads minareacoords.
 
minareacoordsnoreal 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.
 
withmaxcoordsnobooleanno 
If set, the task reads maxareacoords.
 
maxareacoordsnoreal 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.
 
withvallowernobooleanno 
If set, the task reads vallower.
 
vallowernoreal  
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.
 
withvaluppernobooleanno 
If set, the task reads valupper.
 
valuppernoreal  
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.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2023-04-16