/
FilterBadPulses.h
77 lines (59 loc) · 2.52 KB
/
FilterBadPulses.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
#ifndef MANTID_ALGORITHMS_FILTERBADPULSES_H_
#define MANTID_ALGORITHMS_FILTERBADPULSES_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"
#include "MantidDataObjects/EventWorkspace.h"
namespace Mantid {
namespace Algorithms {
/** Filters out events associated with pulses that happen when proton charge is
lower than a given percentage of the average.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace whose detectors are to be
aligned </LI>
<LI> OutputWorkspace - The name of the Workspace in which the result of the
algorithm will be stored </LI>
<LI> LowerCutoff - The percentage of the average to use as the lower bound
</LI>
</UL>
@author Peter Peterson, ORNL
@date 21/12/10
Copyright © 2008 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 FilterBadPulses : public API::Algorithm {
public:
FilterBadPulses();
~FilterBadPulses() override;
const std::string name() const override;
/// Summary of algorithms purpose
const std::string summary() const override {
return "Filters out events associated with pulses that happen when proton "
"charge is lower than a given percentage of the average.";
}
int version() const override;
const std::string category() const override;
private:
// Implement abstract Algorithm methods
void init() override;
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_FILTERBADPULSES_H_ */