Mantid
Loading...
Searching...
No Matches
MaskBinsFromTable.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"
12
13namespace Mantid {
14namespace Algorithms {
15
20class MANTID_ALGORITHMS_DLL MaskBinsFromTable final : public API::Algorithm {
21public:
23
25 const std::string name() const override { return "MaskBinsFromTable"; };
27 const std::string summary() const override { return "Mask bins from a table workspace. "; }
28
30 int version() const override { return 1; };
31 const std::vector<std::string> seeAlso() const override { return {"MaskBins"}; }
33 const std::string category() const override { return "Transforms\\Masking"; }
34
35private:
36 // Implement abstract Algorithm methods
37 void init() override;
38 // Implement abstract Algorithm methods
39 void exec() override;
40
42 void processMaskBinWorkspace(const DataObjects::TableWorkspace_sptr &masktblws,
43 const API::MatrixWorkspace_sptr &dataws);
45 void maskBins(const API::MatrixWorkspace_sptr &dataws);
48 std::string convertToSpectraList(const API::MatrixWorkspace_sptr &dataws, const std::string &detidliststr);
49
51 int id_xmin, id_xmax, id_spec, id_dets;
54
56 std::vector<double> m_xminVec, m_xmaxVec;
57 std::vector<std::string> m_spectraVec;
58};
59
60} // namespace Algorithms
61} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
MaskBinsFromTable : TODO: DESCRIPTION.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
std::vector< std::string > m_spectraVec
const std::string summary() const override
Summary of algorithms purpose.
int version() const override
Algorithm's version for identification overriding a virtual method.
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.
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
std::shared_ptr< TableWorkspace > TableWorkspace_sptr
shared pointer to Mantid::DataObjects::TableWorkspace
Helper class which provides the Collimation Length for SANS instruments.