-
Notifications
You must be signed in to change notification settings - Fork 122
/
CreateUserDefinedBackground.h
87 lines (76 loc) · 3.49 KB
/
CreateUserDefinedBackground.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
#ifndef MANTID_ALGORITHMS_CREATEUSERDEFINEDBACKGROUND_H_
#define MANTID_ALGORITHMS_CREATEUSERDEFINEDBACKGROUND_H_
#include "MantidAlgorithms/DllConfig.h"
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidHistogramData/Histogram.h"
namespace Mantid {
namespace Kernel {
class Interpolation;
}
namespace Algorithms {
/** CreateUserDefinedBackground : Given an input workspace containing data with
a background and a table of user-selected points defining the background,
creates a new workspace containing background data that can be subtracted
from the original data.
Copyright © 2016 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 MANTID_ALGORITHMS_DLL CreateUserDefinedBackground
: public API::Algorithm {
public:
/// Return name of algorithm
const std::string name() const override;
/// Version number
int version() const override;
/// Category algorithm belongs to
const std::string category() const override;
/// Description of algorithm
const std::string summary() const override;
private:
/// Declare properties and initialise algorithm
void init() override;
/// Execute algorithm
void exec() override;
/// Verify input properties and return errors
std::map<std::string, std::string> validateInputs() override;
/// Sort table and remove blank rows
void cleanUpTable(API::ITableWorkspace_sptr &table) const;
/// Extend background to cover range of data
void
extendBackgroundToData(API::ITableWorkspace_sptr &background,
const API::MatrixWorkspace_const_sptr &data) const;
/// Create new background workspace with data interpolated from table
API::MatrixWorkspace_sptr
createBackgroundWorkspace(const API::ITableWorkspace_const_sptr &background,
const API::MatrixWorkspace_const_sptr &data) const;
/// Set up and return an interpolator object ready for use
Kernel::Interpolation
getInterpolator(const API::ITableWorkspace_const_sptr &background,
const API::MatrixWorkspace_const_sptr &workspace) const;
/// Get Y storage mode for background data
HistogramData::Histogram::YMode
getBackgroundYMode(const API::MatrixWorkspace_const_sptr &data,
std::vector<double> &yBackground) const;
/// Multiply y data by bin width
void multiplyByBinWidth(const API::MatrixWorkspace_const_sptr &data,
std::vector<double> &yBackground) const;
/// Key name for "normalize histogram to bin width" option on plots
static const std::string AUTODISTRIBUTIONKEY;
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_CREATEUSERDEFINEDBACKGROUND_H_ */