-
Notifications
You must be signed in to change notification settings - Fork 122
/
Rebunch.h
102 lines (86 loc) · 3.92 KB
/
Rebunch.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
#ifndef MANTID_ALGORITHM_REBUNCH_H_
#define MANTID_ALGORITHM_REBUNCH_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace HistogramData {
class HistogramX;
class HistogramY;
class HistogramE;
}
namespace Algorithms {
/**
Takes a workspace as input and rebunches the data according to the input rebunch
parameters.
The process is exactly that defined by the mgenie code of T. G. Perring for
both point and histogram data,
in that the the distribution flag is ignored for point data, and the
contributing point data points are averaged.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace to take as input </LI>
<LI> n_bunch - number of data points to bunch together for each new point, must
be >= 1 </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the result
</LI>
</UL>
@author Dickon Champion, STFC
@date 24/06/2008
Copyright © 2007 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 Rebunch : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "Rebunch"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Rebins data by adding together 'n_bunch' successive bins.";
}
/// 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\\Rebin"; }
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
void rebunch_hist_counts(const HistogramData::HistogramX &xold,
const HistogramData::HistogramY &yold,
const HistogramData::HistogramE &eold,
HistogramData::HistogramX &xnew,
HistogramData::HistogramY &ynew,
HistogramData::HistogramE &enew,
const size_t n_bunch);
void rebunch_hist_frequencies(const HistogramData::HistogramX &xold,
const HistogramData::HistogramY &yold,
const HistogramData::HistogramE &eold,
HistogramData::HistogramX &xnew,
HistogramData::HistogramY &ynew,
HistogramData::HistogramE &enew,
const size_t n_bunch);
void rebunch_point(const HistogramData::HistogramX &xold,
const HistogramData::HistogramY &yold,
const HistogramData::HistogramE &eold,
HistogramData::HistogramX &xnew,
HistogramData::HistogramY &ynew,
HistogramData::HistogramE &enew, const size_t n_bunch);
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHM_REBUNCH_H_*/