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


evarimgen (evarimgen-0.9) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
evlistsetyesdataset`foo.bar' 
The name of the event list.
 
xcolumnnostringX 
Name of the column to supply image $x$ coordinate.
 
ycolumnnostringY 
Name of the column to supply image $y$ coordinate.
 
xrangetypenostringmaxlegal`maxlegal'/`maxactual'/`user'
This controls the cutoff points for $x$ values. If xrangetype is set to `maxlegal', the values of TLMINn and TLMAXn are used, where n is the number of the column whose name is given by the xcolumn parameter. A value of xrangetype=`maxactual' dictates that TDMINn and TDMAXn (the true minimum and maximum values of the column entries) should be used instead. If xrangetype=`user', the task looks for user-supplied minimum and maximum values in the parameters xmin and xmax. Events which have $x$ values outside the range are discarded.
 
yrangetypenostringmaxlegal`maxlegal'/`maxactual'/`user'
Similar to xrangetype, but for the $y$ coordinate.
 
imagebinningnostringnumberofpixels`numberofpixels'/`pixelsize'
Controls the way in which the number of $x$ and $y$ pixels are calculated. If imagebinning=`numberofpixels', the numbers of $x$ and $y$ pixels are entered directly via the parameters nxpixels and nypixels. On the other hand if imagebinning=`pixelsize', the user must enter the $x$ and $y$ dimensions of the pixel via the parameters xpixelsize and ypixelsize.
 
xminnoreal-3000.0 
When xrangetype is set to `user', this parameter is expected.
 
xmaxnoreal3000.0 
When xrangetype is set to `user', this parameter is expected.
 
yminnoreal-3000.0 
When yrangetype is set to `user', this parameter is expected.
 
ymaxnoreal3000.0 
When yrangetype is set to `user', this parameter is expected.
 
nxpixelsnointeger600 $1<=nxpixels<=1000$
When imagebinning is set to `numberofpixels', this parameter is expected.
 
nypixelsnointeger600 $1<=nypixels<=1000$
When imagebinning is set to `numberofpixels', this parameter is expected.
 
xpixelsizenoreal1.0$xpixelsize>0$
When imagebinning is set to `pixelsize', this parameter is expected.
 
ypixelsizenoreal1.0$ypixelsize>0$
When imagebinning is set to `pixelsize', this parameter is expected.
 
cutoffnointeger4$cutoff>=0$
Pixels with fewer events than the value of cutoff are set to zero in the variability image.
 
withimagesetnobooleanno 
This is set if the total flux image should be read (using the name given in parameter imageset) rather than created. Note that, if withimageset=no, the total flux image is created within the task and saved to the name given in parameter imageset.
 
imagesetnostring`outimage.ds' 
Name of the total flux image. If withimageset=yes, the task attempts to read the total flux image from a file of this name. If withimageset=no, the task generates the total flux image internally and saves it to a file of this name.
 
varimagesetnostring`outvarimage.ds' 
The variability image is saved to a file of this name.
 
sortevlistnobooleanyes 
The algorithm works best if the events are sorted in time. This parameter tells the task to do this sort. The task generates a warning if sortevlist=no and the events are out of time order.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30