EventWorkspace.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/IEventWorkspace.h"
#include "MantidAPI/ISpectrum.h"
#include "MantidDataObjects/DllConfig.h"
#include "MantidDataObjects/EventList.h"
#include "MantidKernel/PropertyWithValue.h"
#include <boost/date_time/posix_time/posix_time.hpp>
#include <string>
 
namespace Mantid {
namespace API {
class Progress;
}
 
namespace DataObjects {
class EventWorkspaceMRU;
 
class MANTID_DATAOBJECTS_DLL EventWorkspace : public API::IEventWorkspace {
 
public:
  // The name of the workspace type.
  const std::string id() const override { return "EventWorkspace"; }
 
  // Constructor
  EventWorkspace();
 
  // Destructor
  ~EventWorkspace() override;
 
  std::unique_ptr<EventWorkspace> clone() const { return std::unique_ptr<EventWorkspace>(doClone()); }
 
  std::unique_ptr<EventWorkspace> cloneEmpty() const { return std::unique_ptr<EventWorkspace>(doCloneEmpty()); }
 
  // Initialize the pixels
  void init(const std::size_t &, const std::size_t &, const std::size_t &) override;
  void init(const HistogramData::Histogram &histogram) override;
 
  bool threadSafe() const override;
 
  //------------------------------------------------------------
 
  bool isRaggedWorkspace() const override;
 
  // Returns the number of single indexable items in the workspace
  std::size_t size() const override;
 
  // Get the blocksize, aka the number of bins in the histogram
  std::size_t blocksize() const override;
  std::size_t getNumberBins(const std::size_t &index) const override;
  std::size_t getMaxNumberBins() const override;
 
  // Get the number of histograms. aka the number of pixels or detectors.
  std::size_t getNumberHistograms() const override;
 
  size_t getMemorySize() const override;
 
  EventList &getSpectrum(const size_t index) override {
    invalidateCommonBinsFlag();
    return getSpectrumWithoutInvalidation(index);
  }
  const EventList &getSpectrum(const size_t index) const override;
  EventList *getSpectrumUnsafe(const size_t index);
 
  //------------------------------------------------------------
 
  double getTofMin() const override;
 
  double getTofMax() const override;
 
  Mantid::Types::Core::DateAndTime getPulseTimeMin() const override;
  Mantid::Types::Core::DateAndTime getPulseTimeMax() const override;
  void getPulseTimeMinMax(Mantid::Types::Core::DateAndTime &xmin, Mantid::Types::Core::DateAndTime &xmax) const;
 
  Mantid::Types::Core::DateAndTime getTimeAtSampleMin(double tofOffset = 0) const override;
 
  Mantid::Types::Core::DateAndTime getTimeAtSampleMax(double tofOffset = 0) const override;
 
  double getEventXMin() const;
  double getEventXMax() const;
  void getEventXMinMax(double &xmin, double &xmax) const;
 
  [[deprecated("use mutableX() instead")]]
  MantidVec &dataX(const std::size_t) override;
  [[deprecated("use mutableY() instead")]]
  MantidVec &dataY(const std::size_t) override;
  [[deprecated("use mutableE() instead")]]
  MantidVec &dataE(const std::size_t) override;
  [[deprecated("use mutableDx() instead")]]
  MantidVec &dataDx(const std::size_t) override;
  [[deprecated("use x() instead")]]
  const MantidVec &dataX(const std::size_t) const override;
  [[deprecated("use y() instead")]]
  const MantidVec &dataY(const std::size_t) const override;
  [[deprecated("use e() instead")]]
  const MantidVec &dataE(const std::size_t) const override;
  [[deprecated("use dx() instead")]]
  const MantidVec &dataDx(const std::size_t) const override;
  [[deprecated("use sharedX() instead")]]
  Kernel::cow_ptr<HistogramData::HistogramX> refX(const std::size_t) const override;
 
  void generateHistogram(const std::size_t index, std::span<double const> X, MantidVec &Y, MantidVec &E,
                         bool skipError = false) const override;
 
  void generateHistogramPulseTime(const std::size_t index, std::span<double const> X, MantidVec &Y, MantidVec &E,
                                  bool skipError = false) const;
 
  // Set the x-axis data (histogram bins) for all pixels
  void setAllX(const HistogramData::BinEdges &x) override;
 
  // Update all X values to fit around all events
  void resetAllXToSingleBin() override;
 
  // The total number of events across all of the spectra.
  std::size_t getNumberEvents() const override;
 
  // Type of the events
  Mantid::API::EventType getEventType() const override;
 
  // Change the event type
  void switchEventType(const Mantid::API::EventType type);
 
  // Returns true always - an EventWorkspace always represents histogramm-able
  // data
  bool isHistogramData() const override;
 
  std::size_t MRUSize() const;
 
  void clearMRU() const override;
 
  EventSortType getSortType() const;
 
  // Sort all event lists. Uses a parallelized algorithm
  void sortAll(EventSortType sortType, Mantid::API::Progress *prog) const;
 
  void getIntegratedSpectra(std::vector<double> &out, const double minX, const double maxX,
                            const bool entireRange) const override;
  EventWorkspace &operator=(const EventWorkspace &other) = delete;
 
protected:
  EventWorkspace(const EventWorkspace &other);
 
private:
  EventWorkspace *doClone() const override { return new EventWorkspace(*this); }
  EventWorkspace *doCloneEmpty() const override { return new EventWorkspace(); }
 
  EventList &getSpectrumWithoutInvalidation(const size_t index) override;
 
  std::vector<std::unique_ptr<EventList>> data;
 
  mutable std::unique_ptr<EventWorkspaceMRU> mru;
};
 
using EventWorkspace_sptr = std::shared_ptr<EventWorkspace>;
using EventWorkspace_const_sptr = std::shared_ptr<const EventWorkspace>;
 
} // namespace DataObjects
} // namespace Mantid
 
// Instantiated and exported by DataObjects/src/PropertyWithValue.cpp
MANTID_DATAOBJECTS_EXTERN_TEMPLATE(
    Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::DataObjects::EventWorkspace>>);
 
#ifndef DataObjects_EXPORTS
#include "MantidAPI/WorkspaceProperty.h"
namespace Mantid::API {
extern template class MANTID_DATAOBJECTS_DLL WorkspaceProperty<DataObjects::EventWorkspace>;
} // namespace Mantid::API
#endif