-
Notifications
You must be signed in to change notification settings - Fork 123
/
TransposeMD.cpp
164 lines (137 loc) · 6 KB
/
TransposeMD.cpp
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source
// & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
#include "MantidMDAlgorithms/TransposeMD.h"
#include "MantidAPI/FrameworkManager.h"
#include "MantidAPI/IMDHistoWorkspace.h"
#include "MantidAPI/IMDIterator.h"
#include "MantidAPI/Progress.h"
#include "MantidDataObjects/CoordTransformAligned.h"
#include "MantidDataObjects/MDHistoWorkspace.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidKernel/ArrayBoundedValidator.h"
#include "MantidKernel/ArrayProperty.h"
#include "MantidKernel/MultiThreaded.h"
#include <algorithm>
#include <boost/make_shared.hpp>
#include <boost/shared_ptr.hpp>
#include <memory>
#include <numeric>
#include <vector>
namespace Mantid {
namespace MDAlgorithms {
using namespace Mantid::Kernel;
using namespace Mantid::API;
using namespace Mantid::DataObjects;
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(TransposeMD)
//----------------------------------------------------------------------------------------------
/// Algorithms name for identification. @see Algorithm::name
const std::string TransposeMD::name() const { return "TransposeMD"; }
/// Algorithm's version for identification. @see Algorithm::version
int TransposeMD::version() const { return 1; }
/// Algorithm's category for identification. @see Algorithm::category
const std::string TransposeMD::category() const {
return "MDAlgorithms\\Transforms";
}
/// Algorithm's summary for use in the GUI and help. @see Algorithm::summary
const std::string TransposeMD::summary() const {
return "Transpose the dimensions of a MDWorkspace to create a new output "
"MDWorkspace";
}
//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
*/
void TransposeMD::init() {
declareProperty(std::make_unique<WorkspaceProperty<IMDHistoWorkspace>>(
"InputWorkspace", "", Direction::Input),
"An input workspace.");
auto axisValidator = boost::make_shared<ArrayBoundedValidator<int>>();
axisValidator->setLower(0);
declareProperty(
std::make_unique<ArrayProperty<int>>("Axes", std::vector<int>(0),
axisValidator, Direction::Input),
"Permutes the axes according to the indexes given. Zero "
"based indexing. Defaults to no transpose.");
declareProperty(std::make_unique<WorkspaceProperty<IMDHistoWorkspace>>(
"OutputWorkspace", "", Direction::Output),
"An output workspace.");
}
//----------------------------------------------------------------------------------------------
/** Execute the algorithm.
*/
void TransposeMD::exec() {
IMDHistoWorkspace_sptr inWSProp = getProperty("InputWorkspace");
auto inWS = boost::dynamic_pointer_cast<MDHistoWorkspace>(inWSProp);
if (!inWS) {
throw std::invalid_argument(
"Expect the InputWorkspace to be a MDHistoWorkspace");
}
size_t nDimsInput = inWS->getNumDims();
size_t nDimsOutput = inWS->getNumDims(); // The assumed default.
std::vector<int> axesInts = this->getProperty("Axes");
std::vector<size_t> axes(axesInts.begin(), axesInts.end());
Property *axesProperty = this->getProperty("Axes");
if (!axesProperty->isDefault()) {
Kernel::MDAxisValidator checker(axesInts, nDimsInput, false);
auto axisErrors = checker.validate();
if (!axisErrors.empty()) {
std::string error = axisErrors.begin()->second;
throw std::invalid_argument(error.c_str());
}
nDimsOutput = axes.size();
} else {
axes = std::vector<size_t>(nDimsOutput);
std::iota(axes.begin(), axes.end(), 0);
}
std::vector<coord_t> origin(nDimsOutput, 0.0);
std::vector<Geometry::IMDDimension_sptr> targetGeometry;
for (size_t i = 0; i < nDimsOutput; ++i) {
// Clone the dimension corresponding to the axis requested.
auto cloneDim = Geometry::IMDDimension_sptr(
new Geometry::MDHistoDimension(inWS->getDimension(axes[i]).get()));
targetGeometry.push_back(cloneDim);
}
// Make the output workspace in the right shape.
auto outWS = MDHistoWorkspace_sptr(new MDHistoWorkspace(targetGeometry));
outWS->copyExperimentInfos(*inWS);
// Configure the coordinate transform.
std::vector<coord_t> scaling(nDimsOutput, 1); // No scaling
CoordTransformAligned coordTransform(nDimsInput, nDimsOutput, axes, origin,
scaling);
uint64_t nPoints = inWS->getNPoints();
Progress progress(this, 0.0, 1.0, size_t(nPoints));
progress.reportIncrement(
size_t(double(nPoints) * 0.1)); // Report ~10% progress
const int nThreads = Mantid::API::FrameworkManager::Instance()
.getNumOMPThreads(); // NThreads to Request
auto iterators = inWS->createIterators(nThreads, nullptr);
PARALLEL_FOR_NO_WSP_CHECK()
for (int it = 0; it < int(iterators.size()); ++it) { // NOLINT
PARALLEL_START_INTERUPT_REGION
auto inIterator = iterators[it].get();
do {
auto center = inIterator->getCenter();
const coord_t *incoords = center.getBareArray();
std::vector<coord_t> outcoords(nDimsOutput);
coordTransform.apply(incoords, &outcoords[0]);
size_t index = outWS->getLinearIndexAtCoord(&outcoords[0]);
outWS->setSignalAt(index, inIterator->getSignal());
const signal_t error = inIterator->getError();
outWS->setErrorSquaredAt(index, error * error);
outWS->setNumEventsAt(index,
Mantid::signal_t(inIterator->getNumEvents()));
outWS->setMDMaskAt(index, inIterator->getIsMasked());
progress.report();
} while (inIterator->next());
PARALLEL_END_INTERUPT_REGION
}
PARALLEL_CHECK_INTERUPT_REGION
this->setProperty("OutputWorkspace", outWS);
}
} // namespace MDAlgorithms
} // namespace Mantid