/
IQTransform.h
114 lines (93 loc) · 3.99 KB
/
IQTransform.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
#ifndef MANTID_ALGORITHMS_IQTRANSFORM_H_
#define MANTID_ALGORITHMS_IQTRANSFORM_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidKernel/cow_ptr.h"
namespace Mantid {
namespace Kernel {
namespace Units {
class Label;
}
}
namespace Algorithms {
/** This algorithm permits the linearisation of reduced SANS data by applying a
chosen transformation
to the input data. Optionally, a background can be subtracted from the data
prior to transformation.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the input workspace, which must be a
distribution in units of Q.</LI>
<LI> OutputWorkspace - The name of the output workspace.</LI>
<LI> TransformType - The name of the transformation to be performed on the
input workspace.</LI>
</UL>
Optional Properties:
<UL>
<LI> BackgroundValue - A constant value to be subtracted from the input
workspace before transformation.</LI>
<LI> BackgroundWorkspace - A workspace to subtract from the input workspace
before transformation.</LI>
<LI> GeneralFunctionConstants - For the 'General' transformation, the 10
constants to be used.</LI>
</UL>
@author Russell Taylor, Tessella
@date 03/02/2011
Copyright © 2011 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 IQTransform : public API::Algorithm {
public:
IQTransform();
~IQTransform() override;
const std::string name() const override { return "IQTransform"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "This algorithm provides various functions that are sometimes used "
"to linearise the output of a 'SANS' data reduction prior to "
"fitting it.";
}
int version() const override { return (1); }
const std::string category() const override { return "SANS"; }
private:
void init() override;
void exec() override;
inline void subtractBackgroundValue(MantidVec &Y, const double value);
inline API::MatrixWorkspace_sptr
subtractBackgroundWS(API::MatrixWorkspace_sptr ws,
API::MatrixWorkspace_sptr background);
typedef void (IQTransform::*TransformFunc)(API::MatrixWorkspace_sptr);
typedef std::map<std::string, TransformFunc> TransformMap;
TransformMap
m_transforms; ///< A map of transformation name and function pointers
boost::shared_ptr<Kernel::Units::Label> m_label;
// A function for each transformation
void guinierSpheres(API::MatrixWorkspace_sptr ws);
void guinierRods(API::MatrixWorkspace_sptr ws);
void guinierSheets(API::MatrixWorkspace_sptr ws);
void zimm(API::MatrixWorkspace_sptr ws);
void debyeBueche(API::MatrixWorkspace_sptr ws);
void kratky(API::MatrixWorkspace_sptr ws);
void porod(API::MatrixWorkspace_sptr ws);
void holtzer(API::MatrixWorkspace_sptr ws);
void logLog(API::MatrixWorkspace_sptr ws);
void general(API::MatrixWorkspace_sptr ws);
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_IQTRANSFORM_H_*/