-
Notifications
You must be signed in to change notification settings - Fork 122
/
CombinePeaksWorkspaces.h
56 lines (44 loc) · 1.92 KB
/
CombinePeaksWorkspaces.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
#ifndef MANTID_CRYSTAL_COMBINEPEAKSWORKSPACES_H_
#define MANTID_CRYSTAL_COMBINEPEAKSWORKSPACES_H_
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Crystal {
/** An algorithm that combines the sets of peaks in two peaks workspaces.
Optionally, peaks considered 'identical' are combined. Such peaks are those
that are within
the given tolerance in all components of Q. The peak from the first/left
workspace is kept.
Note that it is possible for multiple peaks in the rhs to be matched to a
given lhs peak if
the tolerance is too large/the peaks are close together.
Copyright © 2012 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/>.
*/
class DLLExport CombinePeaksWorkspaces : public API::Algorithm {
public:
const std::string name() const override;
/// Summary of algorithms purpose
const std::string summary() const override {
return "Combines the sets of peaks in two peaks workspaces, optionally "
"omitting duplicates.";
}
int version() const override;
const std::string category() const override;
private:
void init() override;
void exec() override;
};
} // namespace Crystal
} // namespace Mantid
#endif /* MANTID_CRYSTAL_COMBINEPEAKSWORKSPACES_H_ */