MDBoxIterator.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/IMDIterator.h"
#include "MantidDataObjects/MDBox.h"
#include "MantidDataObjects/MDBoxBase.h"
#include "MantidDataObjects/MDLeanEvent.h"
#include "MantidDataObjects/SkippingPolicy.h"
#include "MantidGeometry/MDGeometry/MDImplicitFunction.h"
 
namespace Mantid {
namespace DataObjects {
// Forward declaration.
class SkippingPolicy;
 
TMDE_CLASS
class MANTID_DATAOBJECTS_DLL MDBoxIterator : public Mantid::API::IMDIterator {
public:
  MDBoxIterator(API::IMDNode *topBox, size_t maxDepth, bool leafOnly,
                Mantid::Geometry::MDImplicitFunction *function = nullptr);
  MDBoxIterator(API::IMDNode *topBox, size_t maxDepth, bool leafOnly, SkippingPolicy *skippingPolicy,
                Mantid::Geometry::MDImplicitFunction *function = nullptr);
  MDBoxIterator(std::vector<API::IMDNode *> &boxes, size_t begin, size_t end);
  void init(std::vector<API::IMDNode *> &boxes, size_t begin, size_t end);
  ~MDBoxIterator() override;
 
  MDBoxBase<MDE, nd> *getBox() const { return (m_current); }
 
  size_t getDataSize() const override;
 
  bool valid() const override;
 
  void jumpTo(size_t index) override;
 
  bool next() override;
 
  bool next(size_t skip) override;
 
  signal_t getNormalizedSignal() const override;
 
  signal_t getNormalizedError() const override;
 
  signal_t getSignal() const override;
 
  signal_t getError() const override;
 
  std::unique_ptr<coord_t[]> getVertexesArray(size_t &numVertices, const size_t outDimensions,
                                              const bool *maskDim) const override;
 
  std::unique_ptr<coord_t[]> getVertexesArray(size_t &numVertices) const override;
 
  Mantid::Kernel::VMD getCenter() const override;
 
  size_t getNumEvents() const override;
 
  uint16_t getInnerExpInfoIndex(size_t index) const override;
 
  uint16_t getInnerGoniometerIndex(size_t index) const override;
 
  int32_t getInnerDetectorID(size_t index) const override;
 
  coord_t getInnerPosition(size_t index, size_t dimension) const override;
 
  signal_t getInnerSignal(size_t index) const override;
 
  signal_t getInnerError(size_t index) const override;
 
  bool getIsMasked() const override;
 
  size_t getPosition() const { return m_pos; }
 
  std::vector<size_t> findNeighbourIndexes() const override;
 
  std::vector<size_t> findNeighbourIndexesFaceTouching() const override;
 
  size_t getLinearIndex() const override;
 
  bool isWithinBounds(size_t index) const override;
 
private:
  void commonConstruct(API::IMDNode *topBox, size_t maxDepth, bool leafOnly,
                       Mantid::Geometry::MDImplicitFunction *function);
 
  void getEvents() const;
 
  void releaseEvents() const;
 
  size_t m_pos;
 
  size_t m_max;
 
  std::vector<API::IMDNode *> m_boxes;
 
  MDBoxBase<MDE, nd> *m_current;
 
  mutable MDBox<MDE, nd> *m_currentMDBox;
 
  mutable const std::vector<MDE> *m_events;
 
  // Skipping policy, controlls recursive calls to next().
  SkippingPolicy_scptr m_skippingPolicy;
};
 
} // namespace DataObjects
} // namespace Mantid