-
Notifications
You must be signed in to change notification settings - Fork 122
/
LoadMD.h
147 lines (110 loc) · 4.52 KB
/
LoadMD.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
#ifndef MANTID_MDALGORITHMS_LOADMD_H_
#define MANTID_MDALGORITHMS_LOADMD_H_
#include "MantidAPI/DataProcessorAlgorithm.h"
#include "MantidAPI/IFileLoader.h"
#include "MantidAPI/IMDEventWorkspace_fwd.h"
#include "MantidKernel/System.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include <boost/scoped_ptr.hpp>
#include <boost/optional.hpp>
namespace Mantid {
namespace MDAlgorithms {
/** Load a .nxs file into a MDEventWorkspace.
@author Janik Zikovsky
@date 2011-07-12
Copyright © 2011 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 LoadMD : public API::IFileLoader<Kernel::NexusDescriptor> {
public:
LoadMD();
/// Algorithm's name for identification
const std::string name() const override { return "LoadMD"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Load a MDEventWorkspace in .nxs format.";
}
/// Algorithm's version for identification
int version() const override { return 1; };
/// Algorithm's category for identification
const std::string category() const override {
return "MDAlgorithms\\DataHandling";
}
/// Returns a confidence value that this algorithm can load a file
int confidence(Kernel::NexusDescriptor &descriptor) const override;
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
// ki-kf for Inelastic convention; kf-ki for Crystallography convention
std::string convention;
/// Helper method
template <typename MDE, size_t nd>
void doLoad(typename DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
void loadExperimentInfos(
boost::shared_ptr<Mantid::API::MultipleExperimentInfos> ws);
void loadSlab(std::string name, void *data,
DataObjects::MDHistoWorkspace_sptr ws,
NeXus::NXnumtype dataType);
void loadHisto();
void loadDimensions();
void loadDimensions2();
void loadCoordinateSystem();
void loadQConvention();
void loadVisualNormalization(
const std::string &key,
boost::optional<Mantid::API::MDNormalization> &normalization);
/// Load all the affine matricies
void loadAffineMatricies(API::IMDWorkspace_sptr ws);
/// Load a given affine matrix
API::CoordTransform *loadAffineMatrix(std::string entry_name);
/// Sets MDFrames for workspaces from legacy files
void setMDFrameOnWorkspaceFromLegacyFile(API::IMDWorkspace_sptr ws);
/// Checks if a worspace is a certain type of legacy file
void checkForRequiredLegacyFixup(API::IMDWorkspace_sptr ws);
/// Negative scaling for Q dimensions
std::vector<double> qDimensions(API::IMDWorkspace_sptr ws);
/// Open file handle
// clang-format off
boost::scoped_ptr< ::NeXus::File> m_file;
// clang-format on
/// Name of that file
std::string m_filename;
/// Number of dimensions in loaded file
size_t m_numDims;
/// Each dimension object loaded.
std::vector<Mantid::Geometry::IMDDimension_sptr> m_dims;
/// Coordinate system
Kernel::SpecialCoordinateSystem m_coordSystem;
/// QConvention
std::string m_QConvention;
/// load only the box structure with empty boxes but do not tload boxes events
bool m_BoxStructureAndMethadata;
/// Version of SaveMD used to save the file
int m_saveMDVersion;
/// Visual normalization
boost::optional<Mantid::API::MDNormalization> m_visualNormalization;
boost::optional<Mantid::API::MDNormalization> m_visualNormalizationHisto;
/// Named entry
static const std::string VISUAL_NORMALIZATION_KEY;
static const std::string VISUAL_NORMALIZATION_KEY_HISTO;
/// MDFrame correction flag
bool m_requiresMDFrameCorrection;
};
} // namespace DataObjects
} // namespace Mantid
#endif /* MANTID_MDALGORITHMS_LOADMD_H_ */