Newer
Older
#ifndef MANTID_DATAHANDLING_LOADEMPTYINSTRUMENT_H_
#define MANTID_DATAHANDLING_LOADEMPTYINSTRUMENT_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/IFileLoader.h"
#include "MantidDataObjects/Workspace2D.h"
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
namespace Mantid {
namespace DataHandling {
/**
Loads an instrument definition file into a workspace, with the purpose of being
able to visualise an instrument without requiring to read in a ISIS raw datafile
first.
The name of the algorithm refers to the fact that an instrument
is loaded into a workspace but without any real data - hence the reason for
referring to
it as an 'empty' instrument.
Required Properties:
<UL>
<LI> Filename - The name of an instrument definition file </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the imported
instrument</LI>
</UL>
Optional Properties: (note that these options are not available if reading a
multiperiod file)
<UL>
<LI> detector_value - This value affect the colour of the detectorss in the
instrument display window</LI>
<LI> monitor_value - This value affect the colour of the monitors in the
instrument display window</LI>
</UL>
@author Anders Markvardsen, ISIS, RAL
@date 31/10/2008
Copyright © 2007-9 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>.
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport LoadEmptyInstrument
: public API::IFileLoader<Kernel::FileDescriptor> {
public:
/// Default constructor
LoadEmptyInstrument();
/// Algorithm's name for identification overriding a virtual method
virtual const std::string name() const { return "LoadEmptyInstrument"; }
/// Summary of algorithms purpose
virtual const std::string summary() const {
return "Loads an Instrument Definition File (IDF) into a workspace rather "
"than a data file.";
}
/// Algorithm's version for identification overriding a virtual method
virtual int version() const { return 1; }
/// Algorithm's category for identification overriding a virtual method
virtual const std::string category() const {
return "DataHandling\\Instrument";
}
/// Returns a confidence value that this algorithm can load a file
virtual int confidence(Kernel::FileDescriptor &descriptor) const;
private:
/// Overwrites Algorithm method.
void init();
/// Overwrites Algorithm method
void exec();
API::MatrixWorkspace_sptr runLoadInstrument();
};
} // namespace DataHandling
} // namespace Mantid
#endif /*MANTID_DATAHANDLING_LOADEMPTYINSTRUMENT_H_*/