/
ConvertToPointData.h
71 lines (58 loc) · 2.69 KB
/
ConvertToPointData.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
#ifndef MANTID_ALGORITHMS_CONVERTTOPOINTDATA_H_
#define MANTID_ALGORITHMS_CONVERTTOPOINTDATA_H_
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "MantidAlgorithms/XDataConverter.h"
namespace Mantid {
namespace Algorithms {
/**
Converts a histogram workspace to point data by simply taking the centre point
of the bin
as the new point on the X axis
@author Martyn Gigg, Tessella plc
@date 2010-12-14
Copyright © 2010 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 ConvertToPointData : public XDataConverter {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "ConvertToPointData"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Converts a workspace containing histogram data into one containing "
"point data.";
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Transforms\\Axes"; }
private:
/// Returns true if the algorithm needs to be run.
bool
isProcessingRequired(const API::MatrixWorkspace_sptr inputWS) const override;
/// Checks the input workspace is consistent, throwing if not
bool
isWorkspaceLogical(const API::MatrixWorkspace_sptr inputWS) const override;
/// Returns the size of the new X vector
std::size_t
getNewXSize(const API::MatrixWorkspace_sptr inputWS) const override;
/// Calculate the X point values. Implement in an inheriting class.
void calculateXPoints(const MantidVec &inputX,
MantidVec &outputX) const override;
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_CONVERTTOPOINTDATA_H_*/