IMDDimension.cpp

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 +
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidGeometry/MDGeometry/MDFrame.h"
#include "MantidGeometry/MDGeometry/MDHistoDimension.h"
#include "MantidKernel/UnitLabel.h"
#include "MantidKernel/WarningSuppressions.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include <memory>
#include <stdexcept>
 
#include <boost/python/class.hpp>
#include <boost/python/copy_const_reference.hpp>
#include <boost/python/register_ptr_to_python.hpp>
#include <boost/python/return_internal_reference.hpp>
 
using namespace Mantid::Geometry;
using namespace boost::python;
 
GET_POINTER_SPECIALIZATION(IMDDimension)
 
GNU_DIAG_OFF("strict-aliasing")
 
namespace {
std::string getUnitsAsStr(const IMDDimension &self) { return self.getUnits().ascii(); }
 
std::shared_ptr<MDFrame> getMDFrame(const IMDDimension &self) {
  return std::shared_ptr<MDFrame>(self.getMDFrame().clone());
}
 
MDHistoDimension &asEditableDimension(IMDDimension &self) {
  auto *histoDimension = dynamic_cast<MDHistoDimension *>(&self);
  if (!histoDimension) {
    throw std::runtime_error("Editing the name or units is only supported for MDHistoWorkspace dimensions.");
  }
  return *histoDimension;
}
 
void setName(IMDDimension &self, const std::string &name) { asEditableDimension(self).setName(name); }
 
void setUnits(IMDDimension &self, const std::string &units) {
  asEditableDimension(self).setUnits(Mantid::Kernel::UnitLabel(units));
}
} // namespace
 
//--------------------------------------------------------------------------------------
// Deprecated function
//--------------------------------------------------------------------------------------
std::string getName(const IMDDimension &self) {
  if (PyErr_Warn(PyExc_DeprecationWarning, ".getName() is deprecated. Use .name instead.") < 0)
    throw boost::python::error_already_set();
  return self.getName();
}
 
void export_IMDDimension() {
  register_ptr_to_python<std::shared_ptr<IMDDimension>>();
 
  class_<IMDDimension, boost::noncopyable>("IMDDimension", no_init)
      .def("getName", &getName, arg("self"),
           "Return the name of the dimension "
           "as can be displayed along the "
           "axis")
      .add_property("name", &IMDDimension::getName,
                    "Return the name of the dimension as can be displayed "
                    "along the axis")
      .def("getMaximum", &IMDDimension::getMaximum, arg("self"), "Return the maximum extent of this dimension")
      .def("getMinimum", &IMDDimension::getMinimum, arg("self"), "Return the maximum extent of this dimension")
      .def("getNBins", &IMDDimension::getNBins, arg("self"),
           "Return the number of bins dimension have (an integrated has one). "
           "A axis directed along dimension would have getNBins+1 axis points.")
      .def("getNBoundaries", &IMDDimension::getNBoundaries, arg("self"),
           "Return the number of bins boundaries (axis points) dimension have "
           "(an integrated has two). "
           "A axis directed along dimension would have getNBins+1 axis points.")
      .def("getX", &IMDDimension::getX, (arg("self"), arg("ind")), "Return coordinate of the axis at the given index")
      .def("getBinWidth", &IMDDimension::getBinWidth, arg("self"), "Return the width of each bin.")
      .def("getDimensionId", &IMDDimension::getDimensionId, arg("self"), return_value_policy<copy_const_reference>(),
           "Return a short name which identify the dimension among other "
           "dimension."
           "A dimension can be usually find by its ID and various  ")
      .def("getUnits", &getUnitsAsStr, arg("self"), "Return the units associated with this dimension.")
      .def("getMDFrame", &getMDFrame, arg("self"), "Return the multidimensional frame for this dimension.")
      .def("setName", &setName, (arg("self"), arg("name")),
           "Set the name of the dimension as displayed along the axis. Only "
           "supported for MDHistoWorkspace dimensions.")
      .def("setUnits", &setUnits, (arg("self"), arg("units")),
           "Set the units of the dimension. Only supported for MDHistoWorkspace "
           "dimensions whose frame permits it (HKL and general frames); an HKL "
           "dimension accepts 'r.l.u.' or an inverse-Angstrom-style label such as "
           "'in 2.5 A^-1'. Raises for a frame with a fixed unit (e.g. QSample/QLab) "
           "or a label the frame does not accept.");
}