PredictSatellitePeaks.cpp 18.2 KB
Newer Older
1
2
3
4
5
6
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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 +
7
/*
Lynch, Vickie's avatar
Lynch, Vickie committed
8
9
10
11
12
 * PredictSatellitePeaks.cpp
 *
 *  Created on: July 15, 2018
 *      Author: Vickie Lynch
 */
13
#include "MantidCrystal/PredictSatellitePeaks.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
14
#include "MantidAPI/OrientedLatticeValidator.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
15
#include "MantidAPI/Run.h"
16
17
#include "MantidAPI/Sample.h"
#include "MantidAPI/WorkspaceFactory.h"
18
#include "MantidCrystal/PeakAlgorithmHelpers.h"
19
#include "MantidDataObjects/PeaksWorkspace.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
20
21
#include "MantidGeometry/Crystal/BasicHKLFilters.h"
#include "MantidGeometry/Crystal/HKLGenerator.h"
22
23
24
#include "MantidGeometry/Crystal/OrientedLattice.h"
#include "MantidGeometry/Objects/InstrumentRayTracer.h"
#include "MantidKernel/ArrayLengthValidator.h"
Lynch, Vickie's avatar
Lynch, Vickie committed
25
#include "MantidKernel/ArrayProperty.h"
26
27
28
29
#include "MantidKernel/EnabledWhenProperty.h"
#include <boost/math/special_functions/round.hpp>

namespace Mantid {
Lynch, Vickie's avatar
Lynch, Vickie committed
30
31
32
33
34
using namespace Mantid::DataObjects;
using namespace Mantid::API;
using namespace std;
using namespace Mantid::Geometry;
using namespace Mantid::Kernel;
35

Lynch, Vickie's avatar
Lynch, Vickie committed
36
37
38
39
namespace Crystal {

DECLARE_ALGORITHM(PredictSatellitePeaks)

40
41
42
43
/** Constructor
 */

PredictSatellitePeaks::PredictSatellitePeaks()
44
    : m_qConventionFactor(qConventionFactor()) {}
45

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

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

Lynch, Vickie's avatar
Lynch, Vickie committed
72
  declareProperty("GetModVectorsFromUB", false,
Lynch, Vickie's avatar
Lynch, Vickie committed
73
74
                  "If false Modulation Vectors will be read from input");

75
  declareProperty(std::make_unique<PropertyWithValue<bool>>("CrossTerms", false,
Sam Jenkins's avatar
Sam Jenkins committed
76
                                                            Direction::Input),
Lynch, Vickie's avatar
Lynch, Vickie committed
77
78
79
80
81
82
                  "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
83
84
85
86
  declareProperty("IncludeAllPeaksInRange", false,
                  "If false only offsets from "
                  "peaks from Peaks workspace "
                  "in input are used");
Lynch, Vickie's avatar
Lynch, Vickie committed
87

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

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

  setPropertySettings(
      "WavelengthMax",
110
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
111
112
113
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));
  setPropertySettings(
      "MinDSpacing",
114
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
115
116
117
118
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));

  setPropertySettings(
      "MaxDSpacing",
119
      std::make_unique<Kernel::EnabledWhenProperty>(
Lynch, Vickie's avatar
Lynch, Vickie committed
120
121
122
123
124
125
          string("IncludeAllPeaksInRange"), Kernel::IS_EQUAL_TO, "1"));
}

/// Run the algorithm
void PredictSatellitePeaks::exec() {
  bool includePeaksInRange = getProperty("IncludeAllPeaksInRange");
126
127
128
129
  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
130
131
132
133
134
135
136
137
138
139
140
  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");
141
142
  // boolean for only including order zero once
  bool notOrderZero = false;
Lynch, Vickie's avatar
Lynch, Vickie committed
143
144
145
146
147
148
149

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

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

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

  const auto instrument = Peaks->getInstrument();

170
  outPeaks = boost::dynamic_pointer_cast<IPeaksWorkspace>(
Lynch, Vickie's avatar
Lynch, Vickie committed
171
      WorkspaceFactory::Instance().createPeaks());
172
  outPeaks->setInstrument(instrument);
173
  outPeaks->mutableSample().setOrientedLattice(std::move(lattice));
Lynch, Vickie's avatar
Lynch, Vickie committed
174
175
176
177
178
179
180
181
182
183
184

  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");
185
186
187
  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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203

  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);
204
  const auto &UB = outPeaks->sample().getOrientedLattice().getUB();
Lynch, Vickie's avatar
Lynch, Vickie committed
205
206
  goniometer = peak0.getGoniometerMatrix();
  Progress prog(this, 0.0, 1.0, N);
Lynch, Vickie's avatar
Lynch, Vickie committed
207
  vector<vector<int>> AlreadyDonePeaks;
Lynch, Vickie's avatar
Lynch, Vickie committed
208
209
  auto orientedUB = goniometer * UB;
  HKLFilterWavelength lambdaFilter(orientedUB, lambdaMin, lambdaMax);
Lynch, Vickie's avatar
Lynch, Vickie committed
210
211
212
213
214
215
  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
216
217
218
  for (auto it = possibleHKLs.begin(); it != possibleHKLs.end(); ++it) {
    V3D hkl = *it;
    if (crossTerms) {
Lynch, Vickie's avatar
Lynch, Vickie committed
219
220
221
      predictOffsetsWithCrossTerms(offsets1, offsets2, offsets3, maxOrder, hkl,
                                   lambdaFilter, includePeaksInRange,
                                   includeOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
222
    } else {
223
      predictOffsets(0, offsets1, maxOrder, hkl, lambdaFilter,
Lynch, Vickie's avatar
Lynch, Vickie committed
224
                     includePeaksInRange, includeOrderZero, AlreadyDonePeaks);
225
      predictOffsets(1, offsets2, maxOrder, hkl, lambdaFilter,
226
                     includePeaksInRange, notOrderZero, AlreadyDonePeaks);
227
      predictOffsets(2, offsets3, maxOrder, hkl, lambdaFilter,
228
                     includePeaksInRange, notOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
229
230
    }
  }
231
232
233
  // Sort peaks by run number so that peaks with equal goniometer matrices are
  // adjacent
  std::vector<std::pair<std::string, bool>> criteria;
234
235
236
237
238
  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));
239
240
241
242
243
244
  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
245
246
247
248
249
250
251
252
253
254
}

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
255
256
  API::Sample sample = Peaks->mutableSample();

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

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

Lynch, Vickie's avatar
Lynch, Vickie committed
275
276
  bool includePeaksInRange = false;
  bool includeOrderZero = getProperty("IncludeIntegerHKL");
277
278
  // boolean for only including order zero once
  bool notOrderZero = false;
Lynch, Vickie's avatar
Lynch, Vickie committed
279
280
281
282
283
284
285
286

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

  const auto instrument = Peaks->getInstrument();

287
  outPeaks = boost::dynamic_pointer_cast<IPeaksWorkspace>(
Lynch, Vickie's avatar
Lynch, Vickie committed
288
      WorkspaceFactory::Instance().createPeaks());
289
  outPeaks->setInstrument(instrument);
290
  outPeaks->mutableSample().setOrientedLattice(std::move(lattice));
Lynch, Vickie's avatar
Lynch, Vickie committed
291

Lynch, Vickie's avatar
Lynch, Vickie committed
292
  vector<vector<int>> AlreadyDonePeaks;
Lynch, Vickie's avatar
Lynch, Vickie committed
293
  HKLFilterWavelength lambdaFilter(DblMatrix(3, 3, true), 0.1, 100.);
Lynch, Vickie's avatar
Lynch, Vickie committed
294
295
296
297
298
299
  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
300
301
302
303
304
  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
305
306
307
      predictOffsetsWithCrossTerms(offsets1, offsets2, offsets3, maxOrder, hkl,
                                   lambdaFilter, includePeaksInRange,
                                   includeOrderZero, AlreadyDonePeaks);
Lynch, Vickie's avatar
Lynch, Vickie committed
308
    } else {
309
      predictOffsets(0, offsets1, maxOrder, hkl, lambdaFilter,
Lynch, Vickie's avatar
Lynch, Vickie committed
310
                     includePeaksInRange, includeOrderZero, AlreadyDonePeaks);
311
312
313
314
      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
315
316
    }
  }
317
318
319
  // Sort peaks by run number so that peaks with equal goniometer matrices are
  // adjacent
  std::vector<std::pair<std::string, bool>> criteria;
320
321
322
323
324
  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));
325
326
327
328
329
330
331
  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
332
333
334
}

void PredictSatellitePeaks::predictOffsets(
Lynch, Vickie's avatar
Lynch, Vickie committed
335
336
337
    int indexModulatedVector, V3D offsets, int &maxOrder, V3D &hkl,
    HKLFilterWavelength &lambdaFilter, bool &includePeaksInRange,
    bool &includeOrderZero, vector<vector<int>> &AlreadyDonePeaks) {
338
  if (offsets == V3D(0, 0, 0) && !includeOrderZero)
Lynch, Vickie's avatar
Lynch, Vickie committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
    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
354
355
    Kernel::V3D Qs =
        goniometer * UB * satelliteHKL * 2.0 * M_PI * m_qConventionFactor;
Lynch, Vickie's avatar
Lynch, Vickie committed
356
357

    // Check if Q is non-physical
358
    if (Qs.Z() * m_qConventionFactor <= 0)
Lynch, Vickie's avatar
Lynch, Vickie committed
359
      continue;
Lynch, Vickie's avatar
Lynch, Vickie committed
360
361
362
363
364
365
366

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

    peak->setGoniometerMatrix(goniometer);

    if (!peak->findDetector(tracer))
      continue;
Lynch, Vickie's avatar
Lynch, Vickie committed
367
368
369
    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
370
371
372
373
374

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

    if (!foundPeak) {
375
      AlreadyDonePeaks.emplace_back(SavPk);
Lynch, Vickie's avatar
Lynch, Vickie committed
376
377
378
379
    } else {
      continue;
    }

380
381
    peak->setHKL(satelliteHKL * m_qConventionFactor);
    peak->setIntHKL(hkl * m_qConventionFactor);
Lynch, Vickie's avatar
Lynch, Vickie committed
382
383
    peak->setRunNumber(RunNumber);
    V3D mnp;
384
    mnp[indexModulatedVector] = order;
385
    peak->setIntMNP(mnp * m_qConventionFactor);
386
    outPeaks->addPeak(*peak);
Lynch, Vickie's avatar
Lynch, Vickie committed
387
388
389
390
  }
}

void PredictSatellitePeaks::predictOffsetsWithCrossTerms(
Lynch, Vickie's avatar
Lynch, Vickie committed
391
    V3D offsets1, V3D offsets2, V3D offsets3, int &maxOrder, V3D &hkl,
Lynch, Vickie's avatar
Lynch, Vickie committed
392
    HKLFilterWavelength &lambdaFilter, bool &includePeaksInRange,
Lynch, Vickie's avatar
Lynch, Vickie committed
393
    bool &includeOrderZero, vector<vector<int>> &AlreadyDonePeaks) {
Lynch, Vickie's avatar
Lynch, Vickie committed
394
  if (offsets1 == V3D(0, 0, 0) && offsets2 == V3D(0, 0, 0) &&
395
      offsets3 == V3D(0, 0, 0) && !includeOrderZero)
Lynch, Vickie's avatar
Lynch, Vickie committed
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
    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
426
427
        Kernel::V3D Qs =
            goniometer * UB * satelliteHKL * 2.0 * M_PI * m_qConventionFactor;
Lynch, Vickie's avatar
Lynch, Vickie committed
428
429

        // Check if Q is non-physical
430
        if (Qs.Z() * m_qConventionFactor <= 0)
Lynch, Vickie's avatar
Lynch, Vickie committed
431
432
433
434
435
436
437
438
          continue;

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

        peak->setGoniometerMatrix(goniometer);

        if (!peak->findDetector(tracer))
          continue;
Lynch, Vickie's avatar
Lynch, Vickie committed
439
440
441
442
        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
443
444
445
446
447

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

        if (!foundPeak) {
448
          AlreadyDonePeaks.emplace_back(SavPk);
Lynch, Vickie's avatar
Lynch, Vickie committed
449
450
        } else {
          continue;
451
452
        }

453
454
        peak->setHKL(satelliteHKL * m_qConventionFactor);
        peak->setIntHKL(hkl * m_qConventionFactor);
Lynch, Vickie's avatar
Lynch, Vickie committed
455
        peak->setRunNumber(RunNumber);
456
        peak->setIntMNP(V3D(m, n, p) * m_qConventionFactor);
457
        outPeaks->addPeak(*peak);
Lynch, Vickie's avatar
Lynch, Vickie committed
458
459
460
461
462
463
      }
}

V3D PredictSatellitePeaks::getOffsetVector(const std::string &label) {
  vector<double> offsets = getProperty(label);
  if (offsets.empty()) {
464
465
466
    offsets.emplace_back(0.0);
    offsets.emplace_back(0.0);
    offsets.emplace_back(0.0);
Lynch, Vickie's avatar
Lynch, Vickie committed
467
468
469
470
471
472
473
  }
  V3D offsets1 = V3D(offsets[0], offsets[1], offsets[2]);
  return offsets1;
}

} // namespace Crystal
} // namespace Mantid