Detector.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/Instrument/Detector.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidGeometry/Instrument/ParameterMap.h"
#include <boost/python/class.hpp>
 
using Mantid::Geometry::Detector;
using Mantid::Geometry::IDetector;
using Mantid::Geometry::ObjComponent;
using namespace boost::python;
 
namespace {
bool isMaskedDeprecated(const Detector &self) {
  PyErr_Warn(PyExc_DeprecationWarning, "'Detector::isMasked' is deprecated, "
                                       "use 'DetectorInfo::isMasked' instead.");
  const auto &detInfo = self.parameterMap().detectorInfo();
  return detInfo.isMasked(self.index());
}
 
bool isMonitorDeprecated(const Detector &self) {
  PyErr_Warn(PyExc_DeprecationWarning, "'Detector::isMonitor' is deprecated, "
                                       "use 'DetectorInfo::isMonitor' instead.");
  const auto &detInfo = self.parameterMap().detectorInfo();
  return detInfo.isMonitor(self.index());
}
} // namespace
 
void export_Detector() {
  class_<Detector, bases<IDetector, ObjComponent>, boost::noncopyable>("Detector", no_init)
      .def("isMasked", &isMaskedDeprecated, arg("self"),
           "Returns the value of the masked flag. True means ignore this "
           "detector")
      .def("isMonitor", &isMonitorDeprecated, arg("self"),
           "Returns True if the detector is marked as a monitor in the IDF");
}