Mantid
Loading...
Searching...
No Matches
RemoveSpectra.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2019 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
11#include "MantidAlgorithms/DllConfig.h"
12#include "MantidIndexing/IndexInfo.h"
13
14using namespace Mantid::API;
15using namespace Mantid::Indexing;
16
17namespace Mantid {
18namespace Algorithms {
19
20class MANTID_ALGORITHMS_DLL RemoveSpectra final : public API::Algorithm {
22 const std::string name() const override { return "RemoveSpectra"; }
24 const std::string summary() const override {
25 return "Remove spectra from a given workspace, from a list, if spectra is "
26 "masked, or if spectra has no detector.";
27 }
29 int version() const override { return (1); }
30 const std::vector<std::string> seeAlso() const override { return {"ExtractSpectra"}; }
32 const std::string category() const override { return "Transforms\\Splitting"; }
33
34private:
35 void init() override;
36 void exec() override;
37 std::map<std::string, std::string> validateInputs() override;
38 MatrixWorkspace_sptr copySpectraFromInputToOutput(MatrixWorkspace_sptr inputWS, const std::vector<size_t> &specList);
39};
40} // namespace Algorithms
41} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: RemoveSpectra.h:30
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: RemoveSpectra.h:22
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: RemoveSpectra.h:32
const std::string summary() const override
Summary of algorithms purpose.
Definition: RemoveSpectra.h:24
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: RemoveSpectra.h:29
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.