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


imweightadd (tools-1.68) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
imagesetsyesdataset list  
List of $N$ input images to be summed. They must all have the same pixel dimensions.
 
outimagesetnodatasetoutimage.ds 
The output image, equal to $\sum_{i=1}^N w_i$ imagesets.
 
tempsetnodatasettempimage.ds 
Name of a temporary image dataset (for pipeline use).
 
calculateweightsnoboolno 
If this parameter = `no', the input images are simply summed, and neither background maps or exposure maps are required inputs. Contrariwise for `yes'.
 
bkgmapsetsyesdataset list  
List of background maps to be summed. They must all have the same pixel dimensions as the imagesets, and there must be the same number of members in each list. Each background map should correspond with the image at the same place in the respective list. This parameter is only read if calculateweights=`yes'.
 
outbkgmapsetnodatasetoutbkgmap.ds 
The output background map, equal to $\sum_{i=1}^N w_i$ bkgmapsets. This parameter is only read if calculateweights=`yes'.
 
expmapsetsyesdataset list  
List of exposure maps to be summed. They must all have the same pixel dimensions as the imagesets, and there must be the same number of members in each list. Each exposure map should correspond with the image at the same place in the respective list. This parameter is only read if calculateweights=`yes'.
 
outexpmapsetnodatasetoutexpmap.ds 
The output exposure map, equal to $\sum_{i=1}^N w_i$ expmapsets. This parameter is only read if calculateweights=`yes'.
 
withrelsrcratesnoboolno 
Whether to read the relative source-count expectation values (`source spectrum') from parameter relsrcrates. If withrelsrcrates=`no', these relative rates are all set to 1. This parameter is only read if calculateweights=`yes'.
 
relsrcratesyesreal list1.0$0<$relsrcrates
This parameter is read if calculateweights=`yes' and withrelsrcrates=`yes'.
 
likeminnoreal10.0$0<$likemin
The cutoff value of likelihood.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30