-
Notifications
You must be signed in to change notification settings - Fork 122
/
FindDetectorsInShape.h
64 lines (55 loc) · 2.05 KB
/
FindDetectorsInShape.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
55
56
57
58
59
60
61
62
63
64
// 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"
namespace Mantid {
namespace DataHandling {
/** An algorithm for finding which detectors are contained within a user defined
shape within the instrument.
Required Properties:
<UL>
<LI> Workspace - The name of the input Workspace2D on which to perform the
algorithm </LI>
<LI> ShapeXML - An XML definition of the shape to be projected within the
instruemnt of the workspace </LI>
</UL>
Optional Properties:
<UL>
<LI> IncludeMonitors - True/False whether to include monitors in the
results</LI>
</UL>
Output Properties:
<UL>
<LI> DetectorList - An array property containing the detectors ids contained
in the shape </LI>
</UL>
@author Nick Draper, Tessella plc
@date 16/02/2009
*/
class DLLExport FindDetectorsInShape : public API::DistributedAlgorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "FindDetectorsInShape"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Used to find which instrument detectors are contained within a "
"user-defined 3-D shape.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return {"MaskDetectorsInShape"};
}
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Utility\\Instrument"; }
private:
// Implement abstract Algorithm methods
void init() override;
void exec() override;
};
} // namespace DataHandling
} // namespace Mantid