BinMD.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/Algorithm.h"
#include "MantidAPI/CoordTransform.h"
#include "MantidAPI/IMDEventWorkspace_fwd.h"
#include "MantidDataObjects/MDBox.h"
#include "MantidDataObjects/MDEventFactory.h"
#include "MantidDataObjects/MDEventWorkspace.h"
#include "MantidDataObjects/MDHistoWorkspace.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidGeometry/MDGeometry/MDImplicitFunction.h"
#include "MantidKernel/VMD.h"
#include "MantidMDAlgorithms/SlicingAlgorithm.h"
 
namespace Mantid {
namespace Geometry {
// Forward declaration
class MDImplicitFunction;
} // namespace Geometry
namespace MDAlgorithms {
 
class MANTID_MDALGORITHMS_DLL BinMD : public SlicingAlgorithm {
public:
  BinMD();
 
  const std::string name() const override { return "BinMD"; }
  const std::string summary() const override {
    return "Take a MDEventWorkspace and bin into into a dense, "
           "multi-dimensional histogram workspace (MDHistoWorkspace).";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"SliceMDHisto", "ProjectMD", "CutMD", "SliceMD"}; }
  const std::string category() const override { return "MDAlgorithms\\Slicing"; }
 
private:
  void init() override;
  void exec() override;
 
  template <typename MDE, size_t nd> void binByIterating(typename DataObjects::MDEventWorkspace<MDE, nd>::sptr ws);
 
  template <typename MDE, size_t nd>
  void binMDBox(DataObjects::MDBox<MDE, nd> *box, const size_t *const chunkMin, const size_t *const chunkMax);
 
  Mantid::DataObjects::MDHistoWorkspace_sptr outWS;
  std::unique_ptr<Mantid::API::Progress> prog = nullptr;
  std::unique_ptr<Mantid::Geometry::MDImplicitFunction> implicitFunction;
 
  std::vector<size_t> indexMultiplier;
  signal_t *signals;
  signal_t *errors;
  signal_t *numEvents;
  bool m_accumulate{false};
};
 
} // namespace MDAlgorithms
} // namespace Mantid