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


eupper (especget-1.54) [xmmsas_20230412_1735-21.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.
 
exposuremapnostringNotSet 
The name of the exposure map
 
srcrayesdouble  
The right ascencion of the upper limit position in degrees.
 
srcdecyesdouble  
The declination of the upper limit position in degrees.
 
srcradiusyesdouble  
The radius of the source area (degrees)
 
bgdrayesdouble  
The right ascencion of the background area in degrees.
 
bgddecyesdouble  
The declination of the background area in degrees.
 
bgdrinnernodouble0.0 
The inner radius of the background area (degrees). Deafulted to 0 in the case of a circular region
 
bgdrouteryesdouble  
The outer radius of the background area (degrees).
 
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.
 
witheefnobooleanno 
Whether the encircled energy factor has been specified as a parameter
 
eefnodouble1.0 
If witheef=true then the encircled energy factor is set by this parameter.
 
expmodenodoubleadd 
If expmode=add then the code uses the summed exposure time from all of the input exposure maps. If expmode=average, it uses the mean exposure time from the maps.
 
detailsyesbooleanno 
Output details of the calculation including number of counts etc.
 
withoutputfileyesbooleanno 
Write the output result to a text file ?
 
outputnostringoutput.txt 
Name of output text file
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2023-04-16