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


colsmooth (colsmooth-1.8) [xmmsas_20211130_0941-20.0.0]

Parameters

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

ParameterMand Type Default Constraints
intableyesdatasetinset.ds:SPECTRUM 
The name of the fits dataset and table that contains the values to be smoothed.
 
incolumnyesstringRATE 
The name of the column in intable that contains the values to be smoothed.
 
withouttablenobooleannoyes|no
If `yes', the task attempts to write the smoothed values to column outcolumn (and, optionally, outerrorscolumn) of dataset outtable; if `no', the task overwrites the values in incolumn.
 
outtablenodatasetoutset.ds:SPECTRUM 
The name of the fits dataset and table which will contain the smoothed values.
 
outcolumnnostringRATE 
The name of the column in outtable which will contain the smoothed values.
 
witherrorsnobooleannoyes|no
If `yes', the task looks for uncertainties in incolumn in the column designated by inerrorscolumn.
 
inerrorscolumnnostringSTAT_ERR 
The name of the column in intable that contains the uncertainties to incolumn. Only read if witherrors=`yes'.
 
outerrorscolumnnostringSTAT_ERR 
The name of the column in outtable which will contain the uncertainties to the smoothed values in outcolumn. Only written if witherrors=`yes'.
 
convolverstylenostringtophatset|tophat|gaussian|user
Mode of entering the convolving function.
 
convolvertablenodatasetconvolver.ds:CONV 
If convolvertype = `set', the names of the dataset+table which contain the convolver are read from this parameter.
 
convolvercolumnnostringCONV 
If convolvertype = `set', the name of the column which contains the convolver is read from this parameter.
 
widthnointeger1$1<=$width
If convolvertype = `tophat', this parameter gives the width in channels of the top hat.
 
sigmanoreal1.0$0<$sigma
If convolvertype = `gaussian', this parameter gives the characteristic width of the gaussian.
 
convolvernoreal list'1.0' 
If convolvertype = `user', the task reads the convolver directly from the list of real numbers contained in this parameter.
 
normalizenobooleanyesyes|no
If `yes', the convolving function is normalised (ie, divided by the sum of all its values).
 
maskstylenostringnoneset|expression|none
Mode of entering the mask vector.
 
masktablenodatasetmask.ds:MASK 
If masktype = `set', the names of the dataset+table which contain the mask are read from this parameter.
 
maskcolumnnostringMASK 
If masktype = `set', the name of the column which contains the mask is read from this parameter.
 
maskexpressionnostring  
If masktype = `expression', the task reads a selection expression from this parameter. Those rows of intable for which the expression evaluates to true cause the corresponding elements of the mask vector to be also set to true.
 
fillholewidthnointeger $0<=$fillholewidth
Gaps in the mask of this width or less are interpolated.
 
ParameterMand Type Default Constraints

XMM-Newton SOC -- 2021-11-30