GridDetector.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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/GridDetector.h"
#include "MantidGeometry/Instrument/CompAssembly.h"
#include "MantidGeometry/Instrument/GridDetectorPixel.h"
#include "MantidPythonInterface/core/GetPointer.h"
#include "MantidPythonInterface/core/StlExportDefinitions.h"
#include <boost/python/class.hpp>
#include <boost/python/copy_const_reference.hpp>
#include <boost/python/register_ptr_to_python.hpp>
#include <boost/python/return_value_policy.hpp>
 
using Mantid::PythonInterface::std_vector_exporter;
using namespace Mantid::Geometry;
using namespace boost::python;
 
GET_POINTER_SPECIALIZATION(GridDetector)
 
 
void export_GridDetector() {
  register_ptr_to_python<std::shared_ptr<GridDetector>>();
  register_ptr_to_python<GridDetector_const_sptr>();
 
  std_vector_exporter<GridDetector_const_sptr, /*NoProxy=*/true>::wrap("std_vector_grid_detector");
 
  class_<GridDetector, bases<CompAssembly, IObjComponent>, boost::noncopyable>("GridDetector", no_init)
      .def("xpixels", &GridDetector::xpixels, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the number of pixels in the X direction")
      .def("ypixels", &GridDetector::ypixels, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the number of pixels in the Y direction")
      .def("zpixels", &GridDetector::zpixels, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the number of pixels in the Z direction")
      .def("xstep", &GridDetector::xstep, arg("self"), "Returns the step size in the X direction")
      .def("ystep", &GridDetector::ystep, arg("self"), "Returns the step size in the Y direction")
      .def("zstep", &GridDetector::zstep, arg("self"), "Returns the step size in the Z direction")
      .def("xsize", &GridDetector::xsize, arg("self"), "Returns the size in the X direction")
      .def("ysize", &GridDetector::ysize, arg("self"), "Returns the size in the Y direction")
      .def("zsize", &GridDetector::zsize, arg("self"), "Returns the size in the Z direction")
      .def("xstart", &GridDetector::xstart, arg("self"), "Returns the start position in the X direction")
      .def("ystart", &GridDetector::ystart, arg("self"), "Returns the start position in the Y direction")
      .def("zstart", &GridDetector::zstart, arg("self"), "Returns the start position in the Z direction")
      .def("idstart", &GridDetector::idstart, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the idstart")
      .def("idFillOrder", &GridDetector::idFillOrder, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the idFillOrder")
      .def("idstepbyrow", &GridDetector::idstepbyrow, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the idstepbyrow")
      .def("idstep", &GridDetector::idstep, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the idstep")
      .def("minDetectorID", &GridDetector::minDetectorID, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the minimum detector id")
      .def("maxDetectorID", &GridDetector::maxDetectorID, arg("self"), return_value_policy<copy_const_reference>(),
           "Returns the maximum detector id");
}
 
void export_GridDetectorPixel() {
  class_<GridDetectorPixel, bases<Detector>, boost::noncopyable>("GridDetectorPixel", no_init);
}