-
Notifications
You must be signed in to change notification settings - Fork 122
/
CreateGroupingWorkspace.h
52 lines (45 loc) · 1.79 KB
/
CreateGroupingWorkspace.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidGeometry/Instrument.h"
namespace Mantid {
namespace Algorithms {
/** Creates a new GroupingWorkspace using an instrument from one of:
* an input workspace,
* an instrument name,
* or an instrument IDF file.
*
* Optionally uses bank names to create the groups.
*/
class MANTID_ALGORITHMS_DLL CreateGroupingWorkspace : public API::Algorithm {
public:
/// Algorithm's name for identification
const std::string name() const override;
/// Summary of algorithms purpose
const std::string summary() const override {
return "Creates a new GroupingWorkspace using an instrument from one of: "
"an input workspace, an instrument name, or an instrument IDF "
"file.\nOptionally uses bank names to create the groups.";
}
/// Algorithm's version for identification
int version() const override;
const std::vector<std::string> seeAlso() const override { return {"DiffractionFocussing", "LoadCalFile"}; }
/// Algorithm's category for identification
const std::string category() const override;
private:
/// Initialise the properties
void init() override;
/// Cross-check properties with each other @see IAlgorithm::validateInputs
std::map<std::string, std::string> validateInputs() override;
/// Run the algorithm
void exec() override;
Mantid::Geometry::Instrument_const_sptr getInstrument();
};
} // namespace Algorithms
} // namespace Mantid