/
SumRowColumn.h
94 lines (78 loc) · 3.36 KB
/
SumRowColumn.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
#ifndef MANTID_ALGORITHMS_SUMROWCOLUMN_H_
#define MANTID_ALGORITHMS_SUMROWCOLUMN_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** This algorithm is the equivalent of the COLETTE "DISPLAY H/V" command.
It firsts integrates the input workspace, which must contain all the spectra
from
the detector of interest - no more and no less (so 128x128 or 192x192),
between the X values given. Then each row or column is summed between the
HOverVMin/Max
values, if given, and the result is a single spectrum of row or column
number against
total counts.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the input workspace. </LI>
<LI> OutputWorkspace - The name of the output workspace. </LI>
<LI> Orientation - Whether to sum rows (D_H) or columns (D_V) </LI>
</UL>
Optional properties:
<UL>
<LI> XMin - The starting X value for each spectrum to include in the
summation (default min). </LI>
<LI> XMax - The ending X value for each spectrum to include in the summation
(default max). </LI>
<LI> HOverVMin - The first row to include when summing by columns, or vice
versa (default all). </LI>
<LI> HOverVmax - The last row to include when summing by columns, or vice
versa (default all). </LI>
</UL>
@author Russell Taylor, Tessella plc
@date 22/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 SumRowColumn : public API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override { return "SumRowColumn"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "SANS-specific algorithm which gives a single spectrum containing "
"the total counts in either each row or each column of pixels in a "
"square LOQ or SANS2D detector bank.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override {
return "SANS;Transforms\\Grouping";
}
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
API::MatrixWorkspace_sptr integrateWorkspace();
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_SUMROWCOLUMN_H_*/