Mantid
Loading...
Searching...
No Matches
CreateGroupingWorkspace.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2018 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
23class MANTID_ALGORITHMS_DLL CreateGroupingWorkspace final : public API::Algorithm {
24public:
26 const std::string name() const override;
28 const std::string summary() const override {
29 return "Creates a new GroupingWorkspace using an instrument from one of: "
30 "an input workspace, an instrument name, or an instrument IDF "
31 "file.\nOptionally uses bank names to create the groups.";
32 }
33
35 int version() const override;
36 const std::vector<std::string> seeAlso() const override { return {"DiffractionFocussing", "LoadCalFile"}; }
38 const std::string category() const override;
39
40private:
42 void init() override;
44 std::map<std::string, std::string> validateInputs() override;
46 void exec() override;
47
49};
50
51} // namespace Algorithms
52} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Creates a new GroupingWorkspace using an instrument from one of: an input workspace,...
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 algorithms related to this algorithm.
std::shared_ptr< const Instrument > Instrument_const_sptr
Shared pointer to an const instrument object.
Helper class which provides the Collimation Length for SANS instruments.