-
Notifications
You must be signed in to change notification settings - Fork 122
/
EQSANSDarkCurrentSubtraction2.h
61 lines (52 loc) · 1.85 KB
/
EQSANSDarkCurrentSubtraction2.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
#ifndef MANTID_ALGORITHMS_EQSANSDarkCurrentSubtraction2_H_
#define MANTID_ALGORITHMS_EQSANSDarkCurrentSubtraction2_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace WorkflowAlgorithms {
/**
Subtract dark current for EQSANS.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the workspace to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the
result </LI>
</UL>
Optional Properties:
<UL>
<LI> Filename - Data file to use as dark current</LI>
<LI> ReductionTableWorkspace - Table workspace to use to keep track of the
reduction</LI>
<LI> OutputDarkCurrentWorkspace - Name of dark current workspace</LI>
<LI> OutputMessage - Human readable output message</LI>
</UL>
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport EQSANSDarkCurrentSubtraction2 : public API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override {
return "EQSANSDarkCurrentSubtraction";
}
/// Summary of algorithms purpose
const std::string summary() const override {
return "Perform EQSANS dark current subtraction.";
}
/// Algorithm's version
int version() const override { return (2); }
/// Algorithm's category for identification
const std::string category() const override {
return "Workflow\\SANS\\UsesPropertyManager";
}
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_EQSANSDarkCurrentSubtraction2_H_*/