-
Notifications
You must be signed in to change notification settings - Fork 121
/
HFIRLoad.h
71 lines (59 loc) · 2.2 KB
/
HFIRLoad.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
65
66
67
68
69
70
71
#ifndef MANTID_ALGORITHMS_HFIRLOAD_H_
#define MANTID_ALGORITHMS_HFIRLOAD_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
namespace Mantid {
namespace WorkflowAlgorithms {
/**
Subtract dark current for HFIR SANS.
Required Properties:
<UL>
<LI> Filename - The name of the input event Nexus file to load </LI>
<LI> OutputWorkspace - Then name of the output EventWorkspace </LI>
</UL>
Optional Properties:
<UL>
<LI> BeamCenterX - Beam position in X pixel coordinates (used only if
UseConfigBeam is false)</LI>
<LI> BeamCenterY - Beam position in Y pixel coordinates (used only if
UseConfigBeam is false)</LI>
<LI> SampleDetectorDistance - Sample to detector distance to use
(overrides meta data), in mm</LI>
<LI> SampleDetectorDistanceOffset - Offset to the sample to detector
distance (use only when using the distance found in the meta data), in
mm</LI>
</UL>
Output Property:
<UL>
<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 HFIRLoad : public API::Algorithm {
public:
/// Algorithm's name
const std::string name() const override { return "HFIRLoad"; }
/// Summary of algorithms purpose
const std::string summary() const override { return "Load HFIR SANS data."; }
/// Algorithm's version
int version() const override { return (1); }
/// 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;
void moveToBeamCenter(API::MatrixWorkspace_sptr &dataWS, double ¢er_x,
double ¢er_y);
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_HFIRLOAD_H_*/