-
Notifications
You must be signed in to change notification settings - Fork 122
/
GroupDetectors.h
88 lines (72 loc) · 3.32 KB
/
GroupDetectors.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
#ifndef MANTID_DATAHANDLING_GROUPDETECTORS_H_
#define MANTID_DATAHANDLING_GROUPDETECTORS_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace DataHandling {
/** An algorithm for grouping detectors and the spectra associated with them
into a single DetectorGroup and spectrum.
This algorithm can only be used on a workspace that has common X bins.
Required Properties:
<UL>
<LI> Workspace - The name of the (input & output) Workspace2D on which to
perform the algorithm </LI>
</UL>
Optional Properties (Only one of these should be set. Priority to highest
listed below if more than one is set.):
<UL>
<LI> SpectraList - An ArrayProperty containing a list of spectra to combine
</LI>
<LI> DetectorList - An ArrayProperty containing a list of detector IDs to
combine </LI>
<LI> WorkspaceIndexList - An ArrayProperty containing the workspace indices
to combine </LI>
</UL>
Output Properties:
<UL>
<LI> ResultIndex - The workspace index containing the grouped spectra </LI>
</UL>
@author Russell Taylor, Tessella Support Services plc
@date 17/04/2008
Copyright © 2008-9 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 GroupDetectors : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "GroupDetectors"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Sums spectra bin-by-bin, equivalent to grouping the data from a "
"set of detectors. Individual groups can be specified by passing "
"the algorithm a list of spectrum numbers, detector IDs or "
"workspace indices. Many spectra groups can be created in one "
"execution via an input file.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; };
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Transforms\\Grouping"; }
private:
// Implement abstract Algorithm methods
void init() override;
void exec() override;
};
} // namespace DataHandling
} // namespace Mantid
#endif /*MANTID_DATAHANDLING_GROUPDETECTORS_H_*/