MDHistoDimension.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 <utility>
 
#include "MantidGeometry/DllConfig.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDFrame.h"
#include "MantidGeometry/MDGeometry/UnknownFrame.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/MDUnit.h"
#include "MantidKernel/MDUnitFactory.h"
#include "MantidKernel/VMD.h"
 
namespace Mantid {
namespace Geometry {
 
class MANTID_GEOMETRY_DLL MDHistoDimension : public IMDDimension {
public:
  MDHistoDimension(std::string name, std::string ID, const MDFrame &frame, coord_t min, coord_t max, size_t numBins)
      : m_name(std::move(name)), m_dimensionId(std::move(ID)), m_frame(frame.clone()), m_min(min), m_max(max),
        m_numBins(numBins), m_binWidth((max - min) / static_cast<coord_t>(numBins)) {
    if (max < min) {
      throw std::invalid_argument("Error making MDHistoDimension. Cannot have "
                                  "dimension with min > max");
    }
  }
 
  MDHistoDimension(const IMDDimension *other)
      : m_name(other->getName()), m_dimensionId(other->getDimensionId()), m_frame(other->getMDFrame().clone()),
        m_min(other->getMinimum()), m_max(other->getMaximum()), m_numBins(other->getNBins()),
        m_binWidth(other->getBinWidth()) {}
 
  std::string getName() const override { return m_name; }
 
  const MDFrame &getMDFrame() const override { return *m_frame; }
 
  const Kernel::UnitLabel getUnits() const override { return m_frame->getUnitLabel(); }
 
  const Kernel::MDUnit &getMDUnits() const override { return m_frame->getMDUnit(); }
 
  const std::string &getDimensionId() const override { return m_dimensionId; }
 
  coord_t getMaximum() const override { return m_max; }
 
  coord_t getMinimum() const override { return m_min; }
 
  size_t getNBins() const override { return m_numBins; }
 
  size_t getNBoundaries() const override { return m_numBins + 1; }
 
  std::string toXMLString() const override;
 
  coord_t getX(size_t index) const override { return static_cast<coord_t>(index) * m_binWidth + m_min; }
 
  coord_t getBinWidth() const override { return m_binWidth; }
 
  void setRange(size_t nBins, coord_t min, coord_t max) override {
    if (max < min) {
      throw std::invalid_argument("Error making MDHistoDimension. Cannot have "
                                  "dimension with min > max");
    }
    m_min = min;
    m_max = max;
    m_numBins = nBins;
    m_binWidth = (m_max - m_min) / static_cast<coord_t>(m_numBins);
  }
 
  void setMDFrame(const MDFrame &frame) { m_frame.reset(frame.clone()); }
 
private:
  std::string m_name;
 
  std::string m_dimensionId;
 
  Geometry::MDFrame_uptr m_frame;
 
  coord_t m_min;
 
  coord_t m_max;
 
  size_t m_numBins;
 
  coord_t m_binWidth;
};
 
using MDHistoDimension_sptr = std::shared_ptr<MDHistoDimension>;
 
using MDHistoDimension_const_sptr = std::shared_ptr<const MDHistoDimension>;
 
} // namespace Geometry
} // namespace Mantid