| Parameter | Mand | Type | Default | Constraints |
| spectrumset | yes | dataset | | |
The name of the input spectrum in counts v channel space.
|
| overwrite | no | boolean | no | |
Whether to overwrite the input spectrum with grouping information
or to produce a new file (default)
|
| groupedset | no | dataset | SpecGrp.ds | |
The name of the grouped output spectrum
|
| backgndset | no | dataset | | |
The name of the background spectrum
|
| mincounts | no | int | | |
The minimum number of counts (source+background) to use when grouping
|
| minSN | no | real | | |
The minimum signal to noise ratio to use when grouping
|
| ratioabovebgnd | no | real | | |
The minimum ratio of source to background to use when grouping
|
| grouptemplate | no | dataset | | |
The name of a spectrum from which to copy the grouping parameters
|
| oversample | no | real | | |
The minimum energy resolution for each group, e.g. if oversample=3
then the minimum width of a group is 1/3 of the resolution FWHM at
that energy.
|
| ranges | no | string | | |
Ranges to group over. They should be entered as integer numbers, if defined
in channels, or as decimals if defined in keV (in which case the units
parameter should be set accordingly. The beginning and end of a range may be seperated by either a colon or a dash. Multiple ranges should be seperated by a comma. e.g. "2-20,63-97" or "0.2-0.5" or "0.4:3.6" etc.
|
| units | no | choice | CHAN | CHAN KEV |
The units used for ranges - can be channel number of keV.
|
| regbinstart | no | int | | |
First channel to use if grouping done by regular bins
|
| regbinend | no | int | | |
Last channel to use if grouping done by regular bins
|
| regbinwid | no | int | | |
Number of channels to combine in each group if grouping done by regular bins
|
| rmfset | no | dataset | | |
The name of a redistribution matrix used to define the energy of the
spectral channels.
|
| hightolow | no | boolean | false | |
Whether to group from low to high (false) or high to low (true) energies.
|
| addfilenames | no | boolean | true | |
Whether to set the ANCRFILE, RESPFILE, BACKFILE keywords in the spectrum
header.
|
| arfset | no | dataset | | |
The name of an effective area (ARF) file. This is purely used as a string
to write into the ANCRFILE keyword. The file is not opened.
|
| lastbin | no | choice | addtogroup | addtogroup setbad owngroup |
What to do about ungrouped channels, typically the channels at the end
of the spectrum which don't meet the statistical criterion.
|
| setbad | no | string | CCF | CCF no ranges_of_values |
Whether to set some channels BAD and exclude them from grouping.
Options are: "CCF" - to read the BAD channels from a calibration file,
"no" - meaning 'take no action' or
a range such as "0-10,750-799" may be entered to explicitely specify which
channels to set BAD. The range may be defined in channels or keV, consistent
with the setting of the units parameter.
|
| Parameter | Mand | Type | Default | Constraints |
