Mantid
Loading...
Searching...
No Matches
ExtractMask.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 {
32class MANTID_ALGORITHMS_DLL ExtractMask : public Mantid::API::Algorithm {
33public:
35 const std::string name() const override { return "ExtractMask"; }
37 const std::string summary() const override {
38 return "Extracts the masking from a given workspace and places it in a new "
39 "workspace.";
40 }
41
43 int version() const override { return 1; }
44 const std::vector<std::string> seeAlso() const override { return {"ExtractMaskToTable"}; }
46 const std::string category() const override { return "Transforms\\Masking"; }
47
48private:
50 void init() override;
52 void exec() override;
53};
54} // namespace Algorithms
55} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
Extract the masking from a given workspace.
Definition ExtractMask.h:32
const std::string name() const override
Algorithm's name.
Definition ExtractMask.h:35
const std::string summary() const override
Summary of algorithms purpose.
Definition ExtractMask.h:37
int version() const override
Algorithm's version.
Definition ExtractMask.h:43
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition ExtractMask.h:44
const std::string category() const override
Algorithm's category for identification.
Definition ExtractMask.h:46
Helper class which provides the Collimation Length for SANS instruments.