FindDetectorsOutsideLimits
From MantidProject
Contents |
Summary
Identifies histograms and their detectors that have total numbers of counts over a user defined maximum or less than the user define minimum.
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | InputWorkspace | Input | Workspace | Mandatory | Name of the input workspace2D |
| 2 | OutputWorkspace | Output | Workspace | Mandatory | Each histogram from the input workspace maps to a histogram in this workspace with one value that indicates if there was a dead detector |
| 3 | HighThreshold | Input | double | 0.0 | Spectra whose total number of counts are equal to or above this value will be marked bad |
| 4 | LowThreshold | Input | double | 0.0 | Spectra whose total number of counts are equal to or below this value will be marked bad |
| 5 | GoodValue | Input | double | 0.0 | The value to be assigned to spectra flagged as 'live' |
| 6 | BadValue | Input | double | 100.0 | The value to be assign to spectra flagged as 'bad' |
| 7 | RangeLower | Input | double | The start of each histogram | No bin with a boundary at an x value less than this will be used in the summation that decides if a detector is 'bad' |
| 8 | RangeUpper | Input | double | The end of each histogram | No bin with a boundary at an x value higher than this value will be used in the summation that decides if a detector is 'bad' |
| 9 | OutputFile | Input | string | Optional | A filename to which to write the list of dead detector UDETs |
| 10 | BadSpectraNums | Output | integer list | Not available in MantidPlot | The list of specta numbers that failed this test |
Description
This is intended to identify detectors that are grossly over or under counting. It reads the input workspace and identifies all histograms with numbers of counts outside the user defined upper and lower limits. For each histogram that fails the criteria the value BadValue is written to the output workspace, in a single bin histogram with the same spectra number as the histogram that failed. The value in the property GoodValue is written to all the other histograms.
The detector IDs of all the detectors associated with failing histograms are listed in the output array. The output file contains spectrum numbers and detector IDs for those histograms. Histograms associated with detectors that were already marked dead in the input workspace are listed as bad in the output workspace, file and array and are not included in any of the calculations.
Subalgorithms used
Uses the Integration algorithm to sum the spectra.
Source Code
Header FindDetectorsOutsideLimits.h
