SingleCrystalDiffractionTestHelper.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
#pragma once
 
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidDataObjects/PeaksWorkspace.h"
#include "MantidFrameworkTestHelpers/ComponentCreationHelper.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidKernel/NearestNeighbours.h"
 
#include <random>
#include <tuple>
 
namespace Mantid {
namespace SingleCrystalDiffractionTestHelper {
 
class WorkspaceBuilder {
 
public:
  WorkspaceBuilder() : m_numPixels(0), m_totalNPixels(0), m_outputAsHistogram(false), m_generator(std::mt19937()()){};
 
  void setNumPixels(const int numPixels);
  void outputAsHistogram(const bool outputAsHistogram) { m_outputAsHistogram = outputAsHistogram; };
  void setRebinParameters(const std::vector<double> &rebinParams) { m_rebinParams = rebinParams; }
  void addBackground(const bool useBackground) { m_useBackground = useBackground; }
  void setBackgroundParameters(const int nEvents, const double detRange, const double tofRange) {
    m_backgroundParameters = std::make_tuple(nEvents, detRange, tofRange);
  }
  void setRandomSeed(const int seed) { m_generator.seed(seed); }
  void addPeakByHKL(const Mantid::Kernel::V3D &hkl, const int numEvents,
                    const std::tuple<double, double, double> &sigmas);
  std::tuple<Mantid::API::MatrixWorkspace_sptr, Mantid::DataObjects::PeaksWorkspace_sptr> build();
 
private:
  using HKLPeakDescriptor = std::tuple<Mantid::Kernel::V3D, int, std::tuple<double, double, double>>;
 
  void createInstrument();
  void createPeaksWorkspace();
  void createEventWorkspace();
  void createNeighbourSearch();
  void createPeaks();
  void createPeak(const HKLPeakDescriptor &descriptor);
  void createBackground(const int peakIndex);
  void rebinWorkspace();
 
  std::unique_ptr<Mantid::Kernel::NearestNeighbours<3>> m_detectorSearcher;
  std::vector<HKLPeakDescriptor> m_peakDescriptors;
  Mantid::Geometry::Instrument_sptr m_instrument;
  Mantid::API::MatrixWorkspace_sptr m_workspace;
  Mantid::DataObjects::EventWorkspace_sptr m_eventWorkspace;
  Mantid::DataObjects::PeaksWorkspace_sptr m_peaksWorkspace;
 
  // Instance variables for builder settings
 
  int m_numPixels;
  int m_totalNPixels;
  bool m_outputAsHistogram;
  bool m_useBackground;
  std::vector<double> m_rebinParams;
  std::tuple<int, double, double> m_backgroundParameters;
 
  // Other instance varianbles
 
  std::mt19937 m_generator;
};
} // namespace SingleCrystalDiffractionTestHelper
} // namespace Mantid