Mantid
Loading...
Searching...
No Matches
DiffPeaksWorkspaces.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2012 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidCrystal/DllConfig.h"
11
12namespace Mantid {
13namespace Crystal {
22class MANTID_CRYSTAL_DLL DiffPeaksWorkspaces final : public API::Algorithm {
23public:
24 const std::string name() const override;
26 const std::string summary() const override {
27 return "Removes from a workspace any peaks that match a peak in a second "
28 "workspace.";
29 }
30
31 int version() const override;
32 const std::vector<std::string> seeAlso() const override { return {"CreatePeaksWorkspace", "CombinePeaksWorkspaces"}; }
33 const std::string category() const override;
34
35private:
36 void init() override;
37 void exec() override;
38};
39
40} // namespace Crystal
41} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
An algorithm that subtracts from a workspace (the LHSWorkspace) any peaks that match entries in a sec...
const std::string summary() const override
Summary of algorithms purpose.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
Helper class which provides the Collimation Length for SANS instruments.