ConvToMDHistoWS.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/Workspace2D.h"
#include "MantidMDAlgorithms/ConvToMDBase.h"
#include "MantidMDAlgorithms/MDEventWSWrapper.h"
#include "MantidMDAlgorithms/MDTransfInterface.h"
 
namespace Mantid {
 
// Forward declaration
namespace API {
class Progress;
}
namespace MDAlgorithms {
//-----------------------------------------------
class ConvToMDHistoWS : public ConvToMDBase {
 
public:
  ConvToMDHistoWS();
 
  size_t initialize(const MDWSDescription &WSD, std::shared_ptr<MDEventWSWrapper> inWSWrapper,
                    bool ignoreZeros) override;
 
  void runConversion(API::Progress *pProgress) override;
 
private:
  // the number of spectra to process by single computational thread;
  size_t m_spectraChunk;
  // the size of temporary buffer, each thread stores data in before adding
  // these data to target MD workspace;
  size_t m_bufferSize;
  // internal function used to identify m_spectraChunk and m_bufferSize
  void estimateThreadWork(size_t nThreads, size_t specSize, size_t nPointsToProcess);
  // the function does a chunk of work. Expected to run on a thread.
  size_t conversionChunk(size_t startSpectra) override;
};
 
} // namespace MDAlgorithms
} // namespace Mantid