/
RemoveBins.h
103 lines (86 loc) · 3.86 KB
/
RemoveBins.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
#ifndef MANTID_ALGORITHMS_REMOVEBINS_H_
#define MANTID_ALGORITHMS_REMOVEBINS_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidKernel/cow_ptr.h"
#include "MantidKernel/Unit.h"
namespace Mantid {
namespace Algorithms {
/** Removes bins from a workspace.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the
result </LI>
<LI> XMin - The value to start removing from..</LI>
<LI> XMax - The time bin to end removing from.</LI>
<LI> RangeUnit - The unit in which the above range is given.</LI>
<LI> Interpolation - The type of interpolation to use for removed bins.
</LI>
</UL>
Optional Property:
<UL>
<LI> WorkspaceIndex - The spectrum to remove bins from. Will operate on all
spectra if absent. </LI>
</UL>
@author Matt Clarke
@date 08/12/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 RemoveBins : public API::Algorithm {
public:
/// Default constructor
RemoveBins();
/// Destructor
~RemoveBins() override{};
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "RemoveBins"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Used to remove data from a range of bins in a workspace.";
}
/// 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 "Transforms\\Splitting";
}
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
void checkProperties();
void crop(const double &start, const double &end);
void transformRangeUnit(const int &index, double &startX, double &endX);
void calculateDetectorPosition(const int &index, double &l1, double &l2,
double &twoTheta);
int findIndex(const double &value, const MantidVec &vec);
void RemoveFromEnds(int start, int end, MantidVec &Y, MantidVec &E);
void RemoveFromMiddle(const int &start, const int &end,
const double &startFrac, const double &endFrac,
MantidVec &Y, MantidVec &E);
API::MatrixWorkspace_const_sptr m_inputWorkspace; ///< The input workspace
double m_startX; ///< The range start point
double m_endX; ///< The range end point
Kernel::Unit_sptr m_rangeUnit; ///< The unit in which the above range is given
bool m_interpolate; ///< Whether removed bins should be interpolated
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHM_REMOVEBINS_H_*/