-
Notifications
You must be signed in to change notification settings - Fork 122
/
SumSpectra.h
118 lines (99 loc) · 4.52 KB
/
SumSpectra.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#ifndef MANTID_ALGORITHMS_SUMSPECTRA_H_
#define MANTID_ALGORITHMS_SUMSPECTRA_H_
#include "MantidAPI/ParallelAlgorithm.h"
#include "MantidGeometry/IDTypes.h"
#include <set>
namespace Mantid {
namespace Algorithms {
/** Takes a workspace as input and sums all of the spectra within it maintaining
the existing bin structure and units.
The result is stored as a new workspace containing a single spectra.
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
result </LI>
</UL>
Optional Properties (assume that you count from zero):
<UL>
<LI> StartSpectrum - Workspace index number to integrate from (default
0)</LI>
<LI> EndSpectrum - Workspace index number to integrate to (default max)</LI>
<LI> IncludeMonitors - Whether to include monitor spectra in the sum
(default yes)
</UL>
@author Nick Draper, Tessella Support Services plc
@date 22/01/2009
Copyright © 2007-2016 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 SumSpectra : public API::ParallelAlgorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "SumSpectra"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "The SumSpectra algorithm adds the data values in each time bin "
"across a range of spectra; the output workspace has a single "
"spectrum. If the input is an EventWorkspace, the output is also an "
"EventWorkspace; otherwise it will be a Workspace2D.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override {
return {"SumNeighbours"};
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Transforms\\Grouping"; }
/// Cross-input validation
std::map<std::string, std::string> validateInputs() override;
private:
/// Handle logic for RebinnedOutput workspaces
void doFractionalSum(API::MatrixWorkspace_sptr outputWorkspace,
API::Progress &progress, size_t &numSpectra,
size_t &numMasked, size_t &numZeros);
/// Handle logic for Workspace2D workspaces
void doSimpleSum(API::MatrixWorkspace_sptr outputWorkspace,
API::Progress &progress, size_t &numSpectra,
size_t &numMasked, size_t &numZeros);
// Overridden Algorithm methods
void init() override;
void exec() override;
void execEvent(API::MatrixWorkspace_sptr outputWorkspace,
API::Progress &progress, size_t &numSpectra, size_t &numMasked,
size_t &numZeros);
specnum_t getOutputSpecNo(API::MatrixWorkspace_const_sptr localworkspace);
API::MatrixWorkspace_sptr replaceSpecialValues();
void determineIndices(const size_t numberOfSpectra);
/// The output spectrum number
specnum_t m_outSpecNum{0};
/// Set true to keep monitors
bool m_keepMonitors{false};
/// Set true to remove special values before processing
bool m_replaceSpecialValues{false};
/// numberOfSpectra in the input
size_t m_numberOfSpectra{0};
/// Blocksize of the input workspace
size_t m_yLength{0};
/// Set of indices to sum
std::set<size_t> m_indices;
// if calculating additional workspace with specially weighted averages is
// necessary
bool m_calculateWeightedSum{false};
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_SUMSPECTRA_H_*/