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


ebkgreg (ebkgreg-0.8) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
imagesetyesstringimage 
Input image FITS file (eg., P0123456789PNS003IMAGE_8000.FIT/FTZ).
 
withsrclistnobooleantrue 
Whether to use the source list in the observation.
 
srclisttabyestable  
Mandatory if withsrclist is true. Source list (e.g., P0123456789EPX000OBSMLI0000.FIT/FTZ) in the observation.
 
withsrcradnobooleanfalse 
Extraction region radius for each source (SRC_RAD) from input Source List, instead the tabulated LOOKUP.FITS table. This parameter is read if withsrclist is true.
 
withcoordsnobooleanfalse 
Whether to give the coordinates in the command-line arguments. This parameter is read if withsrclist is false.
 
coordtypeyesstringeqposeqpos pos
The coordinate system for which the source position, specified by the parameter x and y, is defined. If coordtype is set to eqpos, then x, y correspond to RA and DEC respectively in decimal degrees. If coordtype $=$ pos, then x,y correspond to POS coordinates. (Note that the POS coordinates are defined relative to a nominal pointing position; this is taken from the global attributes REFXCRVL and REFYCRVL of the image dataset.)
 
xyesreal  
The X coordinate of the source position.
 
yyesreal  
The Y coordinate of the source position.
 
ryesreal  
Source extraction region radius in arcsec.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30