/
Rebin2D.h
74 lines (58 loc) · 2.45 KB
/
Rebin2D.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
#ifndef MANTID_ALGORITHMS_REBIN2D_H_
#define MANTID_ALGORITHMS_REBIN2D_H_
//------------------------------------------------------------------------------
// Includes
//------------------------------------------------------------------------------
#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"
#include "MantidDataObjects/RebinnedOutput.h"
namespace Mantid {
namespace Algorithms {
/**
Rebins both axes of a two-dimensional workspace to the given parameters.
@author Martyn Gigg, Tessella plc
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 Rebin2D : public API::Algorithm {
public:
/// Algorithm's name for identification
const std::string name() const override { return "Rebin2D"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Rebins both axes of a 2D workspace using the given parameters";
}
/// Algorithm's version for identification
int version() const override { return 1; }
/// Algorithm's category for identification
const std::string category() const override { return "Transforms\\Rebin"; }
protected:
/// Progress reporter
boost::shared_ptr<API::Progress> m_progress;
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
/// Setup the output workspace
API::MatrixWorkspace_sptr
createOutputWorkspace(API::MatrixWorkspace_const_sptr parent,
MantidVec &newXBins, MantidVec &newYBins,
const bool useFractionalArea) const;
};
} // namespace Algorithms
} // namespace Mantid
#endif /* MANTID_ALGORITHMS_REBIN2D_H_ */