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


region (region-7.15.2) [xmmsas_20211130_0941-20.0.0]

Errors

This section documents warnings and errors generated by this task (if any). Note that warnings and errors can also be generated in the SAS infrastructure libraries, in which case they would not be documented here. Refer to the index of all errors and warnings available in the HTML version of the SAS documentation.

badOutUniterror 
 The value of outunit was not recognized.
 
badInstrumerror 
 The value of the INSTRUME keyword of the event list was not one of the XMM EPIC instruments.
 
noSourcesSelectederror 
 None of the sources in the input event list passed the filter specified by expression.
 
tooFewRowserror 
 When operationstyle=`single' a single source is specified via the usersrcid parameter. This refers to the row number of the filtered source list (note the first row is assumed to be numbered 1 not 0). The present error occurs if the number of rows is less than usersrcid.
 
nonUniqueSrcIderror 
 When operationstyle=`batch', it is necessary to assign a unique identification integer to each source, because the extension names in which the regions are stored contain this integer. The integer is taken from a column specified via the srcidcol parameter. The present error occurs if any value of the integer specified in this column occurs more than once (in the filtered source list).
 
badIdBanderror 
 At present it is necessary that the source list must contain an ID_BAND column. This is to allow the energy limits of the source detection band to be determined. ID_BAND numbers must be between 0 and 9 inclusive, otherwise the task does not know how to decode them.
 
badEnergyBandEdgeserror 
 The 'lower' energy was found to be higher than the 'higher' energy for this band! This is probably a bug.
 
notSupportederror 
 Flags a mode which is not yet supported.
 
badBkgFluxStyleerror 
 The value of bkgratestyle was not recognized.
 
badRadiusStyleerror 
 The value of radiusstyle was not recognized.
 
badOperationsStyleerror 
 The value of operationstyle was not recognized.
 
energyThetaOrPhiOutOfRangeerror 
 This occurs as the task attempts to access the PSF stored in the XMM calibration files via a cal library call. This call returns the PSF only for a limited range of source energy and position. The position is specified in the polar coordinates (theta,phi) of the TELCOORD system (see the cal documentation for details). Actually only one out-of-range condition is accepted: if theta (the off-axis angle) exceeds its cal limit, a warning rather than an error is generated and the limiting value is substituted. This difference is because the theta range does not quite cover the actual instrument extent, thus the theta-over-range condition occurs rather often in practice; whereas the other out-of-range conditions should not occur at all.
 
nonRealSrcRadiierror 
 Indicates a bug in the confused-source-radius shrinking routine. Report this to the code developer.
 
doubledSourceerror 
 This occurs when the task is attempting to eliminate overlap between source-regions of confused sources. However, many source lists contain more than one entry for the same position (say, to record the source flux at different energies). This is clearly not the same thing as a confused source and it is not desirable that the regions for all such duplicated source positions be shrunk to zero in an attempt to remove such spurious `confusion overlap'. The task attempts to detect such duplicated source positions and fails with the present error if it finds any. the solution is to filter these duplicated sources from the list and then resubmit the list to region.
 
tooManyRowswarning 
 When operationstyle=`batch', regions are stored in FITS binary table extensions which have names containing an identifying integer. The maximum value of this (from length considerations of the extension name string) is presently 9999. If there are more than 9999 source in the (filtered) input list, the present warning will be generated.
corrective action: The task only stores regions for the first 9999 sources.
 
nonUniqueIdBandwarning 
 More than one value of ID_BAND was detected in the source list. This implies that the list contains more than one row for one or more of the source positions. In this case several concentric regions will be produced for these sources. If you don't want this to happen you should filter the source list (the task can do this for you via its expression parameter) so that only one value of ID_BAND remains.
corrective action: The task takes no corrective action.
 
noBandEnergywarning 
 The task couldn't work out the source energy. This may be a bug and should be reported to the code developer.
corrective action: The task uses a default energy value.
 
srcThetaTooLargewarning 
 This occurs as the task attempts to access the PSF stored in the XMM calibration files via a cal library call. This call returns the PSF only for a limited range of source energy and position. The position is specified in the polar coordinates (theta,phi) of the TELCOORD system (see the cal documentation for details). However, the theta range does not quite cover the actual instrument extent, thus the theta-over-range condition is probably going to happen sooner or later. There's no cause for alarm.
corrective action: The task uses the maximum value of theta instead.
 

XMM-Newton SOC -- 2021-11-30