IEventList.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 "MantidAPI/DllConfig.h"
#include "MantidAPI/ISpectrum.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidKernel/DateAndTime.h"
#include <functional>
#include <span>
 
namespace Mantid {
namespace API {
 
enum EventType { TOF, WEIGHTED, WEIGHTED_NOTIME };
 
class MANTID_API_DLL IEventList : public ISpectrum {
public:
  IEventList() {}
 
  IEventList(specnum_t specNo) : ISpectrum(specNo) {}
 
  virtual Mantid::API::EventType getEventType() const = 0;
  virtual void switchTo(Mantid::API::EventType newType) = 0;
  virtual void clear(const bool removeDetIDs) = 0;
  virtual void reserve(size_t num) = 0;
  virtual bool isSortedByTof() const = 0;
  virtual std::size_t getNumberEvents() const = 0;
  size_t getMemorySize() const override = 0;
  virtual void generateHistogram(std::span<double const> X, MantidVec &Y, MantidVec &E,
                                 bool skipError = false) const = 0;
  virtual void generateHistogramPulseTime(std::span<double const> X, MantidVec &Y, MantidVec &E,
                                          bool skipError = false) const = 0;
  virtual void generateHistogramTimeAtSample(std::span<double const> X, MantidVec &Y, MantidVec &E,
                                             const double &tofFactor, const double &tofOffset,
                                             bool skipError = false) const = 0;
  virtual double integrate(const double minX, const double maxX, const bool entireRange) const = 0;
  virtual void convertTof(std::function<double(double)> func, const int sorting = 0) = 0;
  virtual void convertTof(const double factor, const double offset = 0.) = 0;
  virtual void scaleTof(const double factor) = 0;
  virtual void addTof(const double offset) = 0;
  virtual void addPulsetime(const double seconds) = 0;
  virtual void addPulsetimes(const std::vector<double> &seconds) = 0;
  virtual void maskTof(const double tofMin, const double tofMax) = 0;
  virtual void maskCondition(const std::vector<bool> &mask) = 0;
  virtual std::vector<double> getTofs() const = 0;
  virtual void getTofs(std::vector<double> &tofs) const = 0;
  virtual std::vector<double> getWeights() const = 0;
  virtual void getWeights(std::vector<double> &weights) const = 0;
  virtual std::vector<double> getWeightErrors() const = 0;
  virtual void getWeightErrors(std::vector<double> &weightErrors) const = 0;
  virtual std::vector<Mantid::Types::Core::DateAndTime> getPulseTimes() const = 0;
  virtual double getTofMin() const = 0;
  virtual double getTofMax() const = 0;
  virtual Mantid::Types::Core::DateAndTime getPulseTimeMin() const = 0;
  virtual Mantid::Types::Core::DateAndTime getPulseTimeMax() const = 0;
  virtual Mantid::Types::Core::DateAndTime getTimeAtSampleMax(const double &tofFactor,
                                                              const double &tofOffset) const = 0;
  virtual Mantid::Types::Core::DateAndTime getTimeAtSampleMin(const double &tofFactor,
                                                              const double &tofOffset) const = 0;
  virtual void setTofs(const MantidVec &tofs) = 0;
  virtual void multiply(const double value, const double error = 0.0) = 0;
  virtual void divide(const double value, const double error = 0.0) = 0;
  virtual void multiply(std::span<double const> X, std::span<double const> Y, std::span<double const> E) = 0;
  virtual void divide(std::span<double const> X, std::span<double const> Y, std::span<double const> E) = 0;
};
 
} // namespace API
} // namespace Mantid