MatrixWorkspaceMDIterator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidGeometry/MDGeometry/MDImplicitFunction.h"
#include "MantidKernel/System.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace API {
 
class MANTID_API_DLL MatrixWorkspaceMDIterator : public IMDIterator {
public:
  MatrixWorkspaceMDIterator(const MatrixWorkspace *workspace, Mantid::Geometry::MDImplicitFunction *function,
                            size_t beginWI = 0, size_t endWI = size_t(-1));
  size_t getDataSize() const override;
 
  bool valid() const override;
 
  bool next() override;
 
  bool next(size_t skip) override;
 
  void jumpTo(size_t index) 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 override;
 
  std::unique_ptr<coord_t[]> getVertexesArray(size_t &numVertices, const size_t outDimensions,
                                              const bool *maskDim) 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;
 
  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 calcWorkspacePos(size_t newWI);
 
  const MatrixWorkspace *m_ws;
 
  uint64_t m_pos;
 
  uint64_t m_max;
 
  Mantid::Geometry::MDImplicitFunction *m_function;
 
  size_t m_workspaceIndex;
 
  size_t m_xIndex;
 
  mutable Mantid::Kernel::VMD m_center;
 
  MantidVec m_X;
  MantidVec m_Y;
  mutable MantidVec m_E;
 
  mutable bool m_errorIsCached;
 
  bool m_isBinnedData;
 
  Mantid::Geometry::IMDDimension_const_sptr m_dimY;
 
  std::vector<size_t> m_startIndices;
 
  size_t m_beginWI;
 
  size_t m_endWI;
 
  double m_verticalBinSize;
 
  const SpectrumInfo &m_spectrumInfo;
};
 
} // namespace API
} // namespace Mantid