Mantid
Loading...
Searching...
No Matches
BinaryOperateMasks.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 "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
14
17class MANTID_ALGORITHMS_DLL BinaryOperateMasks final : public API::Algorithm {
18public:
20 ~BinaryOperateMasks() override;
21
23 const std::string name() const override { return "BinaryOperateMasks"; };
25 const std::string summary() const override {
26 return "Performs binary operation, including and, or and xor, on two mask "
27 "Workspaces, i.e., SpecialWorkspace2D.";
28 }
29
31 int version() const override { return 1; };
32 const std::vector<std::string> seeAlso() const override { return {"InvertMask"}; }
34 const std::string category() const override { return "Transforms\\Masking"; }
35
36private:
38 void init() override;
40 void exec() override;
41};
42
43} // namespace Algorithms
44} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
BinaryOperateMasks : TODO: DESCRIPTION.
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
int version() const override
Algorithm's version for identification overriding a virtual method.
Helper class which provides the Collimation Length for SANS instruments.