-
Notifications
You must be signed in to change notification settings - Fork 122
/
TabulatedFunction.h
124 lines (90 loc) · 4.13 KB
/
TabulatedFunction.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
#ifndef MANTID_CURVEFITTING_TABULATEDFUNCTION_H_
#define MANTID_CURVEFITTING_TABULATEDFUNCTION_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/ParamFunction.h"
#include "MantidAPI/IFunction1D.h"
#include "MantidKernel/System.h"
#include <cmath>
namespace Mantid
{
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
namespace API
{
class MatrixWorkspace;
}
namespace CurveFitting
{
/**
A function which takes its values from a file or a workspace. The values atr tabulated as
x,y pairs. Liear interpolation is used for points between the tabulated values. The function
returns zero for points outside the tabulated values.
The function has two attributes: FileName and Workspace. They define a data set to take the values from.
Setting one of the attributes clears the other.
The files can be either ascii text files or nexus files. The ascii files must contain two column
of real numbers separated by spaces. The first column are the x-values and the second one is for y.
If a nexus file is used its first spectrum provides the data for the function. The same is true for
a workspace which must be a MatrixWorkspace.
The function has two parameters - a scaling factor "Scaling" and a shift factor along the abscissas 'Shift'
@author Roman Tolchenov, Tessella plc
@date 4/09/2012
Copyright © 2007-8 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
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 TabulatedFunction : public API::ParamFunction, public API::IFunction1D
{
public:
/// Constructor
TabulatedFunction();
/// overwrite IFunction base class methods
std::string name()const{return "TabulatedFunction";}
virtual const std::string category() const { return "General";}
void function1D(double* out, const double* xValues, const size_t nData)const;
/// function derivatives
void functionDeriv1D(API::Jacobian* out, const double* xValues, const size_t nData);
/// Set a value to attribute attName
void setAttribute(const std::string& attName,const IFunction::Attribute& value);
private:
/// Call the appropriate load function
void load(const std::string& fname);
/// Load the points from a MatrixWorkspace
void loadWorkspace(const std::string& wsName) const;
/// Load the points from a MatrixWorkspace
void loadWorkspace(boost::shared_ptr<API::MatrixWorkspace> ws) const;
/// Size of the data
size_t size()const{return m_yData.size();}
/// Clear all data
void clear() const;
/// Evaluate the function for a list of arguments and given scaling factor
void eval(double scaling, double shift, double* out, const double* xValues, const size_t nData)const;
/// Fill in the x and y value containers (m_xData and m_yData)
void setupData() const;
/// The default value for the workspace index
static const int defaultIndexValue;
/// Temporary workspace holder
mutable boost::shared_ptr<API::MatrixWorkspace> m_workspace;
/// Stores x-values
mutable std::vector<double> m_xData;
/// Stores y-values
mutable std::vector<double> m_yData;
/// Flag of completing data setup
mutable bool m_setupFinished;
};
} // namespace CurveFitting
} // namespace Mantid
#endif /*MANTID_CURVEFITTING_TABULATEDFUNCTION_H_*/