-
Notifications
You must be signed in to change notification settings - Fork 122
/
DetectorEfficiencyVariation.h
97 lines (81 loc) · 3.8 KB
/
DetectorEfficiencyVariation.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
#ifndef MANTID_ALGORITHM_DETECTOREFFICIENCYVARIATION_H_
#define MANTID_ALGORITHM_DETECTOREFFICIENCYVARIATION_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/DetectorDiagnostic.h"
namespace Mantid {
namespace Algorithms {
/**
Required Properties:
<UL>
<LI> WhiteBeamBase - Name of a white beam vanadium workspace </LI>
<LI> WhiteBeamCompare - Name of a matching second white beam vanadium run
from the same instrument </LI>
<LI> OutputWorkspace - A MaskWorkpace where each spectra that failed the test
is masked </LI>
<LI> Variation - Identify spectra whose total number of counts has changed by
more than this factor of the median change between the two input workspaces
</LI>
</UL>
Optional Properties:
<UL>
<LI> StartWorkspaceIndex - The index number of the first entry in the
Workspace to include in the calculation </LI>
<LI> EndWorkspaceIndex - The index number of the last entry in the Workspace
to include in the calculation </LI>
<LI> RangeLower - No bin with a boundary at an x value less than this will be
included in the summation used to decide if a detector is 'bad' </LI>
<LI> RangeUpper - No bin with a boundary at an x value higher than this value
will be included in the summation used to decide if a detector is 'bad' </LI>
</UL>
@author Steve D Williams, ISIS Facility Rutherford Appleton Laboratory
@date 15/06/2009
Copyright © 2009 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 DetectorEfficiencyVariation : public DetectorDiagnostic {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override {
return "DetectorEfficiencyVariation";
}
/// Summary of algorithms purpose
const std::string summary() const override {
return "Compares two white beam vanadium workspaces from the same "
"instrument to find detectors whose efficiencies have changed "
"beyond a threshold.";
}
const std::string category() const override;
/// Algorithm's version for identification overriding a virtual method
int version() const override { return (1); }
protected:
// Overridden Algorithm methods
void init() override;
void exec() override;
/// Loads and checks the values passed to the algorithm
void retrieveProperties(API::MatrixWorkspace_sptr &whiteBeam1,
API::MatrixWorkspace_sptr &whiteBeam2,
double &variation, int &minSpec, int &maxSpec);
/// Apply the detector test criterion
int doDetectorTests(API::MatrixWorkspace_const_sptr counts1,
API::MatrixWorkspace_const_sptr counts2,
const double average, double variation);
private:
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHM_DETECTOREFFICIENCYVARIATION_H_*/