/
ReflectometryReductionOne.h
119 lines (95 loc) · 4.6 KB
/
ReflectometryReductionOne.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
#ifndef MANTID_ALGORITHMS_REFLECTOMETRYREDUCTIONONE_H_
#define MANTID_ALGORITHMS_REFLECTOMETRYREDUCTIONONE_H_
#include "MantidKernel/System.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidGeometry/Instrument.h"
#include "MantidGeometry/IComponent.h"
#include "MantidGeometry/IDetector.h"
#include "MantidAlgorithms/ReflectometryWorkflowBase.h"
namespace Mantid {
namespace Algorithms {
/** ReflectometryReductionOne : Reflectometry reduction of a single input TOF
workspace to an IvsQ workspace.
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 ReflectometryReductionOne : public ReflectometryWorkflowBase {
public:
/// Constructor
ReflectometryReductionOne();
/// Destructor
~ReflectometryReductionOne() override;
const std::string name() const override;
/// Summary of algorithms purpose
const std::string summary() const override {
return "Reduces a single TOF/Lambda reflectometry run into a mod Q vs I/I0 "
"workspace. Performs transmission corrections.";
}
int version() const override;
const std::string category() const override;
/// Convert to an IvsQ workspace. Performs detector positional corrections
/// based on the component name and the theta value.
Mantid::API::MatrixWorkspace_sptr toIvsQ(API::MatrixWorkspace_sptr &toConvert,
const bool bCorrectPosition,
OptionalDouble &thetaInDeg,
const bool isPointDetector);
private:
/** Overridden Algorithm methods **/
void init() override;
void exec() override;
/// Get the surface sample component
Mantid::Geometry::IComponent_const_sptr
getSurfaceSampleComponent(Mantid::Geometry::Instrument_const_sptr inst);
/// Get the detector component
Mantid::Geometry::IComponent_const_sptr
getDetectorComponent(Mantid::Geometry::Instrument_const_sptr inst,
const bool isPointDetector);
/// Correct detector positions.
API::MatrixWorkspace_sptr
correctPosition(API::MatrixWorkspace_sptr &toCorrect,
const double &thetaInDeg, const bool isPointDetector);
/// Sum spectra.
Mantid::API::MatrixWorkspace_sptr
sumSpectraOverRange(API::MatrixWorkspace_sptr inWS, const int startIndex,
const int endIndex);
/// Perform a transmission correction on the input IvsLam workspace
API::MatrixWorkspace_sptr transmissonCorrection(
API::MatrixWorkspace_sptr IvsLam, const MinMax &wavelengthInterval,
const MinMax &wavelengthMonitorBackgroundInterval,
const MinMax &wavelengthMonitorIntegrationInterval,
const int &i0MonitorIndex, API::MatrixWorkspace_sptr firstTransmissionRun,
OptionalMatrixWorkspace_sptr secondTransmissionRun,
const OptionalDouble &stitchingStart,
const OptionalDouble &stitchingDelta, const OptionalDouble &stitchingEnd,
const OptionalDouble &stitchingStartOverlap,
const OptionalDouble &stitchingEndOverlap, const double &wavelengthStep,
const std::string &numeratorProcessingCommands);
/// Perform transmission correction using either PolynomialCorrection
/// or ExponentialCorrection.
API::MatrixWorkspace_sptr
algorithmicCorrection(API::MatrixWorkspace_sptr IvsLam);
/// Verify spectrum maps
void verifySpectrumMaps(API::MatrixWorkspace_const_sptr ws1,
API::MatrixWorkspace_const_sptr ws2,
const bool severe = false);
/// returns angle for source rotation
double getAngleForSourceRotation(API::MatrixWorkspace_sptr toConvert,
double thetaOut);
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_REFLECTOMETRYREDUCTIONONE_H_ */