PredictSatellitePeaks.cpp 17.9 KB
Newer Older
1
/*
Lynch, Vickie's avatar
Lynch, Vickie committed
2
3
4
5
6
 * PredictSatellitePeaks.cpp
 *
 *  Created on: July 15, 2018
 *      Author: Vickie Lynch
 */
7
#include "MantidCrystal/PredictSatellitePeaks.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
8
#include "MantidAPI/OrientedLatticeValidator.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
9
#include "MantidAPI/Run.h"
10
11
#include "MantidAPI/Sample.h"
#include "MantidAPI/WorkspaceFactory.h"
12
#include "MantidCrystal/PeakAlgorithmHelpers.h"
13
#include "MantidDataObjects/PeaksWorkspace.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
14
15
#include "MantidGeometry/Crystal/BasicHKLFilters.h"
#include "MantidGeometry/Crystal/HKLGenerator.h"
16
17
18
#include "MantidGeometry/Crystal/OrientedLattice.h"
#include "MantidGeometry/Objects/InstrumentRayTracer.h"
#include "MantidKernel/ArrayLengthValidator.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
19
#include "MantidKernel/ArrayProperty.h"
20
21
22
23
#include "MantidKernel/EnabledWhenProperty.h"
#include <boost/math/special_functions/round.hpp>

namespace Mantid {
Lynch, Vickie's avatar
Lynch, Vickie committed
24
25
26
27
28
using namespace Mantid::DataObjects;
using namespace Mantid::API;
using namespace std;
using namespace Mantid::Geometry;
using namespace Mantid::Kernel;
29

Lynch, Vickie's avatar
Lynch, Vickie committed
30
31
32
33
namespace Crystal {

DECLARE_ALGORITHM(PredictSatellitePeaks)

34
35
36
37
/** Constructor
 */

PredictSatellitePeaks::PredictSatellitePeaks()
38
    : m_qConventionFactor(qConventionFactor()) {}
39

Lynch, Vickie's avatar
Lynch, Vickie committed
40
41
/// Initialise the properties
void PredictSatellitePeaks::init() {
42
  auto latticeValidator = boost::make_shared<OrientedLatticeValidator>();
Lynch, Vickie's avatar
Lynch, Vickie committed
43
  declareProperty(
44
      std::make_unique<WorkspaceProperty<PeaksWorkspace>>(
45
          "Peaks", "", Direction::Input, latticeValidator),
Lynch, Vickie's avatar
Lynch, Vickie committed
46
47
48
49
      "Workspace of Peaks with orientation matrix that indexed the peaks and "
      "instrument loaded");

  declareProperty(
50
      std::make_unique<WorkspaceProperty<PeaksWorkspace>>("SatellitePeaks", "",
Sam Jenkins's avatar
Sam Jenkins committed
51
                                                          Direction::Output),
Lynch, Vickie's avatar
Lynch, Vickie committed
52
      "Workspace of Peaks with peaks with fractional h,k, and/or l values");
53
  declareProperty(std::make_unique<Kernel::ArrayProperty<double>>(
Lynch, Vickie's avatar
Lynch, Vickie committed
54
55
                      string("ModVector1"), "0.0,0.0,0.0"),
                  "Offsets for h, k, l directions ");
56
  declareProperty(std::make_unique<Kernel::ArrayProperty<double>>(
Lynch, Vickie's avatar
Lynch, Vickie committed
57
58
                      string("ModVector2"), "0.0,0.0,0.0"),
                  "Offsets for h, k, l directions ");
59
  declareProperty(std::make_unique<Kernel::ArrayProperty<double>>(
Lynch, Vickie's avatar
Lynch, Vickie committed
60
61
62
                      string("ModVector3"), "0.0,0.0,0.0"),
                  "Offsets for h, k, l directions ");
  declareProperty(
63
      std::make_unique<PropertyWithValue<int>>("MaxOrder", 0, Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
64
65
      "Maximum order to apply ModVectors. Default = 0");

Lynch, Vickie's avatar
Lynch, Vickie committed
66
  declareProperty("GetModVectorsFromUB", false,
Lynch, Vickie's avatar
Lynch, Vickie committed
67
68
                  "If false Modulation Vectors will be read from input");

69
  declareProperty(std::make_unique<PropertyWithValue<bool>>("CrossTerms", false,
Sam Jenkins's avatar
Sam Jenkins committed
70
                                                            Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
71
72
73
74
75
76
                  "Include cross terms (false)");

  declareProperty(
      "IncludeIntegerHKL", true,
      "If false order 0 peaks are not included in workspace (integer HKL)");

Lynch, Vickie's avatar
Lynch, Vickie committed
77
78
79
80
  declareProperty("IncludeAllPeaksInRange", false,
                  "If false only offsets from "
                  "peaks from Peaks workspace "
                  "in input are used");
Lynch, Vickie's avatar
Lynch, Vickie committed
81

Sam Jenkins's avatar
Sam Jenkins committed
82
83
  declareProperty(std::make_unique<PropertyWithValue<double>>(
                      "WavelengthMin", 0.1, Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
84
85
                  "Minimum wavelength limit at which to start looking for "
                  "single-crystal peaks.");
Sam Jenkins's avatar
Sam Jenkins committed
86
87
  declareProperty(std::make_unique<PropertyWithValue<double>>(
                      "WavelengthMax", 100.0, Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
88
89
                  "Maximum wavelength limit at which to start looking for "
                  "single-crystal peaks.");
Sam Jenkins's avatar
Sam Jenkins committed
90
91
  declareProperty(std::make_unique<PropertyWithValue<double>>(
                      "MinDSpacing", 0.1, Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
92
                  "Minimum d-spacing of peaks to consider. Default = 1.0");
Sam Jenkins's avatar
Sam Jenkins committed
93
94
  declareProperty(std::make_unique<PropertyWithValue<double>>(
                      "MaxDSpacing", 100.0, Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
95
96
97
98
                  "Maximum d-spacing of peaks to consider");

  setPropertySettings(
      "WavelengthMin",
99
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
100
101
102
103
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));

  setPropertySettings(
      "WavelengthMax",
104
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
105
106
107
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));
  setPropertySettings(
      "MinDSpacing",
108
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
109
110
111
112
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));

  setPropertySettings(
      "MaxDSpacing",
113
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
114
115
116
117
118
119
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));
}

/// Run the algorithm
void PredictSatellitePeaks::exec() {
  bool includePeaksInRange = getProperty("IncludeAllPeaksInRange");
120
121
122
123
  Peaks = getProperty("Peaks");
  if (!Peaks)
    throw std::invalid_argument(
        "Input workspace is not a PeaksWorkspace. Type=" + Peaks->id());
Lynch, Vickie's avatar
Lynch, Vickie committed
124
125
126
127
128
129
130
131
132
133
134
  if (!includePeaksInRange) {
    exec_peaks();
    return;
  }

  V3D offsets1 = getOffsetVector("ModVector1");
  V3D offsets2 = getOffsetVector("ModVector2");
  V3D offsets3 = getOffsetVector("ModVector3");
  int maxOrder = getProperty("MaxOrder");
  bool crossTerms = getProperty("CrossTerms");
  bool includeOrderZero = getProperty("IncludeIntegerHKL");
135
136
  // boolean for only including order zero once
  bool notOrderZero = false;
Lynch, Vickie's avatar
Lynch, Vickie committed
137
138
139
140
141
142
143

  if (Peaks->getNumberPeaks() <= 0) {
    g_log.error() << "There are No peaks in the input PeaksWorkspace\n";
    return;
  }

  API::Sample sample = Peaks->mutableSample();
144
  auto lattice = std::make_unique<OrientedLattice>(sample.getOrientedLattice());
Lynch, Vickie's avatar
Lynch, Vickie committed
145

146
147
  bool fromUB = getProperty("GetModVectorsFromUB");
  if (fromUB) {
148
149
150
    offsets1 = lattice->getModVec(0);
    offsets2 = lattice->getModVec(1);
    offsets3 = lattice->getModVec(2);
Lynch, Vickie's avatar
Lynch, Vickie committed
151
    if (maxOrder == 0)
152
153
      maxOrder = lattice->getMaxOrder();
    crossTerms = lattice->getCrossTerm();
154
  } else {
155
156
157
158
159
    lattice->setModVec1(offsets1);
    lattice->setModVec2(offsets2);
    lattice->setModVec3(offsets3);
    lattice->setMaxOrder(maxOrder);
    lattice->setCrossTerm(crossTerms);
Lynch, Vickie's avatar
Lynch, Vickie committed
160
161
162
163
  }

  const auto instrument = Peaks->getInstrument();

164
  outPeaks = boost::dynamic_pointer_cast<IPeaksWorkspace>(
Lynch, Vickie's avatar
Lynch, Vickie committed
165
      WorkspaceFactory::Instance().createPeaks());
166
  outPeaks->setInstrument(instrument);
167
  outPeaks->mutableSample().setOrientedLattice(std::move(lattice));
Lynch, Vickie's avatar
Lynch, Vickie committed
168
169
170
171
172
173
174
175
176
177
178

  Kernel::Matrix<double> goniometer;
  goniometer.identityMatrix();

  const double lambdaMin = getProperty("WavelengthMin");
  const double lambdaMax = getProperty("WavelengthMax");
  IPeak &peak0 = Peaks->getPeak(0);

  std::vector<V3D> possibleHKLs;
  const double dMin = getProperty("MinDSpacing");
  const double dMax = getProperty("MaxDSpacing");
179
180
181
  Geometry::HKLGenerator gen(outPeaks->sample().getOrientedLattice(), dMin);
  auto dSpacingFilter = boost::make_shared<HKLFilterDRange>(
      outPeaks->sample().getOrientedLattice(), dMin, dMax);
Lynch, Vickie's avatar
Lynch, Vickie committed
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197

  V3D hkl = *(gen.begin());
  g_log.information() << "HKL range for d_min of " << dMin << " to d_max of "
                      << dMax << " is from " << hkl << " to " << hkl * -1.0
                      << ", a total of " << gen.size() << " possible HKL's\n";
  if (gen.size() > MAX_NUMBER_HKLS)
    throw std::invalid_argument("More than 10 billion HKLs to search. Is "
                                "your d_min value too small?");

  possibleHKLs.clear();
  possibleHKLs.reserve(gen.size());
  std::remove_copy_if(gen.begin(), gen.end(), std::back_inserter(possibleHKLs),
                      (~dSpacingFilter)->fn());

  size_t N = possibleHKLs.size();
  N = max<size_t>(100, N);
198
  const auto &UB = outPeaks->sample().getOrientedLattice().getUB();
Lynch, Vickie's avatar
Lynch, Vickie committed
199
200
  goniometer = peak0.getGoniometerMatrix();
  Progress prog(this, 0.0, 1.0, N);
Lynch, Vickie's avatar
Lynch, Vickie committed
201
  vector<vector<int>> AlreadyDonePeaks;
Lynch, Vickie's avatar
Lynch, Vickie committed
202
203
  auto orientedUB = goniometer * UB;
  HKLFilterWavelength lambdaFilter(orientedUB, lambdaMin, lambdaMax);
Lynch, Vickie's avatar
Lynch, Vickie committed
204
205
206
207
208
209
  outPeaks->mutableRun().addProperty<std::vector<double>>("Offset1", offsets1,
                                                          true);
  outPeaks->mutableRun().addProperty<std::vector<double>>("Offset2", offsets2,
                                                          true);
  outPeaks->mutableRun().addProperty<std::vector<double>>("Offset3", offsets3,
                                                          true);
Lynch, Vickie's avatar
Lynch, Vickie committed
210
211
212
  for (auto it = possibleHKLs.begin(); it != possibleHKLs.end(); ++it) {
    V3D hkl = *it;
    if (crossTerms) {
Lynch, Vickie's avatar
Lynch, Vickie committed
213
214
215
      predictOffsetsWithCrossTerms(offsets1, offsets2, offsets3, maxOrder, hkl,
                                   lambdaFilter, includePeaksInRange,
                                   includeOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
216
    } else {
217
      predictOffsets(0, offsets1, maxOrder, hkl, lambdaFilter,
Lynch, Vickie's avatar
Lynch, Vickie committed
218
                     includePeaksInRange, includeOrderZero, AlreadyDonePeaks);
219
      predictOffsets(1, offsets2, maxOrder, hkl, lambdaFilter,
220
                     includePeaksInRange, notOrderZero, AlreadyDonePeaks);
221
      predictOffsets(2, offsets3, maxOrder, hkl, lambdaFilter,
222
                     includePeaksInRange, notOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
223
224
    }
  }
225
226
227
  // Sort peaks by run number so that peaks with equal goniometer matrices are
  // adjacent
  std::vector<std::pair<std::string, bool>> criteria;
228
229
230
231
232
  criteria.emplace_back(std::pair<std::string, bool>("RunNumber", true));
  criteria.emplace_back(std::pair<std::string, bool>("BankName", true));
  criteria.emplace_back(std::pair<std::string, bool>("h", true));
  criteria.emplace_back(std::pair<std::string, bool>("k", true));
  criteria.emplace_back(std::pair<std::string, bool>("l", true));
233
234
235
236
237
238
  outPeaks->sort(criteria);

  for (int i = 0; i < static_cast<int>(outPeaks->getNumberPeaks()); ++i) {
    outPeaks->getPeak(i).setPeakNumber(i);
  }
  setProperty("SatellitePeaks", outPeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
239
240
241
242
243
244
245
246
247
248
}

void PredictSatellitePeaks::exec_peaks() {

  V3D offsets1 = getOffsetVector("ModVector1");
  V3D offsets2 = getOffsetVector("ModVector2");
  V3D offsets3 = getOffsetVector("ModVector3");
  int maxOrder = getProperty("MaxOrder");
  bool crossTerms = getProperty("CrossTerms");

Lynch, Vickie's avatar
Lynch, Vickie committed
249
250
  API::Sample sample = Peaks->mutableSample();

251
  auto lattice = std::make_unique<OrientedLattice>(sample.getOrientedLattice());
Lynch, Vickie's avatar
Lynch, Vickie committed
252

253
254
  bool fromUB = getProperty("GetModVectorsFromUB");
  if (fromUB) {
255
256
257
    offsets1 = lattice->getModVec(0);
    offsets2 = lattice->getModVec(1);
    offsets3 = lattice->getModVec(2);
Lynch, Vickie's avatar
Lynch, Vickie committed
258
    if (maxOrder == 0)
259
260
      maxOrder = lattice->getMaxOrder();
    crossTerms = lattice->getCrossTerm();
261
  } else {
262
263
264
265
266
    lattice->setModVec1(offsets1);
    lattice->setModVec2(offsets2);
    lattice->setModVec3(offsets3);
    lattice->setMaxOrder(maxOrder);
    lattice->setCrossTerm(crossTerms);
Lynch, Vickie's avatar
Lynch, Vickie committed
267
268
  }

Lynch, Vickie's avatar
Lynch, Vickie committed
269
270
  bool includePeaksInRange = false;
  bool includeOrderZero = getProperty("IncludeIntegerHKL");
271
272
  // boolean for only including order zero once
  bool notOrderZero = false;
Lynch, Vickie's avatar
Lynch, Vickie committed
273
274
275
276
277
278
279
280

  if (Peaks->getNumberPeaks() <= 0) {
    g_log.error() << "There are No peaks in the input PeaksWorkspace\n";
    return;
  }

  const auto instrument = Peaks->getInstrument();

281
  outPeaks = boost::dynamic_pointer_cast<IPeaksWorkspace>(
Lynch, Vickie's avatar
Lynch, Vickie committed
282
      WorkspaceFactory::Instance().createPeaks());
283
  outPeaks->setInstrument(instrument);
284
  outPeaks->mutableSample().setOrientedLattice(std::move(lattice));
Lynch, Vickie's avatar
Lynch, Vickie committed
285

Lynch, Vickie's avatar
Lynch, Vickie committed
286
  vector<vector<int>> AlreadyDonePeaks;
Lynch, Vickie's avatar
Lynch, Vickie committed
287
  HKLFilterWavelength lambdaFilter(DblMatrix(3, 3, true), 0.1, 100.);
Lynch, Vickie's avatar
Lynch, Vickie committed
288
289
290
291
292
293
  outPeaks->mutableRun().addProperty<std::vector<double>>("Offset1", offsets1,
                                                          true);
  outPeaks->mutableRun().addProperty<std::vector<double>>("Offset2", offsets2,
                                                          true);
  outPeaks->mutableRun().addProperty<std::vector<double>>("Offset3", offsets3,
                                                          true);
Lynch, Vickie's avatar
Lynch, Vickie committed
294
295
296
297
298
  std::vector<Peak> peaks = Peaks->getPeaks();
  for (auto it = peaks.begin(); it != peaks.end(); ++it) {
    auto peak = *it;
    V3D hkl = peak.getHKL();
    if (crossTerms) {
Lynch, Vickie's avatar
Lynch, Vickie committed
299
300
301
      predictOffsetsWithCrossTerms(offsets1, offsets2, offsets3, maxOrder, hkl,
                                   lambdaFilter, includePeaksInRange,
                                   includeOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
302
    } else {
303
      predictOffsets(0, offsets1, maxOrder, hkl, lambdaFilter,
Lynch, Vickie's avatar
Lynch, Vickie committed
304
                     includePeaksInRange, includeOrderZero, AlreadyDonePeaks);
305
306
307
308
      predictOffsets(1, offsets2, maxOrder, hkl, lambdaFilter,
                     includePeaksInRange, notOrderZero, AlreadyDonePeaks);
      predictOffsets(2, offsets3, maxOrder, hkl, lambdaFilter,
                     includePeaksInRange, notOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
309
310
    }
  }
311
312
313
  // Sort peaks by run number so that peaks with equal goniometer matrices are
  // adjacent
  std::vector<std::pair<std::string, bool>> criteria;
314
315
316
317
318
  criteria.emplace_back(std::pair<std::string, bool>("RunNumber", true));
  criteria.emplace_back(std::pair<std::string, bool>("BankName", true));
  criteria.emplace_back(std::pair<std::string, bool>("h", true));
  criteria.emplace_back(std::pair<std::string, bool>("k", true));
  criteria.emplace_back(std::pair<std::string, bool>("l", true));
319
320
321
322
323
324
325
  outPeaks->sort(criteria);

  for (int i = 0; i < static_cast<int>(outPeaks->getNumberPeaks()); ++i) {
    outPeaks->getPeak(i).setPeakNumber(i);
  }

  setProperty("SatellitePeaks", outPeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
326
327
328
}

void PredictSatellitePeaks::predictOffsets(
Lynch, Vickie's avatar
Lynch, Vickie committed
329
330
331
    int indexModulatedVector, V3D offsets, int &maxOrder, V3D &hkl,
    HKLFilterWavelength &lambdaFilter, bool &includePeaksInRange,
    bool &includeOrderZero, vector<vector<int>> &AlreadyDonePeaks) {
332
  if (offsets == V3D(0, 0, 0) && !includeOrderZero)
Lynch, Vickie's avatar
Lynch, Vickie committed
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
    return;
  const Kernel::DblMatrix &UB = Peaks->sample().getOrientedLattice().getUB();
  IPeak &peak1 = Peaks->getPeak(0);
  Kernel::Matrix<double> goniometer = peak1.getGoniometerMatrix();
  auto RunNumber = peak1.getRunNumber();
  Geometry::InstrumentRayTracer tracer(Peaks->getInstrument());
  for (int order = -maxOrder; order <= maxOrder; order++) {
    if (order == 0 && !includeOrderZero)
      continue; // exclude order 0
    V3D satelliteHKL(hkl);

    satelliteHKL += offsets * order;
    if (!lambdaFilter.isAllowed(satelliteHKL) && includePeaksInRange)
      continue;

Lynch, Vickie's avatar
Lynch, Vickie committed
348
349
    Kernel::V3D Qs =
        goniometer * UB * satelliteHKL * 2.0 * M_PI * m_qConventionFactor;
Lynch, Vickie's avatar
Lynch, Vickie committed
350
351

    // Check if Q is non-physical
352
    if (Qs.Z() * m_qConventionFactor <= 0)
Lynch, Vickie's avatar
Lynch, Vickie committed
353
      continue;
Lynch, Vickie's avatar
Lynch, Vickie committed
354
355
356
357
358
359
360

    auto peak(Peaks->createPeak(Qs, 1));

    peak->setGoniometerMatrix(goniometer);

    if (!peak->findDetector(tracer))
      continue;
Lynch, Vickie's avatar
Lynch, Vickie committed
361
362
363
    vector<int> SavPk{RunNumber, boost::math::iround(1000.0 * satelliteHKL[0]),
                      boost::math::iround(1000.0 * satelliteHKL[1]),
                      boost::math::iround(1000.0 * satelliteHKL[2])};
Lynch, Vickie's avatar
Lynch, Vickie committed
364
365
366
367
368

    bool foundPeak =
        binary_search(AlreadyDonePeaks.begin(), AlreadyDonePeaks.end(), SavPk);

    if (!foundPeak) {
369
      AlreadyDonePeaks.emplace_back(SavPk);
Lynch, Vickie's avatar
Lynch, Vickie committed
370
371
372
373
    } else {
      continue;
    }

374
375
    peak->setHKL(satelliteHKL * m_qConventionFactor);
    peak->setIntHKL(hkl * m_qConventionFactor);
Lynch, Vickie's avatar
Lynch, Vickie committed
376
377
    peak->setRunNumber(RunNumber);
    V3D mnp;
378
    mnp[indexModulatedVector] = order;
379
    peak->setIntMNP(mnp * m_qConventionFactor);
380
    outPeaks->addPeak(*peak);
Lynch, Vickie's avatar
Lynch, Vickie committed
381
382
383
384
  }
}

void PredictSatellitePeaks::predictOffsetsWithCrossTerms(
Lynch, Vickie's avatar
Lynch, Vickie committed
385
    V3D offsets1, V3D offsets2, V3D offsets3, int &maxOrder, V3D &hkl,
Lynch, Vickie's avatar
Lynch, Vickie committed
386
    HKLFilterWavelength &lambdaFilter, bool &includePeaksInRange,
Lynch, Vickie's avatar
Lynch, Vickie committed
387
    bool &includeOrderZero, vector<vector<int>> &AlreadyDonePeaks) {
Lynch, Vickie's avatar
Lynch, Vickie committed
388
  if (offsets1 == V3D(0, 0, 0) && offsets2 == V3D(0, 0, 0) &&
389
      offsets3 == V3D(0, 0, 0) && !includeOrderZero)
Lynch, Vickie's avatar
Lynch, Vickie committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
    return;
  const Kernel::DblMatrix &UB = Peaks->sample().getOrientedLattice().getUB();
  IPeak &peak1 = Peaks->getPeak(0);
  Kernel::Matrix<double> goniometer = peak1.getGoniometerMatrix();
  auto RunNumber = peak1.getRunNumber();
  Geometry::InstrumentRayTracer tracer(Peaks->getInstrument());
  DblMatrix offsetsMat(3, 3);
  offsetsMat.setColumn(0, offsets1);
  offsetsMat.setColumn(1, offsets2);
  offsetsMat.setColumn(2, offsets3);
  int maxOrder1 = maxOrder;
  if (offsets1 == V3D(0, 0, 0))
    maxOrder1 = 0;
  int maxOrder2 = maxOrder;
  if (offsets2 == V3D(0, 0, 0))
    maxOrder2 = 0;
  int maxOrder3 = maxOrder;
  if (offsets3 == V3D(0, 0, 0))
    maxOrder3 = 0;
  for (int m = -maxOrder1; m <= maxOrder1; m++)
    for (int n = -maxOrder2; n <= maxOrder2; n++)
      for (int p = -maxOrder3; p <= maxOrder3; p++) {
        if (m == 0 && n == 0 && p == 0 && !includeOrderZero)
          continue; // exclude 0,0,0
        V3D satelliteHKL(hkl);
        V3D mnp = V3D(m, n, p);
        satelliteHKL -= offsetsMat * mnp;
        if (!lambdaFilter.isAllowed(satelliteHKL) && includePeaksInRange)
          continue;

Lynch, Vickie's avatar
Lynch, Vickie committed
420
421
        Kernel::V3D Qs =
            goniometer * UB * satelliteHKL * 2.0 * M_PI * m_qConventionFactor;
Lynch, Vickie's avatar
Lynch, Vickie committed
422
423

        // Check if Q is non-physical
424
        if (Qs.Z() * m_qConventionFactor <= 0)
Lynch, Vickie's avatar
Lynch, Vickie committed
425
426
427
428
429
430
431
432
          continue;

        auto peak(Peaks->createPeak(Qs, 1));

        peak->setGoniometerMatrix(goniometer);

        if (!peak->findDetector(tracer))
          continue;
Lynch, Vickie's avatar
Lynch, Vickie committed
433
434
435
436
        vector<int> SavPk{RunNumber,
                          boost::math::iround(1000.0 * satelliteHKL[0]),
                          boost::math::iround(1000.0 * satelliteHKL[1]),
                          boost::math::iround(1000.0 * satelliteHKL[2])};
Lynch, Vickie's avatar
Lynch, Vickie committed
437
438
439
440
441

        bool foundPeak = binary_search(AlreadyDonePeaks.begin(),
                                       AlreadyDonePeaks.end(), SavPk);

        if (!foundPeak) {
442
          AlreadyDonePeaks.emplace_back(SavPk);
Lynch, Vickie's avatar
Lynch, Vickie committed
443
444
        } else {
          continue;
445
446
        }

447
448
        peak->setHKL(satelliteHKL * m_qConventionFactor);
        peak->setIntHKL(hkl * m_qConventionFactor);
Lynch, Vickie's avatar
Lynch, Vickie committed
449
        peak->setRunNumber(RunNumber);
450
        peak->setIntMNP(V3D(m, n, p) * m_qConventionFactor);
451
        outPeaks->addPeak(*peak);
Lynch, Vickie's avatar
Lynch, Vickie committed
452
453
454
455
456
457
      }
}

V3D PredictSatellitePeaks::getOffsetVector(const std::string &label) {
  vector<double> offsets = getProperty(label);
  if (offsets.empty()) {
458
459
460
    offsets.emplace_back(0.0);
    offsets.emplace_back(0.0);
    offsets.emplace_back(0.0);
Lynch, Vickie's avatar
Lynch, Vickie committed
461
462
463
464
465
466
467
  }
  V3D offsets1 = V3D(offsets[0], offsets[1], offsets[2]);
  return offsets1;
}

} // namespace Crystal
} // namespace Mantid