PeaksWorkspace.cpp 33.7 KB
Newer Older
1
#include "MantidDataObjects/PeaksWorkspace.h"
2
3
#include "MantidAPI/AlgorithmFactory.h"
#include "MantidAPI/Column.h"
Peterson, Peter's avatar
Peterson, Peter committed
4
#include "MantidAPI/ColumnFactory.h"
5
#include "MantidAPI/MatrixWorkspace.h"
6
7
#include "MantidAPI/Run.h"
#include "MantidAPI/Sample.h"
Peterson, Peter's avatar
Peterson, Peter committed
8
#include "MantidAPI/WorkspaceFactory.h"
9
#include "MantidDataObjects/Peak.h"
10
11
#include "MantidDataObjects/TableColumn.h"
#include "MantidDataObjects/TableWorkspace.h"
12
13
#include "MantidGeometry/Crystal/OrientedLattice.h"
#include "MantidGeometry/Instrument/Goniometer.h"
14
15
16
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/PhysicalConstants.h"
17
#include "MantidKernel/Quat.h"
18
#include "MantidKernel/Unit.h"
19
#include "MantidKernel/UnitConversion.h"
20
#include "MantidKernel/V3D.h"
21

Peterson, Peter's avatar
Peterson, Peter committed
22
#include <algorithm>
23
#include <boost/shared_ptr.hpp>
24
25
26
#include <cmath>
#include <cstdio>
#include <cstdlib>
Peterson, Peter's avatar
Peterson, Peter committed
27
28
#include <exception>
#include <fstream>
29
30
#include <nexus/NeXusException.hpp>
#include <nexus/NeXusFile.hpp>
31
32
33
34
35
36
#include <ostream>
#include <string>

using namespace Mantid::API;
using namespace Mantid::Kernel;
using namespace Mantid::Geometry;
Peterson, Peter's avatar
Peterson, Peter committed
37

38
39
40
namespace Mantid {
namespace DataObjects {
/// Register the workspace as a type
41
DECLARE_WORKSPACE(PeaksWorkspace)
42

Owen Arnold's avatar
Owen Arnold committed
43
//---------------------------------------------------------------------------------------------
44
45
46
47
/** Constructor. Create a table with all the required columns.
 *
 * @return PeaksWorkspace object
 */
48
49
50
51
PeaksWorkspace::PeaksWorkspace()
    : IPeaksWorkspace(), peaks(), columns(), columnNames(),
      m_coordSystem(None) {
  initColumns();
52
53
  // PeaksWorkspace does not use the grouping mechanism of ExperimentInfo.
  setNumberOfDetectorGroups(0);
54
}
55

56
57
58
59
60
61
62
//---------------------------------------------------------------------------------------------
/** Copy constructor
 *
 * @param other :: other PeaksWorkspace to copy from
 * @return
 */
PeaksWorkspace::PeaksWorkspace(const PeaksWorkspace &other)
63
64
    : IPeaksWorkspace(other), peaks(other.peaks), columns(), columnNames(),
      m_coordSystem(other.m_coordSystem) {
65
  initColumns();
66
67
  // PeaksWorkspace does not use the grouping mechanism of ExperimentInfo.
  setNumberOfDetectorGroups(0);
68
}
69

70
71
72
73
74
75
76
77
78
79
80
81
//=====================================================================================
//=====================================================================================
/** Comparator class for sorting peaks by one or more criteria
 */
class PeakComparator : public std::binary_function<Peak, Peak, bool> {
public:
  std::vector<std::pair<std::string, bool>> &criteria;

  /** Constructor for the comparator for sorting peaks
   * @param criteria : a vector with a list of pairs: column name, bool;
   *        where bool = true for ascending, false for descending sort.
   */
82
  explicit PeakComparator(std::vector<std::pair<std::string, bool>> &criteria)
83
84
85
86
      : criteria(criteria) {}

  /** Compare two peaks using the stored criteria */
  inline bool operator()(const Peak &a, const Peak &b) {
Hahn, Steven's avatar
Hahn, Steven committed
87
88
89
    for (auto &name : criteria) {
      std::string &col = name.first;
      bool ascending = name.second;
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
      bool lessThan = false;
      if (col == "BankName") {
        // If this criterion is equal, move on to the next one
        std::string valA = a.getBankName();
        std::string valB = b.getBankName();
        // Move on to lesser criterion if equal
        if (valA == valB)
          continue;
        lessThan = (valA < valB);
      } else {
        // General double comparison
        double valA = a.getValueByColName(col);
        double valB = b.getValueByColName(col);
        // Move on to lesser criterion if equal
        if (valA == valB)
          continue;
        lessThan = (valA < valB);
Owen Arnold's avatar
Owen Arnold committed
107
      }
108
109
110
      // Flip the sign of comparison if descending.
      if (ascending)
        return lessThan;
Owen Arnold's avatar
Owen Arnold committed
111
      else
112
        return !lessThan;
113
    }
114
115
116
117
    // If you reach here, all criteria were ==; so not <, so return false
    return false;
  }
};
118

119
120
121
122
123
124
125
126
127
128
129
130
//---------------------------------------------------------------------------------------------
/** Sort the peaks by one or more criteria
 *
 * @param criteria : a vector with a list of pairs: column name, bool;
 *        where bool = true for ascending, false for descending sort.
 *        The peaks are sorted by the first criterion first, then the 2nd if
 *equal, etc.
 */
void PeaksWorkspace::sort(std::vector<std::pair<std::string, bool>> &criteria) {
  PeakComparator comparator(criteria);
  std::stable_sort(peaks.begin(), peaks.end(), comparator);
}
131

132
133
134
135
//---------------------------------------------------------------------------------------------
/** @return the number of peaks
 */
int PeaksWorkspace::getNumberPeaks() const { return int(peaks.size()); }
136

137
138
139
140
141
//---------------------------------------------------------------------------------------------
/** @return the convention
 */
std::string PeaksWorkspace::getConvention() const { return convention; }

142
143
144
145
146
147
148
149
150
151
152
//---------------------------------------------------------------------------------------------
/** Removes the indicated peak
 * @param peakNum  the peak to remove. peakNum starts at 0
 */
void PeaksWorkspace::removePeak(const int peakNum) {
  if (peakNum >= static_cast<int>(peaks.size()) || peakNum < 0) {
    throw std::invalid_argument(
        "PeaksWorkspace::removePeak(): peakNum is out of range.");
  }
  peaks.erase(peaks.begin() + peakNum);
}
153

154
/** Removes multiple peaks
Matthew Bowles's avatar
Matthew Bowles committed
155
* @param badPeaks peaks to be removed
156
*/
157
158
void PeaksWorkspace::removePeaks(std::vector<int> badPeaks) {
  if (badPeaks.empty())
Matthew Bowles's avatar
Matthew Bowles committed
159
    return;
Lynch, Vickie's avatar
Lynch, Vickie committed
160
161
162
163
164
165
  // if index of peak is in badPeaks remove
  int ip = -1;
  auto it =
      std::remove_if(peaks.begin(), peaks.end(), [&ip, badPeaks](Peak &pk) {
        (void)pk;
        ip++;
166
167
        for (int badPeak : badPeaks) {
          if (badPeak == ip)
Lynch, Vickie's avatar
Lynch, Vickie committed
168
169
            return true;
        }
170
        return false;
Lynch, Vickie's avatar
Lynch, Vickie committed
171
172
      });
  peaks.erase(it, peaks.end());
173
174
}

175
176
//---------------------------------------------------------------------------------------------
/** Add a peak to the list
177
 * @param ipeak :: Peak object to add (copy) into this.
178
 */
Owen Arnold's avatar
Owen Arnold committed
179
void PeaksWorkspace::addPeak(const Geometry::IPeak &ipeak) {
180
181
182
183
184
185
  if (dynamic_cast<const Peak *>(&ipeak)) {
    peaks.push_back((const Peak &)ipeak);
  } else {
    peaks.push_back(Peak(ipeak));
  }
}
186

187
188
189
190
191
//---------------------------------------------------------------------------------------------
/** Add a peak to the list
 * @param position :: position on the peak in the specified coordinate frame
 * @param frame :: the coordinate frame that the position is specified in
 */
192
193
void PeaksWorkspace::addPeak(const V3D &position,
                             const SpecialCoordinateSystem &frame) {
194
195
196
197
  auto peak = createPeak(position, frame);
  addPeak(*peak);
}

198
199
//---------------------------------------------------------------------------------------------
/** Add a peak to the list
200
 * @param peak :: Peak object to add (move) into this.
201
 */
202
void PeaksWorkspace::addPeak(Peak &&peak) { peaks.push_back(peak); }
203

204
205
206
207
208
209
210
211
212
213
214
215
//---------------------------------------------------------------------------------------------
/** Return a reference to the Peak
 * @param peakNum :: index of the peak to get.
 * @return a reference to a Peak object.
 */
Peak &PeaksWorkspace::getPeak(const int peakNum) {
  if (peakNum >= static_cast<int>(peaks.size()) || peakNum < 0) {
    throw std::invalid_argument(
        "PeaksWorkspace::getPeak(): peakNum is out of range.");
  }
  return peaks[peakNum];
}
216

217
218
219
220
221
222
223
224
225
226
227
228
//---------------------------------------------------------------------------------------------
/** Return a const reference to the Peak
 * @param peakNum :: index of the peak to get.
 * @return a reference to a Peak object.
 */
const Peak &PeaksWorkspace::getPeak(const int peakNum) const {
  if (peakNum >= static_cast<int>(peaks.size()) || peakNum < 0) {
    throw std::invalid_argument(
        "PeaksWorkspace::getPeak(): peakNum is out of range.");
  }
  return peaks[peakNum];
}
229

230
231
232
//---------------------------------------------------------------------------------------------
/** Creates an instance of a Peak BUT DOES NOT ADD IT TO THE WORKSPACE
 * @param QLabFrame :: Q of the center of the peak, in reciprocal space
233
234
 * @param detectorDistance :: optional distance between the sample and the
 * detector. You do NOT need to explicitly provide this distance.
235
236
 * @return a pointer to a new Peak object.
 */
Owen Arnold's avatar
Owen Arnold committed
237
Geometry::IPeak *
Hahn, Steven's avatar
Hahn, Steven committed
238
PeaksWorkspace::createPeak(const Kernel::V3D &QLabFrame,
239
                           boost::optional<double> detectorDistance) const {
240
241
242
  Geometry::Goniometer goniometer = this->run().getGoniometer();

  // create a peak using the qLab frame
243
  auto peak = new Peak(this->getInstrument(), QLabFrame, detectorDistance);
244
245
246
247
248
249
250
251

  // Set the goniometer
  peak->setGoniometerMatrix(goniometer.getR());

  // Take the run number from this
  peak->setRunNumber(this->getRunNumber());

  return peak;
252
}
253

254
255
256
257
258
259
260
261
262
263
//---------------------------------------------------------------------------------------------
/** Creates an instance of a Peak BUT DOES NOT ADD IT TO THE WORKSPACE
 * @param position :: position of the center of the peak, in reciprocal space
 * @param frame :: the coordinate system that the position is specified in
 * detector. You do NOT need to explicitly provide this distance.
 * @return a pointer to a new Peak object.
 */
std::unique_ptr<Geometry::IPeak>
PeaksWorkspace::createPeak(const Kernel::V3D &position,
                           const Kernel::SpecialCoordinateSystem &frame) const {
264
265
266
267
268
269
270
  if (frame == Mantid::Kernel::HKL) {
    return std::unique_ptr<Geometry::IPeak>(createPeakHKL(position));
  } else if (frame == Mantid::Kernel::QLab) {
    return std::unique_ptr<Geometry::IPeak>(createPeak(position));
  } else {
    return std::unique_ptr<Geometry::IPeak>(createPeakQSample(position));
  }
271
272
273
274
}

//---------------------------------------------------------------------------------------------
/** Creates an instance of a Peak BUT DOES NOT ADD IT TO THE WORKSPACE
275
276
 * @param position :: QSample position of the center of the peak, in reciprocal
 * space
277
278
279
 * detector. You do NOT need to explicitly provide this distance.
 * @return a pointer to a new Peak object.
 */
280
Peak *PeaksWorkspace::createPeakQSample(const V3D &position) const {
281
  // Create a peak from QSampleFrame
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301

  Geometry::Goniometer goniometer;

  LogManager_const_sptr props = getLogs();
  if (props->hasProperty("wavelength") || props->hasProperty("energy")) {
    // Assume constant wavelenth
    // Calculate Q lab from Q sample and wavelength
    double wavelength;
    if (props->hasProperty("energy")) {
      wavelength = Kernel::UnitConversion::run(
          "Energy", "Wavelength",
          props->getPropertyValueAsType<double>("energy"), 0, 0, 0,
          Kernel::DeltaEMode::Elastic, 0);
    } else {
      wavelength = props->getPropertyValueAsType<double>("wavelength");
    }
    goniometer.calcFromQSampleAndWavelength(position, wavelength);
  } else {
    goniometer = run().getGoniometer();
  }
302
303
304
305
306
307
308
  // create a peak using the qLab frame
  auto peak = new Peak(getInstrument(), position, goniometer.getR());
  // Take the run number from this
  peak->setRunNumber(getRunNumber());
  return peak;
}

309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
/**
 * Returns selected information for a "peak" at QLabFrame.
 *
 * @param qFrame      An arbitrary position in Q-space.  This does not have to
 *be the
 *                    position of a peak.
 * @param labCoords   Set true if the position is in the lab coordinate system,
 *false if
 *                    it is in the sample coordinate system.
 * @return a vector whose elements contain different information about the
 *"peak" at that position.
 *         each element is a pair of description of information and the string
 *form for the corresponding
 *         value.
 */
std::vector<std::pair<std::string, std::string>>
Hahn, Steven's avatar
Hahn, Steven committed
325
PeaksWorkspace::peakInfo(const Kernel::V3D &qFrame, bool labCoords) const {
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
  std::vector<std::pair<std::string, std::string>> Result;
  std::ostringstream oss;
  oss << std::setw(12) << std::fixed << std::setprecision(3) << (qFrame.norm());
  std::pair<std::string, std::string> QMag("|Q|", oss.str());
  Result.push_back(QMag);

  oss.str("");
  oss.clear();
  oss << std::setw(12) << std::fixed << std::setprecision(3)
      << (2.0 * M_PI / qFrame.norm());

  std::pair<std::string, std::string> dspc("d-spacing", oss.str());
  oss.str("");
  oss.clear();
  Result.push_back(dspc);

  int seqNum = -1;
  bool hasOneRunNumber = true;
  int runNum = -1;
  int NPeaks = getNumberPeaks();
  try {
    double minDist = 10000000;
    for (int i = 0; i < NPeaks; i++) {
      Peak pk = getPeak(i);
      V3D Q = pk.getQLabFrame();
      if (!labCoords)
        Q = pk.getQSampleFrame();
      double D = qFrame.distance(Q);
      if (D < minDist) {
        minDist = D;
        seqNum = i;
357
      }
358

359
360
361
362
363
364
365
366
367
368
369
370
      int run = pk.getRunNumber();
      if (runNum < 0)
        runNum = run;
      else if (runNum != run)
        hasOneRunNumber = false;
    }
  } catch (...) {
    seqNum = -1; // peak could have been removed
  }
  V3D Qlab = qFrame;
  V3D Qsamp;
  Kernel::Matrix<double> Gon(3, 3, true);
371

372
373
374
  if (seqNum >= 0 && NPeaks == getNumberPeaks())
    Gon = getPeak(seqNum).getGoniometerMatrix();
  if (labCoords) {
375

376
377
378
    Kernel::Matrix<double> InvGon(Gon);
    InvGon.Invert();
    Qsamp = InvGon * Qlab;
379

380
381
382
383
  } else {
    Qsamp = qFrame;
    Qlab = Gon * Qsamp;
  }
384

385
  if (labCoords || seqNum >= 0)
386

387
388
389
390
391
  {
    std::pair<std::string, std::string> QlabStr(
        "Qlab", boost::lexical_cast<std::string>(Qlab));
    Result.push_back(QlabStr);
  }
392

393
  if (!labCoords || seqNum >= 0) {
394

395
396
397
398
    std::pair<std::string, std::string> QsampStr(
        "QSample", boost::lexical_cast<std::string>(Qsamp));
    Result.push_back(QsampStr);
  }
399

400
  try {
401

Owen Arnold's avatar
Owen Arnold committed
402
    Geometry::IPeak *peak = createPeak(Qlab);
403

404
    if (sample().hasOrientedLattice()) {
405

406
407
      peak->setGoniometerMatrix(Gon);
      const Geometry::OrientedLattice &lat = (sample().getOrientedLattice());
408

409
410
411
412
      const Kernel::Matrix<double> &UB0 = lat.getUB();
      Kernel::Matrix<double> UB(UB0);
      UB.Invert();
      V3D hkl = UB * Qsamp / 2 / M_PI;
Owen Arnold's avatar
Owen Arnold committed
413

414
415
416
      std::pair<std::string, std::string> HKL(
          "HKL", boost::lexical_cast<std::string>(hkl));
      Result.push_back(HKL);
417
418
    }

419
    if (hasOneRunNumber) {
420
421
      std::pair<std::string, std::string> runn("RunNumber",
                                               "   " + std::to_string(runNum));
422
      Result.push_back(runn);
423
    }
424

425
426
427
428
429
430
431
432
433
434
    //------- Now get phi, chi and omega ----------------
    Geometry::Goniometer GonG(Gon);
    std::vector<double> OmegaChiPhi = GonG.getEulerAngles("YZY");
    Kernel::V3D PhiChiOmega(OmegaChiPhi[2], OmegaChiPhi[1], OmegaChiPhi[0]);

    std::pair<std::string, std::string> GRead(
        "Goniometer Angles", boost::lexical_cast<std::string>(PhiChiOmega));
    Result.push_back(GRead);

    std::pair<std::string, std::string> SeqNum(
435
        "Seq Num,1st=1", "    " + std::to_string(seqNum + 1));
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
    Result.push_back(SeqNum);

    oss << std::setw(12) << std::fixed << std::setprecision(3)
        << (peak->getWavelength());
    std::pair<std::string, std::string> wl("Wavelength", oss.str());
    Result.push_back(wl);
    oss.str("");
    oss.clear();

    if (peak->findDetector()) {
      std::pair<std::string, std::string> detpos(
          "Position(x,y,z)",
          boost::lexical_cast<std::string>(peak->getDetPos()));
      Result.push_back(detpos);

      oss << std::setw(15) << std::fixed << std::setprecision(3)
          << (peak->getTOF());
      std::pair<std::string, std::string> tof("TOF", oss.str());
      Result.push_back(tof);
      oss.str("");
      oss.clear();

      oss << std::setw(12) << std::fixed << std::setprecision(3)
          << (peak->getFinalEnergy());
      std::pair<std::string, std::string> Energy("Energy", oss.str());
      Result.push_back(Energy);
      oss.str("");
      oss.clear();

      std::pair<std::string, std::string> row(
466
          "Row", "    " + std::to_string(peak->getRow()));
467
468
469
      Result.push_back(row);

      std::pair<std::string, std::string> col(
470
          "Col", "    " + std::to_string(peak->getCol()));
471
472
473
474
475
476
477
478
479
480
      Result.push_back(col);

      std::pair<std::string, std::string> bank("Bank",
                                               "    " + peak->getBankName());
      Result.push_back(bank);

      oss << std::setw(12) << std::fixed << std::setprecision(3)
          << (peak->getScattering());
      std::pair<std::string, std::string> scat("Scattering Angle", oss.str());
      Result.push_back(scat);
481
    }
482

483
484
485
486
487
  } catch (...) // Impossible position
  {
  }
  return Result;
}
488

489
490
491
492
493
494
495
/**
 * Create a Peak from a HKL value provided by the client.
 *
 *
 * @param HKL : reciprocal lattice vector coefficients
 * @return Fully formed peak.
 */
Hahn, Steven's avatar
Hahn, Steven committed
496
Peak *PeaksWorkspace::createPeakHKL(const V3D &HKL) const {
497
498
499
  /*
   The following allows us to add peaks where we have a single UB to work from.
   */
500

501
502
  Geometry::OrientedLattice lattice = this->sample().getOrientedLattice();
  Geometry::Goniometer goniometer = this->run().getGoniometer();
503

504
505
506
  // Calculate qLab from q HKL. As per Busing and Levy 1967, q_lab_frame = 2pi *
  // Goniometer * UB * HKL
  V3D qLabFrame = goniometer.getR() * lattice.getUB() * HKL * 2 * M_PI;
507

508
509
510
511
  // create a peak using the qLab frame
  auto peak =
      new Peak(this->getInstrument(),
               qLabFrame); // This should calculate the detector positions too.
512

513
514
  // We need to set HKL separately to keep things consistent.
  peak->setHKL(HKL[0], HKL[1], HKL[2]);
515

516
517
  // Set the goniometer
  peak->setGoniometerMatrix(goniometer.getR());
518

519
520
  // Take the run number from this
  peak->setRunNumber(this->getRunNumber());
521

522
  return peak;
523
524
}

525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
/**
 * Returns selected information for a "peak" at QLabFrame.
 *
 * @param qFrame      An arbitrary position in Q-space.  This does not have to
 *be the
 *                    position of a peak.
 * @param labCoords  Set true if the position is in the lab coordinate system,
 *false if
 *                    it is in the sample coordinate system.
 * @return a vector whose elements contain different information about the
 *"peak" at that position.
 *         each element is a pair of description of information and the string
 *form for the corresponding
 *         value.
 */
Hahn, Steven's avatar
Hahn, Steven committed
540
541
int PeaksWorkspace::peakInfoNumber(const Kernel::V3D &qFrame,
                                   bool labCoords) const {
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
  std::vector<std::pair<std::string, std::string>> Result;
  std::ostringstream oss;
  oss << std::setw(12) << std::fixed << std::setprecision(3) << (qFrame.norm());
  std::pair<std::string, std::string> QMag("|Q|", oss.str());
  Result.push_back(QMag);

  oss.str("");
  oss.clear();
  oss << std::setw(12) << std::fixed << std::setprecision(3)
      << (2.0 * M_PI / qFrame.norm());

  std::pair<std::string, std::string> dspc("d-spacing", oss.str());
  oss.str("");
  oss.clear();
  Result.push_back(dspc);

  int seqNum = -1;
  double minDist = 10000000;

  for (int i = 0; i < getNumberPeaks(); i++) {
    Peak pk = getPeak(i);
    V3D Q = pk.getQLabFrame();
    if (!labCoords)
      Q = pk.getQSampleFrame();
    double D = qFrame.distance(Q);
    if (D < minDist) {
      minDist = D;
      seqNum = i + 1;
570
    }
571
572
573
  }
  return seqNum;
}
Peterson, Peter's avatar
Peterson, Peter committed
574

575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
//---------------------------------------------------------------------------------------------
/** Return a reference to the Peaks vector */
std::vector<Peak> &PeaksWorkspace::getPeaks() { return peaks; }

/** Return a const reference to the Peaks vector */
const std::vector<Peak> &PeaksWorkspace::getPeaks() const { return peaks; }

/** Getter for the integration status.
 @return TRUE if it has been integrated using a peak integration algorithm.
 */
bool PeaksWorkspace::hasIntegratedPeaks() const {
  bool ret = false;
  const std::string peaksIntegrated = "PeaksIntegrated";
  if (this->run().hasProperty(peaksIntegrated)) {
    const int value = boost::lexical_cast<int>(
        this->run().getProperty(peaksIntegrated)->value());
    ret = (value != 0);
  }
  return ret;
}
595

596
597
598
599
600
//---------------------------------------------------------------------------------------------
/// Return the memory used in bytes
size_t PeaksWorkspace::getMemorySize() const {
  return getNumberPeaks() * sizeof(Peak);
}
601

602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
//---------------------------------------------------------------------------------------------
/**
 *  Creates a new TableWorkspace with detailing the contributing Detector IDs.
 * The table
 *  will have 2 columns: Index &  DetectorID, where Index maps into the current
 * index
 *  within the PeaksWorkspace of the peak
 */
API::ITableWorkspace_sptr PeaksWorkspace::createDetectorTable() const {
  auto table = API::WorkspaceFactory::Instance().createTable("TableWorkspace");
  table->addColumn("int", "Index");
  table->addColumn("int", "DetectorID");

  const int npeaks(static_cast<int>(this->rowCount()));
  int nrows(0);
  for (int i = 0; i < npeaks; ++i) {
    const Peak &peak = this->peaks[i];
    auto detIDs = peak.getContributingDetIDs();
    auto itEnd = detIDs.end();
    for (auto it = detIDs.begin(); it != itEnd; ++it) {
      table->appendRow();
      table->cell<int>(nrows, 0) = i;
      table->cell<int>(nrows, 1) = *it;
      ++nrows;
Owen Arnold's avatar
Owen Arnold committed
626
    }
627
  }
628

629
630
  return table;
}
Peterson, Peter's avatar
Peterson, Peter committed
631

632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
//---------------------------------------------------------------------------------------------
/** Initialize all columns */
void PeaksWorkspace::initColumns() {
  // Note: The column types are controlled in PeakColumn.cpp
  addPeakColumn("RunNumber");
  addPeakColumn("DetID");
  addPeakColumn("h");
  addPeakColumn("k");
  addPeakColumn("l");
  addPeakColumn("Wavelength");
  addPeakColumn("Energy");
  addPeakColumn("TOF");
  addPeakColumn("DSpacing");
  addPeakColumn("Intens");
  addPeakColumn("SigInt");
  addPeakColumn("BinCount");
  addPeakColumn("BankName");
  addPeakColumn("Row");
  addPeakColumn("Col");
  addPeakColumn("QLab");
  addPeakColumn("QSample");
653
  addPeakColumn("PeakNumber");
654
}
Peterson, Peter's avatar
Peterson, Peter committed
655

656
657
658
659
660
661
662
663
664
665
666
667
//---------------------------------------------------------------------------------------------
/**
 * Add a PeakColumn
 * @param name :: The name of the column
 **/
void PeaksWorkspace::addPeakColumn(const std::string &name) {
  // Create the PeakColumn.
  columns.push_back(boost::shared_ptr<DataObjects::PeakColumn>(
      new DataObjects::PeakColumn(this->peaks, name)));
  // Cache the names
  columnNames.push_back(name);
}
Peterson, Peter's avatar
Peterson, Peter committed
668

669
670
671
672
673
674
675
676
677
//---------------------------------------------------------------------------------------------
/// @return the index of the column with the given name.
size_t PeaksWorkspace::getColumnIndex(const std::string &name) const {
  for (size_t i = 0; i < columns.size(); i++)
    if (columns[i]->name() == name)
      return i;
  throw std::invalid_argument("Column named " + name +
                              " was not found in the PeaksWorkspace.");
}
Peterson, Peter's avatar
Peterson, Peter committed
678

679
680
681
682
683
684
685
686
//---------------------------------------------------------------------------------------------
/// Gets the shared pointer to a column by index.
boost::shared_ptr<Mantid::API::Column> PeaksWorkspace::getColumn(size_t index) {
  if (index >= columns.size())
    throw std::invalid_argument(
        "PeaksWorkspace::getColumn() called with invalid index.");
  return columns[index];
}
687

688
689
690
691
692
693
694
695
696
//---------------------------------------------------------------------------------------------
/// Gets the shared pointer to a column by index.
boost::shared_ptr<const Mantid::API::Column>
PeaksWorkspace::getColumn(size_t index) const {
  if (index >= columns.size())
    throw std::invalid_argument(
        "PeaksWorkspace::getColumn() called with invalid index.");
  return columns[index];
}
697

698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
void PeaksWorkspace::saveNexus(::NeXus::File *file) const {

  // Number of Peaks
  const size_t np(peaks.size());

  // Column vectors for peaks table
  std::vector<int> detectorID(np);
  std::vector<double> H(np);
  std::vector<double> K(np);
  std::vector<double> L(np);
  std::vector<double> intensity(np);
  std::vector<double> sigmaIntensity(np);
  std::vector<double> binCount(np);
  std::vector<double> initialEnergy(np);
  std::vector<double> finalEnergy(np);
  std::vector<double> waveLength(np);
  std::vector<double> scattering(np);
  std::vector<double> dSpacing(np);
  std::vector<double> TOF(np);
  std::vector<int> runNumber(np);
718
  std::vector<int> peakNumber(np);
719
  std::vector<double> goniometerMatrix(9 * np);
720
  std::vector<std::string> shapes(np);
721
722

  // Populate column vectors from Peak Workspace
723
  size_t maxShapeJSONLength = 0;
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
  for (size_t i = 0; i < np; i++) {
    Peak p = peaks[i];
    detectorID[i] = p.getDetectorID();
    H[i] = p.getH();
    K[i] = p.getK();
    L[i] = p.getL();
    intensity[i] = p.getIntensity();
    sigmaIntensity[i] = p.getSigmaIntensity();
    binCount[i] = p.getBinCount();
    initialEnergy[i] = p.getInitialEnergy();
    finalEnergy[i] = p.getFinalEnergy();
    waveLength[i] = p.getWavelength();
    scattering[i] = p.getScattering();
    dSpacing[i] = p.getDSpacing();
    TOF[i] = p.getTOF();
    runNumber[i] = p.getRunNumber();
740
    peakNumber[i] = p.getPeakNumber();
741
    {
742
743
744
745
746
747
748
749
750
751
      Matrix<double> gm = p.getGoniometerMatrix();
      goniometerMatrix[9 * i] = gm[0][0];
      goniometerMatrix[9 * i + 1] = gm[1][0];
      goniometerMatrix[9 * i + 2] = gm[2][0];
      goniometerMatrix[9 * i + 3] = gm[0][1];
      goniometerMatrix[9 * i + 4] = gm[1][1];
      goniometerMatrix[9 * i + 5] = gm[2][1];
      goniometerMatrix[9 * i + 6] = gm[0][2];
      goniometerMatrix[9 * i + 7] = gm[1][2];
      goniometerMatrix[9 * i + 8] = gm[2][2];
752
    }
753
754
    const std::string shapeJSON = p.getPeakShape().toJSON();
    shapes[i] = shapeJSON;
755
756
    if (shapeJSON.size() > maxShapeJSONLength) {
      maxShapeJSONLength = shapeJSON.size();
757
    }
758
  }
759

760
  // Start Peaks Workspace in Nexus File
761
762
763
  const std::string specifyInteger = "An integer";
  const std::string specifyDouble = "A double";
  const std::string specifyString = "A string";
764
765
766
  file->makeGroup("peaks_workspace", "NXentry",
                  true); // For when peaksWorkspace can be loaded

767
768
  // Coordinate system
  file->writeData("coordinate_system", static_cast<uint32_t>(m_coordSystem));
769

770
771
772
773
774
  // Write out the Qconvention
  // ki-kf for Inelastic convention; kf-ki for Crystallography convention
  std::string m_QConvention = this->getConvention();
  file->putAttr("QConvention", m_QConvention);

775
776
777
  // Detectors column
  file->writeData("column_1", detectorID);
  file->openData("column_1");
778
  file->putAttr("name", "Detector ID");
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
  file->putAttr("interpret_as", specifyInteger);
  file->putAttr("units", "Not known");
  file->closeData();

  // H column
  file->writeData("column_2", H);
  file->openData("column_2");
  file->putAttr("name", "H");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // K column
  file->writeData("column_3", K);
  file->openData("column_3");
  file->putAttr("name", "K");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // L column
  file->writeData("column_4", L);
  file->openData("column_4");
  file->putAttr("name", "L");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Intensity column
  file->writeData("column_5", intensity);
  file->openData("column_5");
  file->putAttr("name", "Intensity");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Sigma Intensity column
  file->writeData("column_6", sigmaIntensity);
  file->openData("column_6");
  file->putAttr("name", "Sigma Intensity");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Bin Count column
  file->writeData("column_7", binCount);
  file->openData("column_7");
  file->putAttr("name", "Bin Count");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Initial Energy column
  file->writeData("column_8", initialEnergy);
  file->openData("column_8");
  file->putAttr("name", "Initial Energy");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Final Energy column
  file->writeData("column_9", finalEnergy);
  file->openData("column_9");
  file->putAttr("name", "Final Energy");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Wave Length Column
  file->writeData("column_10", waveLength);
  file->openData("column_10");
  file->putAttr("name", "Wave Length");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Scattering Column
  file->writeData("column_11", scattering);
  file->openData("column_11");
  file->putAttr("name", "Scattering");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // D Spacing Column
  file->writeData("column_12", dSpacing);
  file->openData("column_12");
  file->putAttr("name", "D Spacing");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // TOF Column
  file->writeData("column_13", TOF);
  file->openData("column_13");
  file->putAttr("name", "TOF");
  file->putAttr("interpret_as", specifyDouble);
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

  // Run Number column
  file->writeData("column_14", runNumber);
  file->openData("column_14");
  file->putAttr("name", "Run Number");
  file->putAttr("interpret_as", specifyInteger);
  file->putAttr("units", "Not known"); // Units may need changing when known
885
886
887
  file->closeData();

  // Peak Number column
888
889
  file->writeData("column_17", peakNumber);
  file->openData("column_17");
890
891
892
  file->putAttr("name", "Peak Number");
  file->putAttr("interpret_as", specifyInteger);
  file->putAttr("units", "Not known"); // Units may need changing when known
893
894
895
896
897
898
899
900
901
902
903
904
905
  file->closeData();

  // Goniometer Matrix Column
  std::vector<int> array_dims;
  array_dims.push_back(static_cast<int>(peaks.size()));
  array_dims.push_back(9);
  file->writeData("column_15", goniometerMatrix, array_dims);
  file->openData("column_15");
  file->putAttr("name", "Goniometer Matrix");
  file->putAttr("interpret_as", "A matrix of 3x3 doubles");
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->closeData();

906
907
908
909
910
911
912
913
  // Shape
  std::vector<int64_t> dims;
  dims.push_back(np);
  dims.push_back(static_cast<int>(maxShapeJSONLength));
  const std::string name = "column_16";
  file->makeData(name, NeXus::CHAR, dims, false);
  file->openData(name);

914
  auto toNexus = new char[maxShapeJSONLength * np];
Owen Arnold's avatar
Owen Arnold committed
915
  for (size_t ii = 0; ii < np; ii++) {
916
917
918
    std::string rowStr = shapes[ii];
    for (size_t ic = 0; ic < rowStr.size(); ic++)
      toNexus[ii * maxShapeJSONLength + ic] = rowStr[ic];
919
920
    for (size_t ic = rowStr.size();
         ic < static_cast<size_t>(maxShapeJSONLength); ic++)
921
922
923
924
925
926
927
928
929
930
931
      toNexus[ii * maxShapeJSONLength + ic] = ' ';
  }

  file->putData((void *)(toNexus));

  delete[] toNexus;
  file->putAttr("units", "Not known"); // Units may need changing when known
  file->putAttr("name", "Shape");
  file->putAttr("interpret_as", specifyString);
  file->closeData();

932
933
934
935
  // QLab & QSample are calculated and do not need to be saved

  file->closeGroup(); // end of peaks workpace
}
936

937
938
939
940
941
/**
 * Set the special Q3D coordinate system.
 * @param coordinateSystem : Option to set.
 */
void PeaksWorkspace::setCoordinateSystem(
942
943
    const Kernel::SpecialCoordinateSystem coordinateSystem) {
  m_coordSystem = coordinateSystem;
944
}
945

946
947
948
/**
 * @return the special Q3D coordinate system.
 */
949
Kernel::SpecialCoordinateSystem
950
PeaksWorkspace::getSpecialCoordinateSystem() const {
951
  return m_coordSystem;
Peterson, Peter's avatar
Peterson, Peter committed
952
}
953

954
955
956
957
// prevent shared pointer from deleting this
struct NullDeleter {
  template <typename T> void operator()(T *) {}
};
958
/**Get access to shared pointer containing workspace porperties */
959
API::LogManager_sptr PeaksWorkspace::logs() {
960
  return API::LogManager_sptr(&(this->mutableRun()), NullDeleter());
961
}
962

963
964
965
966
967
968
969
/** Get constant access to shared pointer containing workspace porperties;
 * Copies logs into new LogManager variable Meaningfull only for some
 * multithereaded methods when a thread wants to have its own copy of logs */
API::LogManager_const_sptr PeaksWorkspace::getLogs() const {
  return API::LogManager_const_sptr(new API::LogManager(this->run()));
}

970
ITableWorkspace *
971
PeaksWorkspace::doCloneColumns(const std::vector<std::string> &) const {
972
973
  throw Kernel::Exception::NotImplementedError(
      "PeaksWorkspace cannot clone columns.");
974
}
975
976
}
}
977

978
///\cond TEMPLATE
979

980
981
982
983
984
985
986
987
988
989
990
991
992
993
namespace Mantid {
namespace Kernel {

template <>
DLLExport Mantid::DataObjects::PeaksWorkspace_sptr
IPropertyManager::getValue<Mantid::DataObjects::PeaksWorkspace_sptr>(
    const std::string &name) const {
  PropertyWithValue<Mantid::DataObjects::PeaksWorkspace_sptr> *prop =
      dynamic_cast<
          PropertyWithValue<Mantid::DataObjects::PeaksWorkspace_sptr> *>(
          getPointerToProperty(name));
  if (prop) {
    return *prop;
  } else {
994
995
996
    std::string message =
        "Attempt to assign property " + name +
        " to incorrect type. Expected shared_ptr<PeaksWorkspace>.";
997
998
999
    throw std::runtime_error(message);
  }
}
1000