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


colimchain (colimchain-1.9) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
prodsdirnostring. 
Directory where the input images are to be found.
 
clobberprodsnobooleannoyes|no
`Yes' forces overwrite of colimchain output.
 
astestnobooleannoyes|no
If 'yes', the task makes no system calls. This mode can be used if it is desired just to test the perl script.
 
instrumentnostringm1m1|m2|pn
XMM instrument.
 
idtypenostringindexindex|full
Specifies how the user wants to enter the observation and exposure information. If `index', the task looks for the parameters obsindex and expindex; if `full', the task looks for the parameters obsid and expid.
 
obsindexnointeger obsindex$>0$
Read by the task if idtype=`index'. If there is more than 1 observation in the indicated product directory, colimchain lists them internally in increasing order, and produces output only for that member of the list indicated by this parameter. Note that the numbers start at 0.
 
expindexnointeger expindex$>0$
Read by the task if idtype=`index'. If there is more than 1 exposure for the selected observation, colimchain lists them internally in increasing alphanumeric order, and produces output only for that member of the list indicated by this parameter. Note that the numbers start at 0.
 
obsidnostring  
Read by the task if idtype=`full'. This is the 10-digit observation ID number.
 
expidnostring  
Read by the task if idtype=`full'. This is the 4-character exposure ID string: either S or U, followed by a 3-digit number.
 
bandlistnointeger list2 3 4 
List of energy band numbers. These should be in increasing order.
 
withthumbnailsnobooleannoyes|no
To be set if it is desired to write thumbnail colur images.
 
thumbnaildirnostring./thumbnails 
The directory in which to write the thumbnail images.
 
smoothnobooleanyesyes|no
'Yes' invokes asmooth to smooth the input images before they are supplied to colimplot.
 
maxwidthnoreal20.0 pixels0.0 $\le$ maxwidth $\le$ 20.0 pixels
asmooth parameter. The maximum allowed value of the width $\sigma$ of the smoothing gaussian is specified via this parameter.
 
desiredsnrnoreal20.0$>0$
asmooth parameter. The maximum desired signal-to-noise ratio of the output image can be specified via this parameter.
 
nconvolversnointeger30$2\le$ nconvolvers $\le126$
The maximum number of gaussian smoothing kernels is specified via this parameter.
 
rebinimagenobooleannoyes/no
colimplot parameter. Rebin the image to the specifications dictated by the parameters dividexby and divideyby or newnxbins and newnybins.
 
newnxbinsnointeger100$10\le$ newnxbins $\le 1000$
colimplot parameter. The number of x pixels in the rebinned image.
 
newnybinsnointeger100$10\le$ newnybins $\le 1000$
colimplot parameter. The number of y pixels in the rebinned image.
 
weirdnessnoreal-0.7$-1.0\le$ weirdness $\le 1.0$
colimplot parameter. This parameter exerts control over the colour values of the plot. Values of weirdness that approach -1 give output colours in the so-called `thermal' sequence, ie that are similar to those acquired by heated black bodies; values that approach 1 give highly non-thermal colours such as greens and violets.
 
heatnoreal0.0$-1.0\le$ heat $\le 1.0$
colimplot parameter. This parameter exerts control over the colour values of the plot. Smaller values of heat make all the pixels `cooler' in the thermal sequence of colours (ie redder); larger values in contrast `heat up' the colour values, ie make them bluer.
 
heatspreadnoreal0.0$-1.0\le$ heatspread $\le 1.0$
This parameter exerts control over the colour values of the plot. Smaller values of heatspread pull all the pixels in towards white, larger values spread them out more along the thermal sequence of colours.
 
cutoffnoreal0.05$0.0\le$ cutoff $\le 1.0$
colimplot parameter. Pixels which have a total flux which is less than cutoff times the maximum total flux are not included in calculations of the reference multiplet. The purpose of this is to prevent such calculations being skewed by background values, which usually dominate an image in terms of numbers of pixels involved.
 
gainstylenostringautoauto|user
colimplot parameter. If `auto', the gain is calculated such that the median image flux is scaled to about a third of the output brightness range. If `user', the value given via the parameter gain is used.
 
gainnoreal8.0$0.0\le$ gain
colimplot parameter. The image brightness is multiplied by this constant. Note it is only user-settable when parameter gainstyle = `user'.
 
pgdevnostring/png 
colimplot parameter. The pgplot device name.
 
expandtomasknobooleanyesyes/no
colimplot parameter. If a mask set is employed, this parameter can be set so as to expand the output image until the unmasked part of it just fills the available area. The exposure map is frequently used as a mask.
 
plotfilenostringtest.ps 
colimplot parameter. If the pgplot device is one that requires an output file, this gives the name of the file.
 
withframenobooleannoyes/no
If pgdev=`/ppm' and withframe=`yes', the task constructs a frame plot around the image, containing various pieces of information such as the name of the observer and the target. This is written to a .gif file named frame.gif, which can be combined with the output image by colimchain.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30