-
Notifications
You must be signed in to change notification settings - Fork 121
/
UnwrapMonitor.h
99 lines (84 loc) · 4.05 KB
/
UnwrapMonitor.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_UNWRAPMONITOR_H_
#define MANTID_ALGORITHMS_UNWRAPMONITOR_H_
#include "MantidAPI/Algorithm.h"
#include "MantidKernel/cow_ptr.h"
#include "MantidHistogramData/HistogramX.h"
namespace Mantid {
namespace Algorithms {
/** Takes an input Workspace2D that contains 'raw' data, unwraps the data
according to
the reference flightpath provided and converts the units to wavelength.
The output workspace will have common bins in the maximum theoretical
wavelength range.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the input workspace. </LI>
<LI> OutputWorkspace - The name of the output workspace. </LI>
<LI> LRef - The 'reference' flightpath (in metres). </LI>
</UL>
@author Russell Taylor, Tessella Support Services plc
@date 25/07/2008
Copyright © 2008-9 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 UnwrapMonitor : public API::Algorithm {
public:
UnwrapMonitor();
~UnwrapMonitor() override;
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "UnwrapMonitor"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Takes an input workspace that contains 'raw' data, unwraps the "
"data "
"according to the reference flightpath provided and converts the "
"units to wavelength."
"The output workspace will have common bins in the maximum "
"theoretical wavelength range.";
}
/// 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 "CorrectionFunctions\\InstrumentCorrections";
}
private:
void init() override;
void exec() override;
const std::vector<int> unwrapX(std::vector<double> &newX, const int &spectrum,
const double &Ld);
std::pair<int, int>
handleFrameOverlapped(const Mantid::HistogramData::HistogramX &xdata,
const double &Ld, std::vector<double> &tempX);
void unwrapYandE(const API::MatrixWorkspace_sptr &tempWS, const int &spectrum,
const std::vector<int> &rangeBounds,
std::vector<double> &newY, std::vector<double> &newE);
API::MatrixWorkspace_sptr rebin(const API::MatrixWorkspace_sptr &workspace,
const double &min, const double &max,
const size_t &numBins);
double m_conversionConstant; ///< The constant used in the conversion from TOF
/// to wavelength
API::MatrixWorkspace_const_sptr m_inputWS; ///< Pointer to the input workspace
double m_LRef; ///< The 'reference' flightpath
double m_Tmin; ///< The start of the time-of-flight frame
double m_Tmax; ///< The end of the time-of-flight frame
size_t m_XSize; ///< The size of the X vectors in the input workspace
/// Progress reporting
API::Progress *m_progress;
};
} // namespace Algorithm
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_UNWRAPMONITOR_H_ */