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


epileupmask (ebkgmap-2.10.1) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
ratethresholdyesreal0.008$0<=$ratethreshold
The threshold of the rate, where the pixels having the rate larger than this value are regarded as `bad'.
 
inputstylenostringevlistevlist|image
Whether the input file is eventlist or image.
 
eventsetnodataset  
Name of the input event list dataset used to construct the mask image. This parameter is read if inputstyle=`evlist'.
 
imagesetnodataset  
Name of the input image dataset used to construct the mask image. This parameter is read if inputstyle=`image'.
 
evlonoreal $0<$evlo
The lower energy bound of imageset. This is mandatory only if inputstyle=`image'.
 
evhinoreal $0<$evhi
The upper energy bound of imageset. This is mandatory only if inputstyle=`image'.
 
issingleeventonlynobooleanyesyes|no
This is read if inputstyle=`image'. If the image includes only the single pixel events, this must be true. Otherwise (false), all the other standard grade events (e.g., 0–12 in MOSs) are assumed to be included in the image.
 
outputstylenostringskysky|raw
If `sky', the OOTE map is output in sky coordinates, to the file referred to by parameter ooteimageset. In this case a template set (templateset) is needed and the attstyle parameter is also read. If outputstyle=`raw' on the other hand the output is written to a cube (in the expcubeset format) to the file pointed to by ootecubeset.
 
templatesetyesdataset  
This parameter is read if outputstyle=`sky'. This file should contain an image in the primary extension, which is used to define the pixel dimensions and World Coordinates of the output image.
 
masksetnodatasetpileupmask.ds 
If outputstyle=`sky', the output mask image in sky coordinates is written to this file name. If outputstyle=`raw', the output mask cube image in chip coordinates is written to this file name.
 
attstylenostringbinnedsetbinnedset|template
This parameter is read if outputstyle=`sky'. To convert from chip to sky coordinates it is necessary to know the spacecraft attitude. However the attitude is never completely stable and may vary significantly during an exposure. In this case the nett sky image must be a mosaic of components from different values of the attitude. A time series of attitude values (such as that made either by attbin or evproject) can be supplied to parameter binnedattset if attstyle is set to `binnedset'. If it is judged that the attitude wander during the exposure did not exceed some small fraction of the image pixel dimensions, or if the binned attitude set is not available, then the user may choose to set attstyle to `template' instead. In this case a single fixed value of attitude is read from *_PNT keywords in the template image header.
 
binnedattsetyesdataset  
If attstyle=`binnedset' the user should supply to the present parameter the name of a dataset which contains a time series of the spacecraft attitude variation during the exposure. The user should be aware of the fact that if an attitude (time) bin (specified in this file) is too small, the time bin is unlikely to be processed (see the description of avcnttoprocess below). Therefore it is recommended to create the binnedattset, allowing a relatively large attitude fluctuation, such as 1 arcsec, so that attitude bins are not too finely split.
 
avcnttoprocessnoreal7.0$0<=$ratethreshold
When attstyle=`binnedset', the supplied binnedattset file may provide time durations with very short exposures. In that case if a pixel happens to have an event during the short duration, the value of count/frame at that pixel in that duration is large and likely exceeds the threshold ratethreshold, and as a result that pixel will be masked as piled-up just because the pixel has one event at a wrong time. To avoid this happening, any time duration with too short exposure should not be processed. This parameter gives the threshold for it, i.e., only when there are reasonable number of frames in the time duration, in which the averaged count, corresponding to the piled-up threshold, exceeds this parameter avcnttoprocess, the time duration is processed to calculate the output mask. For example, if ratethreshold=0.008 and avcnttoprocess=7.0, each time duration should have the (maximum) number of frames larger than 875 so as to be used by the process, which corresponds to $\sim$2.3 ks for MOSs. Note that because the single-event ratio at 12 keV in MOSs is $\sim$0.23 (0.54 for pn), avcnttoprocess=7.0 corresponds to just above 2 count per frame per pixel in MOSs for very high energy photons, after the grade-branching ratio is corrected.
 
withrateimagenobooleannoyes|no
If this is true, the rate imageset calculated is also output with the filename of ratesetroot. If outputstyle=`sky', the rate image set is in sky coordinates, whereas if outputstyle=`raw', the rate set is the cube format in chip coordinates. Note that the rate is corrected for the event at the energy of 1.487 keV.
 
ratesetrootnodatasetrateset 
This is read only if withrateimage=true. See the section of withrateimage for detail.
 
withboresightfudgenobooleanyesyes|no
Flip the sign of the boresight euler%psi. This parameter will be removed after the boresight is fixed.
 
selexprstylenostringuserrangesuserranges|dss|userexpr
Use of task epileupmask implies that the user wishes to model the background component of a real image. To do this properly it is necessary that the OOTE map and the image reflect the same selection of events. It is therefore necessary to provide details of the event selections used to construct the real image. Ideally the user should supply these in the form of the Data Subspace (DSS) of the actual image by selecting selexprstyle=`dss' and then supplying the file name of the image with the DSS to parameter dssset. However it has been found convenient to also allow the user to supply the event selection expression directly (via expression) or simply to choose to supply a set of energy ranges. The latter can be done by selecting selexprstyle=`userranges' and then supplying lists of values to evlo and evhi. Note that in this circumstance the assumption is made that no other significant non-spatial selections were made to create the original image.
 
dsssetyesdataset  
I selexprstyle=`dss', information about event selections is sought in a Data Subspace (DSS) of the primary extension of this dataset.
 
expressionyesstring  
This parameter is read if selexprstyle=`userexpr'. It should contain the selection expression used to construct the original image.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30