CentroidPeaksMD2.cpp 5.63 KB
Newer Older
Lynch, Vickie's avatar
Lynch, Vickie committed
1
2
3
4
#include "MantidKernel/System.h"
#include "MantidKernel/ListValidator.h"
#include "MantidAPI/IMDEventWorkspace.h"
#include "MantidDataObjects/PeaksWorkspace.h"
5
6
#include "MantidDataObjects/CoordTransformDistance.h"
#include "MantidDataObjects/MDEventFactory.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
7
8
9
10
11
#include "MantidMDAlgorithms/IntegratePeaksMD.h"
#include "MantidMDAlgorithms/CentroidPeaksMD2.h"

using Mantid::DataObjects::PeaksWorkspace;

12
13
14
15
16
17
18
19
20
21
namespace Mantid {
namespace MDAlgorithms {

// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(CentroidPeaksMD2)

using namespace Mantid::API;
using namespace Mantid::DataObjects;
using namespace Mantid::Geometry;
using namespace Mantid::Kernel;
22
using namespace Mantid::DataObjects;
23
24
25
26
27

//----------------------------------------------------------------------------------------------
/** Initialize the algorithm's properties.
 */
void CentroidPeaksMD2::init() {
28
29
  declareProperty(make_unique<WorkspaceProperty<IMDEventWorkspace>>(
                      "InputWorkspace", "", Direction::Input),
30
31
32
                  "An input MDEventWorkspace.");

  declareProperty(
33
34
      make_unique<PropertyWithValue<double>>("PeakRadius", 1.0,
                                             Direction::Input),
35
36
37
      "Fixed radius around each peak position in which to calculate the "
      "centroid.");

38
39
  declareProperty(make_unique<WorkspaceProperty<PeaksWorkspace>>(
                      "PeaksWorkspace", "", Direction::Input),
40
41
42
                  "A PeaksWorkspace containing the peaks to centroid.");

  declareProperty(
43
44
      make_unique<WorkspaceProperty<PeaksWorkspace>>("OutputWorkspace", "",
                                                     Direction::Output),
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
      "The output PeaksWorkspace will be a copy of the input PeaksWorkspace "
      "with the peaks' positions modified by the new found centroids.");
}

//----------------------------------------------------------------------------------------------
/** Integrate the peaks of the workspace using parameters saved in the algorithm
 * class
 * @param ws ::  MDEventWorkspace to integrate
 */
template <typename MDE, size_t nd>
void CentroidPeaksMD2::integrate(typename MDEventWorkspace<MDE, nd>::sptr ws) {
  if (nd != 3)
    throw std::invalid_argument("For now, we expect the input MDEventWorkspace "
                                "to have 3 dimensions only.");

  /// Peak workspace to centroid
  Mantid::DataObjects::PeaksWorkspace_sptr inPeakWS =
      getProperty("PeaksWorkspace");

  /// Output peaks workspace, create if needed
  Mantid::DataObjects::PeaksWorkspace_sptr peakWS =
      getProperty("OutputWorkspace");
  if (peakWS != inPeakWS)
68
    peakWS = inPeakWS->clone();
69
70
71
72
73
74
75

  int CoordinatesToUse = ws->getSpecialCoordinateSystem();

  /// Radius to use around peaks
  double PeakRadius = getProperty("PeakRadius");

  // cppcheck-suppress syntaxError
Lynch, Vickie's avatar
Lynch, Vickie committed
76
    PRAGMA_OMP(parallel for schedule(dynamic, 10) )
77
    for (int i = 0; i < int(peakWS->getNumberPeaks()); ++i) {
Lynch, Vickie's avatar
Lynch, Vickie committed
78
      // Get a direct ref to that peak.
79
      IPeak &p = peakWS->getPeak(i);
Lynch, Vickie's avatar
Lynch, Vickie committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
      double detectorDistance = p.getL2();

      // Get the peak center as a position in the dimensions of the workspace
      V3D pos;
      if (CoordinatesToUse == 1) //"Q (lab frame)"
        pos = p.getQLabFrame();
      else if (CoordinatesToUse == 2) //"Q (sample frame)"
        pos = p.getQSampleFrame();
      else if (CoordinatesToUse == 3) //"HKL"
        pos = p.getHKL();

      // Build the sphere transformation
      bool dimensionsUsed[nd];
      coord_t center[nd];
94
      for (size_t d = 0; d < nd; ++d) {
Lynch, Vickie's avatar
Lynch, Vickie committed
95
96
97
98
99
100
101
102
        dimensionsUsed[d] = true; // Use all dimensions
        center[d] = static_cast<coord_t>(pos[d]);
      }
      CoordTransformDistance sphere(nd, center, dimensionsUsed);

      // Initialize the centroid to 0.0
      signal_t signal = 0;
      coord_t centroid[nd];
103
      for (size_t d = 0; d < nd; d++)
Lynch, Vickie's avatar
Lynch, Vickie committed
104
105
106
        centroid[d] = 0.0;

      // Perform centroid
107
108
109
      ws->getBox()->centroidSphere(
          sphere, static_cast<coord_t>(PeakRadius * PeakRadius), centroid,
          signal);
Lynch, Vickie's avatar
Lynch, Vickie committed
110
111

      // Normalize by signal
112
113
      if (signal != 0.0) {
        for (size_t d = 0; d < nd; d++)
Lynch, Vickie's avatar
Lynch, Vickie committed
114
115
116
117
118
          centroid[d] /= static_cast<coord_t>(signal);

        V3D vecCentroid(centroid[0], centroid[1], centroid[2]);

        // Save it back in the peak object, in the dimension specified.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
        try {
          if (CoordinatesToUse == 1) //"Q (lab frame)"
          {
            p.setQLabFrame(vecCentroid, detectorDistance);
            p.findDetector();
          } else if (CoordinatesToUse == 2) //"Q (sample frame)"
          {
            p.setQSampleFrame(vecCentroid, detectorDistance);
            p.findDetector();
          } else if (CoordinatesToUse == 3) //"HKL"
          {
            p.setHKL(vecCentroid);
          }
        } catch (std::exception &e) {
          g_log.warning() << "Error setting Q or HKL" << std::endl;
          g_log.warning() << e.what() << std::endl;
        }
Lynch, Vickie's avatar
Lynch, Vickie committed
136
137

        g_log.information() << "Peak " << i << " at " << pos << ": signal "
138
139
140
141
142
143
                            << signal << ", centroid " << vecCentroid << " in "
                            << CoordinatesToUse << std::endl;
      } else {
        g_log.information() << "Peak " << i << " at " << pos
                            << " had no signal, and could not be centroided."
                            << std::endl;
Lynch, Vickie's avatar
Lynch, Vickie committed
144
145
146
147
148
      }
    }

    // Save the output
    setProperty("OutputWorkspace", peakWS);
149
}
Lynch, Vickie's avatar
Lynch, Vickie committed
150

151
152
153
154
155
//----------------------------------------------------------------------------------------------
/** Execute the algorithm.
 */
void CentroidPeaksMD2::exec() {
  inWS = getProperty("InputWorkspace");
Lynch, Vickie's avatar
Lynch, Vickie committed
156

157
158
  CALL_MDEVENT_FUNCTION3(this->integrate, inWS);
}
Lynch, Vickie's avatar
Lynch, Vickie committed
159
160

} // namespace Mantid
161
} // namespace DataObjects