-
Notifications
You must be signed in to change notification settings - Fork 122
/
ExtractSingleSpectrum.h
54 lines (47 loc) · 1.78 KB
/
ExtractSingleSpectrum.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
53
54
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/DistributedAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
namespace Mantid {
namespace Algorithms {
/** Copies a single spectrum from a 2D Workspace into a new workspace.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the workspace to take as input. </LI>
<LI> OutputWorkspace - The name under which to store the output workspace.
</LI>
<LI> SpectrumIndex - The workspace index number of the spectrum to extract.
</LI>
</UL>
@author Russell Taylor, Tessella Support Services plc
@date 30/06/2009
*/
class MANTID_ALGORITHMS_DLL ExtractSingleSpectrum : public API::DistributedAlgorithm {
public:
/// Algorithm's name
const std::string name() const override { return "ExtractSingleSpectrum"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Extracts the specified spectrum from a workspace and places it in "
"a new single-spectrum workspace.";
}
/// Algorithm's version
int version() const override { return (1); }
const std::vector<std::string> seeAlso() const override {
return {"CropWorkspace", "ExtractSpectra", "PerformIndexOperations"};
}
/// Algorithm's category for identification
const std::string category() const override { return "Transforms\\Splitting"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid