-
Notifications
You must be signed in to change notification settings - Fork 122
/
Integration.h
75 lines (66 loc) · 3.07 KB
/
Integration.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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
namespace Mantid {
namespace Algorithms {
/** Takes a workspace as input and sums each spectrum contained within
it, storing the result as a workspace of spectra with one Y & E value
and two X values indicating the range which the integration covers.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the workspace to take as input. Must be a
histogram. </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> Range_lower - The X value to integrate from (default 0)</LI>
<LI> Range_upper - The X value to integrate to (default max)</LI>
<LI> StartWorkspaceIndex - Workspace index number to integrate from (default
0)</LI>
<LI> EndWorkspaceIndex - Workspace index number to integrate to (default
max)</LI>
<LI> IncludePartialBins - If true then partial bins from the beginning and
end of the input range are also included in the integration (default
false)</LI>
</UL>
*/
class MANTID_ALGORITHMS_DLL Integration : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "Integration"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Integration takes a 2D workspace or an EventWorkspace as input and "
"sums the data values. Optionally, the range summed can be "
"restricted in either dimension.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override { return {"IntegrateByComponent", "Rebin"}; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Arithmetic;Transforms\\Rebin"; }
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
API::MatrixWorkspace_sptr rangeFilterEventWorkspace(const API::MatrixWorkspace_sptr &workspace, double minRange,
double maxRange);
/// Get the input workspace
API::MatrixWorkspace_sptr getInputWorkspace();
/// Create the outputworkspace
API::MatrixWorkspace_sptr getOutputWorkspace(API::MatrixWorkspace_sptr inWS, const int minSpec, const int maxSpec);
std::map<std::string, std::string> validateInputs() override;
};
} // namespace Algorithms
} // namespace Mantid