CompressEventAccumulator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2024 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 "MantidDataHandling/DllConfig.h"
#include "MantidDataObjects/EventList.h"
 
#include <span>
#include <vector>
 
namespace Mantid {
namespace DataHandling {
 
enum class CompressBinningMode { LINEAR, LOGARITHMIC };
 
class MANTID_DATAHANDLING_DLL CompressEventAccumulator {
public:
  // TODO parameter for expected number of events
  CompressEventAccumulator(std::shared_ptr<std::vector<double>> histogram_bin_edges, const double divisor,
                           CompressBinningMode bin_mode);
  virtual ~CompressEventAccumulator() = default; // needed because this is an abstract base class
 
  virtual void addEvent(const float tof) = 0;
  virtual void createWeightedEvents(std::vector<Mantid::DataObjects::WeightedEventNoTime> *raw_events) const = 0;
 
  std::size_t numberHistBins() const;
  virtual double totalWeight() const = 0;
  virtual DataObjects::EventSortType getSortType() const = 0;
 
protected:
  template <typename INT_TYPE> double getBinCenter(const INT_TYPE bin) const;
  std::optional<size_t> findBin(const float tof) const;
  const std::shared_ptr<std::vector<double>> m_histogram_edges;
 
private:
  // offset is applied after division
  // see EventList::findLinearBin for implementation on what that means
  double m_divisor;
  double m_offset;
  std::optional<size_t> (*m_findBin)(std::span<double const>, const double, const double, const double, const bool);
 
protected:
  bool m_initialized;
};
 
class MANTID_DATAHANDLING_DLL CompressEventAccumulatorFactory {
public:
  CompressEventAccumulatorFactory(std::shared_ptr<std::vector<double>> histogram_bin_edges, const double divisor,
                                  CompressBinningMode bin_mode);
  std::unique_ptr<CompressEventAccumulator> create(const std::size_t num_events);
 
private:
  double m_divisor;
  CompressBinningMode m_bin_mode;
  const std::shared_ptr<std::vector<double>> m_histogram_edges;
};
 
} // namespace DataHandling
} // namespace Mantid