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


eimagecombine (eimagecombine-0.9) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
prefixnostring'MERGED_' 
File name prefix for the output files.
 
withcheckinputnobooleantruetrue$\mid$false
Whether to check the individual input images for consistency.
 
maskindividualnobooleanfalsetrue$\mid$false
Boolean to choose whether or not the images of individual exposures will be masked, if a corresponding mask for this exposure exists.
 
withaddimagesnobooleantruetrue$\mid$false
Whether to add the images of individual exposures.
 
withcombineimagesnobooleantruetrue$\mid$false
Whether to combine the individual EPIC instruments.
 
ecutnoreal1000.$0.0 <$ ecut
Exposure cut (in seconds). Areas with less exposure will be masked.
 
exposurebandnointegerfirst band 
Energy band of the exposure map, which is used to create the mask.
 
epn_weightnoreal list1.0$0.0 <$ epn_weight
A weight for the exposure of each energy band of EPIC-pn.
 
em1_weightnoreal list0.4$0.0 <$ em1_weight
A weight for the exposure of each energy band of EPIC-MOS1.
 
em2_weightnoreal list0.4$0.0 <$ em2_weight
A weight for the exposure of each energy band of EPIC-MOS2.
 
withasmoothnobooleantruetrue$\mid$false
Whether to create the smoothed and corrected images.
 
smoothstylenostringadaptivesimple|adaptive
asmooth: The type of smoothing desired.
 
convolverstylenostringgaussiangaussian | tophat | squarebox
asmooth: This parameter is read if smoothstyle=`simple' is chosen and prescribes the shape or type of convolver to use to smooth the image.
 
widthnoreal5.0 pixels$0.0 \le$ width $\le 100.0$ pixels
asmooth: This parameter is read if smoothstyle=`simple' is chosen. It governs the width of the various types of simple convolver.
 
withuserwidthsnobooleanno 
asmooth: This parameter is read if smoothstyle=`adaptive' is chosen. If set, the task reads a list of gaussian-convolver sigma values from the userwidths parameter.
 
userwidthsnoreal list $0.0 \le$ userwidths $\le 100.0$ pixels
asmooth: The list of gaussian-convolver sigma values read when withuserwidths=`yes'. The values must occurr in a monotonically increasing sequence.
 
minwidthnoreal0.0 pixels$0.0 \le$ minwidth $\le 100.0$ pixels
asmooth: If smoothstyle='adaptive' is chosen but withuserwidths=`no' the task constructs a library of gaussian convolvers which have sigma values ranging from minwidth to maxwidth.
 
maxwidthnoreal10.0 pixels$0.0 \le$ maxwidth $\le 100.0$ pixels
asmooth: If smoothstyle='adaptive' is chosen but withuserwidths=`no', the task constructs a library of gaussian convolvers which have sigma values ranging from minwidth to maxwidth.
 
desiredsnrnoreal10.0$0.0 <$ desiredsnr
asmooth: Desired signal-to-noise ratio in an adaptively-smoothed image.
 
nconvolversnointeger20$2 \le$ nconvolvers $\le 126$
asmooth: If smoothstyle='adaptive' is chosen but withuserwidths=`no', the task constructs a library of nconvolvers gaussian convolvers.
 
templatebandsnointeger listall bands 
If smoothstyle='adaptive' is chosen, the parameter defines the energy bands, which are used to estimate the statistics for the smoothing template.
 
keepinterstagenobooleantruetrue$\mid$false
Boolean to choose whether or not intermediate products will be removed.
 
n_parallelnointeger1 
Experimental tuning parameter to define the maximum number of parallelly executed processes.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30