PeaksWorkspace.cpp 25.2 KB
Newer Older
1
2
#include "MantidAPI/AlgorithmFactory.h"
#include "MantidAPI/Column.h"
Peterson, Peter's avatar
Peterson, Peter committed
3
#include "MantidAPI/ColumnFactory.h"
4
#include "MantidAPI/MatrixWorkspace.h"
5
6
#include <nexus/NeXusException.hpp>
#include <nexus/NeXusFile.hpp>
Peterson, Peter's avatar
Peterson, Peter committed
7
#include "MantidAPI/WorkspaceFactory.h"
8
#include "MantidAPI/WorkspaceProperty.h"
Peterson, Peter's avatar
Peterson, Peter committed
9
#include "MantidDataObjects/PeaksWorkspace.h"
10
11
12
#include "MantidDataObjects/TableColumn.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/Peak.h"
13
14
#include "MantidKernel/Quat.h"
#include "MantidKernel/V3D.h"
15
16
17
18
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/PhysicalConstants.h"
#include "MantidKernel/Unit.h"
Peterson, Peter's avatar
Peterson, Peter committed
19
#include <algorithm>
20
#include <boost/shared_ptr.hpp>
Peterson, Peter's avatar
Peterson, Peter committed
21
22
#include <exception>
#include <fstream>
23
24
25
#include <iostream>
#include <math.h>
#include <ostream>
Peterson, Peter's avatar
Peterson, Peter committed
26
27
#include <stdio.h>
#include <stdlib.h>
28
29
30
31
32
#include <string>

using namespace Mantid::API;
using namespace Mantid::Kernel;
using namespace Mantid::Geometry;
Peterson, Peter's avatar
Peterson, Peter committed
33
34
35

namespace Mantid
{
Owen Arnold's avatar
Owen Arnold committed
36
  namespace DataObjects
37
  {
Owen Arnold's avatar
Owen Arnold committed
38
39
    /// Register the workspace as a type
    DECLARE_WORKSPACE(PeaksWorkspace);
40

Owen Arnold's avatar
Owen Arnold committed
41
//  Kernel::Logger& PeaksWorkspace::g_log = Kernel::Logger::get("PeaksWorkspace");
42

Owen Arnold's avatar
Owen Arnold committed
43
44
45
46
47
48
49
50
51
52
//---------------------------------------------------------------------------------------------
    /** Constructor. Create a table with all the required columns.
     *
     * @return PeaksWorkspace object
     */
    PeaksWorkspace::PeaksWorkspace() :
        IPeaksWorkspace()
    {
      initColumns();
    }
53

Owen Arnold's avatar
Owen Arnold committed
54
55
56
57
58
59
60
61
62
63
    //---------------------------------------------------------------------------------------------
    /** Virtual constructor. Clone method to duplicate the peaks workspace.
     *
     * @return PeaksWorkspace object
     */
    PeaksWorkspace* PeaksWorkspace::clone() const
    {
      //Deep copy via copy construtor.
      return new PeaksWorkspace(*this);
    }
64

Owen Arnold's avatar
Owen Arnold committed
65
66
67
68
69
70
71
72
73
74
75
    //---------------------------------------------------------------------------------------------
    /** Copy constructor
     *
     * @param other :: other PeaksWorkspace to copy from
     * @return
     */
    PeaksWorkspace::PeaksWorkspace(const PeaksWorkspace & other) :
        IPeaksWorkspace(other), peaks(other.peaks)
    {
      initColumns();
    }
76

Owen Arnold's avatar
Owen Arnold committed
77
78
79
80
81
82
    //---------------------------------------------------------------------------------------------
    /** Clone a shared pointer
     *
     * @return copy of the peaksworkspace
     */
    boost::shared_ptr<PeaksWorkspace> PeaksWorkspace::clone()
83
    {
Owen Arnold's avatar
Owen Arnold committed
84
85
      // Copy construct and return
      return boost::shared_ptr<PeaksWorkspace>(new PeaksWorkspace(*this));
86
87
    }

Owen Arnold's avatar
Owen Arnold committed
88
89
90
91
92
    //=====================================================================================
    //=====================================================================================
    /** Comparator class for sorting peaks by one or more criteria
     */
    class PeakComparator: public std::binary_function<Peak, Peak, bool>
93
    {
Owen Arnold's avatar
Owen Arnold committed
94
95
96
97
98
99
100
101
102
    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.
       */
      PeakComparator(std::vector<std::pair<std::string, bool> > & criteria) :
          criteria(criteria)
103
      {
Owen Arnold's avatar
Owen Arnold committed
104
105
106
107
108
109
      }

      /** Compare two peaks using the stored criteria */
      inline bool operator()(const Peak& a, const Peak& b)
      {
        for (size_t i = 0; i < criteria.size(); i++)
110
        {
Owen Arnold's avatar
Owen Arnold committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
          std::string & col = criteria[i].first;
          bool ascending = criteria[i].second;
          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);
          }
          // Flip the sign of comparison if descending.
          if (ascending)
            return lessThan;
          else
            return !lessThan;

140
        }
Owen Arnold's avatar
Owen Arnold committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        // If you reach here, all criteria were ==; so not <, so return false
        return false;
      }
    };

    //---------------------------------------------------------------------------------------------
    /** 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);
    }

    //---------------------------------------------------------------------------------------------
    /** @return the number of peaks
     */
    int PeaksWorkspace::getNumberPeaks() const
    {
      return int(peaks.size());
    }
166

Owen Arnold's avatar
Owen Arnold committed
167
168
169
170
171
172
173
174
175
    //---------------------------------------------------------------------------------------------
    /** 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.");
176
      }
Owen Arnold's avatar
Owen Arnold committed
177
      peaks.erase(peaks.begin() + peakNum);
178
179
    }

Owen Arnold's avatar
Owen Arnold committed
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    //---------------------------------------------------------------------------------------------
    /** Add a peak to the list
     * @param ipeak :: Peak object to add (copy) into this.
     */
    void PeaksWorkspace::addPeak(const API::IPeak& ipeak)
    {
      if (dynamic_cast<const Peak*>(&ipeak))
      {
        peaks.push_back((const Peak&) ipeak);
      }
      else
      {
        peaks.push_back(Peak(ipeak));
      }
    }
195

Owen Arnold's avatar
Owen Arnold committed
196
197
198
199
200
    //---------------------------------------------------------------------------------------------
    /** Return a reference to the Peak
     * @param peakNum :: index of the peak to get.
     * @return a reference to a Peak object.
     */
Owen Arnold's avatar
Owen Arnold committed
201
    Peak & PeaksWorkspace::getPeak(const int peakNum)
Owen Arnold's avatar
Owen Arnold committed
202
203
204
205
206
207
208
    {
      if (peakNum >= static_cast<int>(peaks.size()) || peakNum < 0)
      {
        throw std::invalid_argument("PeaksWorkspace::getPeak(): peakNum is out of range.");
      }
      return peaks[peakNum];
    }
209

Owen Arnold's avatar
Owen Arnold committed
210
211
212
213
214
    //---------------------------------------------------------------------------------------------
    /** Return a const reference to the Peak
     * @param peakNum :: index of the peak to get.
     * @return a reference to a Peak object.
     */
Owen Arnold's avatar
Owen Arnold committed
215
    const Peak & PeaksWorkspace::getPeak(const int peakNum) const
Owen Arnold's avatar
Owen Arnold committed
216
217
218
219
220
221
222
    {
      if (peakNum >= static_cast<int>(peaks.size()) || peakNum < 0)
      {
        throw std::invalid_argument("PeaksWorkspace::getPeak(): peakNum is out of range.");
      }
      return peaks[peakNum];
    }
223

Owen Arnold's avatar
Owen Arnold committed
224
225
226
227
228
229
230
    //---------------------------------------------------------------------------------------------
    /** 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
     * @param detectorDistance :: distance between the sample and the detector.
     * @return a pointer to a new Peak object.
     */
    API::IPeak* PeaksWorkspace::createPeak(Kernel::V3D QLabFrame, double detectorDistance) const
231
    {
Owen Arnold's avatar
Owen Arnold committed
232
      return new Peak(this->getInstrument(), QLabFrame, detectorDistance);
233
    }
234

235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
   /**
    * Returns selected information for a "peak" at QLabFrame.
    *
    * @param QLabFrame  a postion in Q-space. A peak does not have to be at that position
    * @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> >PeaksWorkspace::PeakInfo(Kernel::V3D QLabFrame ) const
    {
      std::vector<std::pair< std::string,std::string > > Result;

      std::pair< std::string,std::string > QMag( "|Q|", boost::lexical_cast<std::string>(QLabFrame.norm()));
      Result.push_back( QMag );

      std::pair< std::string,std::string > dspc( "d-spacing", boost::lexical_cast<std::string>(1.0/QLabFrame.norm()));
      Result.push_back( dspc);


      std::pair< std::string,std::string > Qlab("Qlab",QLabFrame.toString());
      Result.push_back(Qlab);

      try{
        API::IPeak* peak = createPeak( QLabFrame);


        std::pair< std::string,std::string > wl( "wl", boost::lexical_cast<std::string>(peak->getWavelength()));
        Result.push_back( wl );

        if( peak->findDetector())
        {
           V3D detPos = peak->getDetPos();
           std::pair< std::string,std::string > detpos( "pos", boost::lexical_cast<std::string>(peak->getDetPos()));
           Result.push_back( detpos );


           std::pair< std::string,std::string > tof( "tof", boost::lexical_cast<std::string>(peak->getTOF()));
           Result.push_back( tof );

           std::pair< std::string,std::string > Energy( "Energy", boost::lexical_cast<std::string>(peak->getFinalEnergy()));
           Result.push_back( Energy );

           std::pair< std::string,std::string > row( "row", boost::lexical_cast<std::string>(peak->getRow()));
           Result.push_back( row );


           std::pair< std::string,std::string > col( "col", boost::lexical_cast<std::string>(peak->getCol()));
           Result.push_back( col );


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

           std::pair< std::string,std::string > scat( "Scattering Angle",boost::lexical_cast<std::string>(peak->getScattering() ));
           Result.push_back( scat );

           int seqNum=-1;
           double minDist= 10000000;
           for( int i = 0; i < getNumberPeaks() ; i++ )
             if( detPos.distance(getPeak(i).getDetPos() )< minDist)
             {
               minDist = detPos.distance( getPeak( i ).getDetPos() );
               seqNum = i+1;
             }

           std::pair< std::string,std::string > SeqNum( "Sequence Num",boost::lexical_cast<std::string>(seqNum));
           Result.push_back( SeqNum );

        }




      }catch(...)//Impossible position
      {

      }

      return Result;
    }
Owen Arnold's avatar
Owen Arnold committed
315
316
317
    //---------------------------------------------------------------------------------------------
    /** Return a reference to the Peaks vector */
    std::vector<Peak> & PeaksWorkspace::getPeaks()
318
    {
Owen Arnold's avatar
Owen Arnold committed
319
      return peaks;
320
    }
Owen Arnold's avatar
Owen Arnold committed
321
322
323

    /** Return a const reference to the Peaks vector */
    const std::vector<Peak> & PeaksWorkspace::getPeaks() const
324
    {
Owen Arnold's avatar
Owen Arnold committed
325
      return peaks;
326
327
    }

Owen Arnold's avatar
Owen Arnold committed
328
329
330
331
    /** Getter for the integration status.
     @return TRUE if it has been integrated using a peak integration algorithm.
     */
    bool PeaksWorkspace::hasIntegratedPeaks() const
332
    {
Owen Arnold's avatar
Owen Arnold committed
333
334
335
336
      bool ret = false;
      const std::string peaksIntegrated = "PeaksIntegrated";
      if (this->run().hasProperty(peaksIntegrated))
      {
337
338
        const int value = boost::lexical_cast<int>(this->run().getProperty(peaksIntegrated)->value());
        ret = (value != 0);
Owen Arnold's avatar
Owen Arnold committed
339
340
      }
      return ret;
341
    }
342

Owen Arnold's avatar
Owen Arnold committed
343
344
345
    //---------------------------------------------------------------------------------------------
    /// Return the memory used in bytes
    size_t PeaksWorkspace::getMemorySize() const
346
    {
Owen Arnold's avatar
Owen Arnold committed
347
      return getNumberPeaks() * sizeof(Peak);
348
    }
349

Owen Arnold's avatar
Owen Arnold committed
350
351
352
353
354
355
356
357
358
359
360
    //---------------------------------------------------------------------------------------------
    /**
     *  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");
361

Owen Arnold's avatar
Owen Arnold committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
      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;
        }
      }
377

Owen Arnold's avatar
Owen Arnold committed
378
379
      return table;
    }
380

Owen Arnold's avatar
Owen Arnold committed
381
382
383
    //---------------------------------------------------------------------------------------------
    /** Destructor */
    PeaksWorkspace::~PeaksWorkspace()
384
385
    {
    }
Peterson, Peter's avatar
Peterson, Peter committed
386

Owen Arnold's avatar
Owen Arnold committed
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
    //---------------------------------------------------------------------------------------------
    /** 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");
    }
410

Owen Arnold's avatar
Owen Arnold committed
411
412
413
414
415
416
    //---------------------------------------------------------------------------------------------
    /**
     * Add a PeakColumn
     * @param name :: The name of the column
     **/
    void PeaksWorkspace::addPeakColumn(const std::string& name)
417
    {
Owen Arnold's avatar
Owen Arnold committed
418
419
420
421
422
      // Create the PeakColumn.
      columns.push_back(
          boost::shared_ptr<DataObjects::PeakColumn>(new DataObjects::PeakColumn(this->peaks, name)));
      // Cache the names
      columnNames.push_back(name);
423
424
    }

Owen Arnold's avatar
Owen Arnold committed
425
426
427
428
429
430
431
432
433
    //---------------------------------------------------------------------------------------------
    /// @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.");
    }
434

Owen Arnold's avatar
Owen Arnold committed
435
436
437
438
439
440
441
442
    //---------------------------------------------------------------------------------------------
    /// 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];
    }
Peterson, Peter's avatar
Peterson, Peter committed
443

Owen Arnold's avatar
Owen Arnold committed
444
445
446
447
448
449
450
451
    //---------------------------------------------------------------------------------------------
    /// 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];
    }
Peterson, Peter's avatar
Peterson, Peter committed
452

Owen Arnold's avatar
Owen Arnold committed
453
454
    void PeaksWorkspace::saveNexus(::NeXus::File * file) const
    {
Peterson, Peter's avatar
Peterson, Peter committed
455

Owen Arnold's avatar
Owen Arnold committed
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
      //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);
      std::vector<double> goniometerMatrix(9 * np);

      // Populate column vectors from Peak Workspace
      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();
        {
          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[1][2];
        }
        // etc.
      }
Peterson, Peter's avatar
Peterson, Peter committed
508

Owen Arnold's avatar
Owen Arnold committed
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
      // Start Peaks Workspace in Nexus File
      std::string specifyInteger = "An integer";
      std::string specifyDouble = "A double";
      file->makeGroup("peaks_workspace", "NXentry", true);  // For when peaksWorkspace can be loaded

      // Detectors column
      file->writeData("column_1", detectorID);
      file->openData("column_1");
      file->putAttr("name", "Dectector ID");
      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
      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();

      // QLab & QSample are calculated and do not need to be saved

      file->closeGroup(); // end of peaks workpace
Peterson, Peter's avatar
Peterson, Peter committed
640

Owen Arnold's avatar
Owen Arnold committed
641
    }
642

Owen Arnold's avatar
Owen Arnold committed
643
644
645
646
647
648
649
650
    /**
     * Set the special Q3D coordinate system.
     * @param coordinateSystem : Option to set.
     */
    void PeaksWorkspace::setCoordinateSystem(const Mantid::API::SpecialCoordinateSystem coordinateSystem)
    {
      this->mutableRun().addProperty("CoordinateSystem", (int)coordinateSystem, true);
    }
651

Owen Arnold's avatar
Owen Arnold committed
652
653
654
655
    /**
     * @return the special Q3D coordinate system.
     */
    Mantid::API::SpecialCoordinateSystem PeaksWorkspace::getSpecialCoordinateSystem() const
656
    {
Owen Arnold's avatar
Owen Arnold committed
657
658
659
660
661
662
663
664
665
      Mantid::API::SpecialCoordinateSystem result = None;
      try
      {
        Property* prop = this->run().getProperty("CoordinateSystem");
        PropertyWithValue<int>* p = dynamic_cast<PropertyWithValue<int>*>(prop);
        int temp = *p;
        result = (SpecialCoordinateSystem) temp;
      }
      catch (Mantid::Kernel::Exception::NotFoundError&)
666
667
      {
      }
Owen Arnold's avatar
Owen Arnold committed
668
      return result;
669
    }
670

671
    // prevent shared pointer from deleting this
Owen Arnold's avatar
Owen Arnold committed
672
673
674
675
676
677
    struct NullDeleter
    {
      template<typename T> void operator()(T*)
      {
      }
    };
678
    /**Get access to shared pointer containing workspace porperties, cashes the shared pointer
Owen Arnold's avatar
Owen Arnold committed
679
680
681
682
683
     into internal class variable to not allow shared pointer being deleted */
    API::LogManager_sptr PeaksWorkspace::logs()
    {
      if (m_logCash)
        return m_logCash;
684

Owen Arnold's avatar
Owen Arnold committed
685
686
687
      m_logCash = API::LogManager_sptr(&(this->mutableRun()), NullDeleter());
      return m_logCash;
    }
688

Owen Arnold's avatar
Owen Arnold committed
689
  }
Peterson, Peter's avatar
Peterson, Peter committed
690
}
691
692
693
694
695
696
697
698
699

///\cond TEMPLATE

namespace Mantid
{
  namespace Kernel
  {

    template<> DLLExport
Owen Arnold's avatar
Owen Arnold committed
700
701
    Mantid::DataObjects::PeaksWorkspace_sptr IPropertyManager::getValue<
        Mantid::DataObjects::PeaksWorkspace_sptr>(const std::string &name) const
702
    {
Owen Arnold's avatar
Owen Arnold committed
703
704
      PropertyWithValue<Mantid::DataObjects::PeaksWorkspace_sptr>* prop = dynamic_cast<PropertyWithValue<
          Mantid::DataObjects::PeaksWorkspace_sptr>*>(getPointerToProperty(name));
705
706
707
708
709
710
      if (prop)
      {
        return *prop;
      }
      else
      {
Owen Arnold's avatar
Owen Arnold committed
711
712
        std::string message = "Attempt to assign property " + name
            + " to incorrect type. Expected PeaksWorkspace.";
713
714
715
716
717
        throw std::runtime_error(message);
      }
    }

    template<> DLLExport
Owen Arnold's avatar
Owen Arnold committed
718
719
    Mantid::DataObjects::PeaksWorkspace_const_sptr IPropertyManager::getValue<
        Mantid::DataObjects::PeaksWorkspace_const_sptr>(const std::string &name) const
720
    {
Owen Arnold's avatar
Owen Arnold committed
721
722
      PropertyWithValue<Mantid::DataObjects::PeaksWorkspace_sptr>* prop = dynamic_cast<PropertyWithValue<
          Mantid::DataObjects::PeaksWorkspace_sptr>*>(getPointerToProperty(name));
723
724
725
726
727
728
      if (prop)
      {
        return prop->operator()();
      }
      else
      {
Owen Arnold's avatar
Owen Arnold committed
729
730
        std::string message = "Attempt to assign property " + name
            + " to incorrect type. Expected const PeaksWorkspace.";
731
732
733
734
735
736
737
        throw std::runtime_error(message);
      }
    }

  } // namespace Kernel
} // namespace Mantid

738
///\endcond TEMPLATE