MDEventWSWrapper.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 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 "MantidDataObjects/MDEvent.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidMDAlgorithms/DllConfig.h"
#include "MantidMDAlgorithms/MDWSDescription.h"
 
namespace Mantid {
namespace MDAlgorithms {
using Strings = std::vector<std::string>;
 
class MDEventWSWrapper;
// NOTICE: There is need to work with bare class-function pointers here, as
// Boost function pointers with multiple arguments
//        appear not portable to all architectures supported (Fail on MAC)
using fpVoidMethod = void (MDEventWSWrapper::*)();
using fpAddData = void (MDEventWSWrapper::*)(const float *, const uint16_t *, const uint16_t *, const uint32_t *,
                                             const coord_t *, size_t) const;
using fpCreateWS = void (MDEventWSWrapper::*)(const MDWSDescription &);
 
class MANTID_MDALGORITHMS_DLL MDEventWSWrapper {
public:
  MDEventWSWrapper();
  virtual ~MDEventWSWrapper() = default;
  static size_t getMaxNDim() { return MAX_N_DIM; }
 
  size_t nDimensions() const;
  API::IMDEventWorkspace_sptr createEmptyMDWS(const MDWSDescription &WSD);
  void addMDData(std::vector<float> &sigErr, std::vector<uint16_t> &expInfoIndex,
                 std::vector<uint16_t> &goniometerIndex, std::vector<uint32_t> &detId, std::vector<coord_t> &Coord,
                 size_t dataSize) const;
  void releaseWorkspace();
  API::IMDEventWorkspace_sptr pWorkspace() { return m_Workspace; }
  // should it be moved to the IDataObjects?
  // void refreshCentroid(){ (this->*(mdCalCentroid[m_NDimensions]))();   };
  void setMDWS(API::IMDEventWorkspace_sptr spWS);
 
  bool ifNeedsSplitting() const { return m_needSplitting; }
  void splitList(Kernel::ThreadScheduler *) { (this->*(mdBoxListSplitter[m_NDimensions]))(); }
 
private:
  enum { MAX_N_DIM = 8 };
  size_t m_NDimensions;
  API::IMDEventWorkspace_sptr m_Workspace;
 
  std::vector<fpCreateWS> wsCreator;
  std::vector<fpAddData> mdEvAddAndForget;
  std::vector<fpVoidMethod> mdCalCentroid;
  std::vector<fpVoidMethod> mdBoxListSplitter;
 
  // helper class to generate methaloop on MD workspaces dimensions:
  template <size_t i> friend class LOOP;
 
  // internal function tempates to generate as function of dimensions and
  // assign to function pointers
  template <size_t nd>
  void addMDDataND(const float *sigErr, const uint16_t *expInfoIndex, const uint16_t *goniometerIndex,
                   const uint32_t *detId, const coord_t *Coord, size_t dataSize) const;
  template <size_t nd>
  void addAndTraceMDDataND(float *sig_err, uint16_t *expInfoIndex, uint16_t *goniometerIndex, uint32_t *det_id,
                           coord_t *Coord, size_t data_size) const;
 
  template <size_t nd> void calcCentroidND();
 
  template <size_t nd> void createEmptyEventWS(const MDWSDescription &description);
 
  template <size_t nd> void splitBoxList(); // for the time being
  // void splitBoxList(Kernel::ThreadScheduler * ts);
 
  // the variable, which informs the user of MD Event WS wrapper that there are
  // boxes to split; Very simple for the time being
  mutable bool m_needSplitting;
};
 
} // namespace MDAlgorithms
} // namespace Mantid