-
Notifications
You must be signed in to change notification settings - Fork 122
/
LoadInstrumentFromRaw.h
107 lines (85 loc) · 3.78 KB
/
LoadInstrumentFromRaw.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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
#ifndef MANTID_DATAHANDLING_LOADINSTRUMENTFROMRAW_H_
#define MANTID_DATAHANDLING_LOADINSTRUMENTFROMRAW_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Geometry {
class CompAssembly;
class Component;
class Instrument;
}
namespace DataHandling {
/** @class LoadInstrumentFromRaw LoadInstrumentFromRaw.h
DataHandling/LoadInstrumentFromRaw.h
Attempt to load information about the instrument from a ISIS raw file. In
particular attempt to
read L2 and 2-theta detector position values and add detectors which are
positioned relative
to the sample in spherical coordinates as (r,theta,phi)=(L2,2-theta,0.0). Also
adds dummy source
and samplepos components to instrument.
LoadInstrumentFromRaw is intended to be used as a child algorithm of
other Loadxxx algorithms, rather than being used directly.
LoadInstrumentFromRaw is an algorithm and as such inherits
from the Algorithm class, via DataHandlingCommand, and overrides
the init() & exec() methods.
Required Properties:
<UL>
<LI> Workspace - The name of the workspace in which to use as a basis for any
data to be added.</LI>
<LI> Filename - The name of and path to the input RAW file </LI>
</UL>
@author Anders Markvardsen, ISIS, RAL
@date 2/5/2008
Copyright © 2007-8 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
*/
class DLLExport LoadInstrumentFromRaw : public API::Algorithm {
public:
/// Default constructor
LoadInstrumentFromRaw();
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "LoadInstrumentFromRaw"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Attempts to load information about the instrument from a ISIS raw "
"file. In particular attempt to read L2 and 2-theta detector "
"position values and add detectors which are positioned relative to "
"the sample in spherical coordinates as "
"(r,theta,phi)=(L2,2-theta,0.0). Also adds dummy source and "
"samplepos components to instrument. If the L1 source - sample "
"distance is not available in the file then it may be read from the "
"mantid properties file using the key instrument.L1, as a final "
"fallback a default distance of 10m will be used.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; };
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override {
return "DataHandling\\Instrument;DataHandling\\Raw";
}
private:
/// Overwrites Algorithm method. Does nothing at present
void init() override;
/// Overwrites Algorithm method
void exec() override;
/// The name and path of the input file
std::string m_filename;
};
} // namespace DataHandling
} // namespace Mantid
#endif /*MANTID_DATAHANDLING_LOADINSTRUMENTFROMRAW_H_*/