-
Notifications
You must be signed in to change notification settings - Fork 122
/
RingProfile.h
99 lines (83 loc) · 3.52 KB
/
RingProfile.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
#ifndef MANTID_ALGORITHMS_RINGPROFILE_H_
#define MANTID_ALGORITHMS_RINGPROFILE_H_
#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"
#include "MantidGeometry/IDetector.h"
#include "MantidAPI/ISpectrum.h"
#include <vector>
namespace Mantid {
namespace Algorithms {
/**
Calculates the sum of the counts against a circular ring.
@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 RingProfile : public API::Algorithm {
public:
RingProfile();
const std::string name() const override { return "RingProfile"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Calculates the sum of the counts against a circular ring.";
}
int version() const override { return 1; };
const std::string category() const override {
return "Transforms\\Grouping";
};
protected:
boost::shared_ptr<API::Progress> m_progress;
private:
void init() override;
void exec() override;
/// get the bin position for the given angle
int fromAngleToBin(double angle, bool degree = true);
/// validate the inputs of the algorithm for instrument based workspace
void checkInputsForSpectraWorkspace(const API::MatrixWorkspace_sptr);
/// validate the inputs of the algorithm for 2d matrix based instrument
void checkInputsForNumericWorkspace(const API::MatrixWorkspace_sptr);
/// process ring profile for instrument based workspace
void processInstrumentRingProfile(const API::MatrixWorkspace_sptr inputWS,
std::vector<double> &output_bins);
/// process ring profile for image based workspace
void processNumericImageRingProfile(const API::MatrixWorkspace_sptr inputWS,
std::vector<double> &output_bins);
/// identify the bin position for the given pixel in the image based workspace
void getBinForPixel(const API::MatrixWorkspace_sptr, int, std::vector<int> &);
//// identify the bin position for the pixel related to the given detector
int getBinForPixel(const Kernel::V3D &position);
/// copy of the minRadius input
double min_radius;
/// copy of the maxRadius input
double max_radius;
/// copy of the StartAngle input
double start_angle;
/// flag that indicate if Sense input was configure to clockwise
bool clockwise;
/// copy of NumBins input
int num_bins;
/// copy of centre for axis(0)
double centre_x;
/// copy of centre for axis(1)
double centre_y;
/// copy of centre for axis(2)
double centre_z;
/// The size of the bins in angle that is equal to 360 / NumBins
double bin_size;
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_RINGPROFILE_H_ */