-
Notifications
You must be signed in to change notification settings - Fork 122
/
LoadNXSPE.h
65 lines (57 loc) · 2.2 KB
/
LoadNXSPE.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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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/IFileLoader.h"
#include "MantidGeometry/Objects/CSGObject.h"
#include "MantidKernel/NexusDescriptor.h"
#include "MantidKernel/System.h"
namespace Mantid {
namespace DataHandling {
/** LoadNXSPE : Algorithm to load an NXSPE file into a workspace2D. It will
create a "new" instrument, that can be overwritten later by the LoadInstrument
algorithm
Properties:
<ul>
<li>Filename - the name of the file to read from.</li>
<li>Workspace - the workspace name that will be created and hold the loaded
data.</li>
</ul>
@author Andrei Savici, ORNL
@date 2011-08-14
*/
class DLLExport LoadNXSPE : public API::IFileLoader<Kernel::NexusDescriptor> {
public:
/// Algorithm's name for identification
const std::string name() const override { return "LoadNXSPE"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return " Algorithm to load an NXSPE file into a workspace2D.";
}
/// Algorithm's version for identification
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return {"SaveNXSPE", "LoadSPE"};
}
/// Algorithm's category for identification
const std::string category() const override {
return R"(DataHandling\Nexus;DataHandling\SPE;Inelastic\DataHandling)";
}
/// Returns a confidence value that this algorithm can load a file
int confidence(Kernel::NexusDescriptor &descriptor) const override;
/// Confidence in identifier.
static int identiferConfidence(const std::string &value);
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
/// Function to return a cuboid shape, with widths dx,dy,dz
std::shared_ptr<Geometry::CSGObject> createCuboid(double dx, double dy,
double dz);
};
} // namespace DataHandling
} // namespace Mantid