IEventWorkspace.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 "MantidAPI/IEventWorkspace.h"
#include "MantidAPI/IEventList.h"
#include "MantidPythonInterface/api/RegisterWorkspacePtrToPython.h"
#include "MantidPythonInterface/core/GetPointer.h"
 
#include <boost/python/class.hpp>
#include <boost/python/object.hpp>
 
using namespace Mantid::API;
using Mantid::PythonInterface::Registry::RegisterWorkspacePtrToPython;
using namespace boost::python;
 
GET_POINTER_SPECIALIZATION(IEventWorkspace)
 
namespace {
IEventList &deprecatedGetEventList(IEventWorkspace &self, const size_t index) {
  PyErr_Warn(PyExc_DeprecationWarning, "'getEventList' is deprecated, use 'getSpectrum' instead.");
  return self.getSpectrum(index);
}
} // namespace
 
void export_IEventWorkspace() {
  class_<IEventWorkspace, bases<Mantid::API::MatrixWorkspace>, boost::noncopyable>("IEventWorkspace", no_init)
      .def("getNumberEvents", &IEventWorkspace::getNumberEvents, args("self"),
           "Returns the number of events in the :class:`~mantid.api.Workspace`")
      .def("getTofMin", &IEventWorkspace::getTofMin, args("self"),
           "Returns the minimum TOF value (in microseconds) held by the "
           ":class:`~mantid.api.Workspace`")
      .def("getTofMax", &IEventWorkspace::getTofMax, args("self"),
           "Returns the maximum TOF value (in microseconds) held by the "
           ":class:`~mantid.api.Workspace`")
      .def("getPulseTimeMin", &IEventWorkspace::getPulseTimeMin, args("self"),
           "Returns the minimum pulse time held by the "
           ":class:`~mantid.api.Workspace`")
      .def("getPulseTimeMax", &IEventWorkspace::getPulseTimeMax, args("self"),
           "Returns the maximum pulse time held by the "
           ":class:`~mantid.api.Workspace`")
      .def("getEventList", &deprecatedGetEventList, return_internal_reference<>(), args("self", "workspace_index"),
           "Return the :class:`~mantid.api.IEventList` managing the events at "
           "the given :class:`~mantid.api.Workspace` "
           "index")
      .def("clearMRU", &IEventWorkspace::clearMRU, args("self"), "Clear the most-recently-used lists");
 
  RegisterWorkspacePtrToPython<IEventWorkspace>();
}