/
RadiusSum.h
127 lines (97 loc) · 3.91 KB
/
RadiusSum.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
119
120
121
122
123
124
125
126
127
#ifndef MANTID_ALGORITHMS_RADIUSSUM_H_
#define MANTID_ALGORITHMS_RADIUSSUM_H_
#include "MantidKernel/System.h"
#include "MantidKernel/V3D.h"
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** RadiusSum :
Sum of all the counts inside a ring against the scattering angle for each
Radius.
@author Gesner Passos, ISIS
Copyright © 2013 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 RadiusSum : public API::Algorithm {
public:
RadiusSum();
~RadiusSum() override;
const std::string name() const override;
/// Summary of algorithms purpose
const std::string summary() const override {
return "Sum of all the counts inside a ring against the scattering angle "
"for each Radius.";
}
int version() const override;
const std::string category() const override;
static bool inputWorkspaceHasInstrumentAssociated(API::MatrixWorkspace_sptr);
static std::vector<double>
getBoundariesOfNumericImage(API::MatrixWorkspace_sptr);
static std::vector<double>
getBoundariesOfInstrument(API::MatrixWorkspace_sptr);
static void centerIsInsideLimits(const std::vector<double> ¢re,
const std::vector<double> &boundaries);
private:
void init() override;
void exec() override;
std::vector<double> processInstrumentRadiusSum();
std::vector<double> processNumericImageRadiusSum();
void cacheInputPropertyValues();
void inputValidationSanityCheck();
void numBinsIsReasonable();
std::vector<double> getBoundariesOfInputWorkspace();
double getMaxDistance(const Kernel::V3D ¢re,
const std::vector<double> &boundary_limits);
void setUpOutputWorkspace(std::vector<double> &values);
int getBinForPixelPos(const Kernel::V3D &pos);
Kernel::V3D centre;
int num_bins;
API::MatrixWorkspace_sptr inputWS;
double min_radius, max_radius;
double getMinBinSizeForInstrument(API::MatrixWorkspace_sptr);
double getMinBinSizeForNumericImage(API::MatrixWorkspace_sptr);
/** Return the bin position for a given distance
* From the input, it is defined the limits of distances as:
* Dominium => [min_radius, max_radius]
*
* Besides, it is defined that this dominium is splited in num_bins.
*
* Hence, each bin will follow this rule:
*
* Bins(n) = [min_radius + n bin_size, min_radius + (n+1) bin_size[
*
* for bin_size = (max_radius - min_radius ) / num_bins
*
* For a distance given as x, its position (n) is such as:
*
* min_radius + n bin_size < x < min_radius + (n+1) bin_size
*
* n < (x - min_radius)/bin_size < n+1
*
* Hence, n = truncate ( (x- min_radius)/bin_size)
*
* @note Made inline for performance
* return bin position.
*/
int fromDistanceToBin(double distance) {
return static_cast<int>(((distance - min_radius) * num_bins) /
(max_radius - min_radius));
}
void normalizeOutputByRadius(std::vector<double> &values, double exp_power);
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_RADIUSSUM_H_ */