/
FindDetectorsOutsideLimits.h
98 lines (82 loc) · 3.46 KB
/
FindDetectorsOutsideLimits.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
#ifndef MANTID_ALGORITHM_FINDDETECTORSOUTSIDELIMITS_H_
#define MANTID_ALGORITHM_FINDDETECTORSOUTSIDELIMITS_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/DetectorDiagnostic.h"
namespace Mantid {
namespace Algorithms {
/**
Takes a workspace as input and identifies all spectra where the sum of the
counts in all bins is outside a range. Those that are outside the range, i.e.
fail
the tests, have their spectra masked on the output workspace and those
passing
the tests are left with a postive value in the bin
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace2D to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the
results </LI>
<LI> HighThreshold - Spectra whose total number of counts are above or equal
to this
value will be marked dead</LI>
</UL>
Optional Properties:
<UL>
<LI> LowThreshold - Spectra whose total number of counts are below or equal
to this
value will be marked dead (default 0)</LI>
<LI> StartX - Start the integration at the above bin above the one that this
value is
in (default: the start of each histogram)</LI>
<LI> EndX - Stop the integration at the bin before the one that contains this
x value
(default: the end of each histogram)</LI>
</UL>
@author Steve D Williams, ISIS Facility Rutherford Appleton Laboratory
@date 07/07/2009
Copyright © 2007-8 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport FindDetectorsOutsideLimits : public DetectorDiagnostic {
public:
/// Default constructor
FindDetectorsOutsideLimits() : DetectorDiagnostic() {}
/// Destructor
~FindDetectorsOutsideLimits() override {}
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override {
return "FindDetectorsOutsideLimits";
}
/// Summary of algorithms purpose
const std::string summary() const override {
return "Identifies histograms and their detectors that have total numbers "
"of counts over a user defined maximum or less than the user define "
"minimum.";
}
const std::string category() const override;
/// Algorithm's version for identification overriding a virtual method
int version() const override { return (1); }
private:
/// Overridden init
void init() override;
/// Overridden exec
void exec() override;
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHM_FINDDETECTORSOUTSIDELIMITS_H_*/