-
Notifications
You must be signed in to change notification settings - Fork 122
/
CombinePeaksWorkspaces.h
45 lines (39 loc) · 1.46 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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/Algorithm.h"
#include "MantidCrystal/DllConfig.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.
*/
class MANTID_CRYSTAL_DLL 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::vector<std::string> seeAlso() const override {
return {"CreatePeaksWorkspace"};
}
const std::string category() const override;
private:
void init() override;
void exec() override;
};
} // namespace Crystal
} // namespace Mantid