IMDIterator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/DllConfig.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDTypes.h"
#include "MantidKernel/VMD.h"
#include <vector>
 
namespace Mantid {
 
namespace API {
 
enum MDNormalization {
  NoNormalization = 0,
  VolumeNormalization = 1,
  NumEventsNormalization = 2
};
 
class MANTID_API_DLL IMDIterator {
public:
  IMDIterator();
  virtual ~IMDIterator() = default;
 
  void setNormalization(Mantid::API::MDNormalization normalization);
  Mantid::API::MDNormalization getNormalization() const;
 
  virtual size_t getDataSize() const = 0;
 
  virtual bool next() = 0;
 
  virtual bool valid() const = 0;
 
  virtual void jumpTo(size_t index) = 0;
 
  virtual bool next(size_t skip) = 0;
 
  virtual signal_t getNormalizedSignal() const = 0;
 
  virtual signal_t getNormalizedError() const = 0;
 
  virtual signal_t getSignal() const = 0;
 
  virtual signal_t getError() const = 0;
 
  virtual std::unique_ptr<coord_t[]> getVertexesArray(size_t &numVertices) const = 0;
 
  virtual std::unique_ptr<coord_t[]> getVertexesArray(size_t &numVertices, const size_t outDimensions,
                                                      const bool *maskDim) const = 0;
 
  virtual Mantid::Kernel::VMD getCenter() const = 0;
 
  virtual size_t getNumEvents() const = 0;
 
  virtual uint16_t getInnerExpInfoIndex(size_t index) const = 0;
 
  virtual uint16_t getInnerGoniometerIndex(size_t index) const = 0;
 
  virtual int32_t getInnerDetectorID(size_t index) const = 0;
 
  virtual coord_t getInnerPosition(size_t index, size_t dimension) const = 0;
 
  virtual signal_t getInnerSignal(size_t index) const = 0;
 
  virtual signal_t getInnerError(size_t index) const = 0;
 
  virtual bool getIsMasked() const = 0;
 
  virtual std::vector<size_t> findNeighbourIndexes() const = 0;
 
  virtual std::vector<size_t> findNeighbourIndexesFaceTouching() const = 0;
 
  virtual size_t getLinearIndex() const = 0;
 
  virtual bool isWithinBounds(size_t index) const = 0;
 
protected:
  Mantid::API::MDNormalization m_normalization;
};
 
} // namespace API
} // namespace Mantid