PulseIndexer.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 <cstddef>
#include <memory>
#include <string>
#include <vector>
 
namespace Mantid {
namespace DataHandling {
 
class MANTID_DATAHANDLING_DLL PulseIndexer {
public:
  // ----------------------------------------- input iterator allows for read-only access
  struct IteratorValue {
    std::size_t pulseIndex;
    std::size_t eventIndexStart;
    std::size_t eventIndexStop;
  };
 
  struct MANTID_DATAHANDLING_DLL Iterator {
    using iterator_category = std::input_iterator_tag;
    using difference_type = std::ptrdiff_t;
    using value_type = IteratorValue;
 
    Iterator(const PulseIndexer *indexer, const size_t pulseIndex)
        : m_indexer(indexer), m_lastPulseIndex(m_indexer->getLastPulseIndex()) {
      m_value.pulseIndex = pulseIndex;
      calculateEventRange();
    }
 
    const IteratorValue &operator*() const;
 
    // prefix increment ++iter
    Iterator &operator++();
    // postfix increment iter++ is not needed
 
    bool operator==(const PulseIndexer::Iterator &other) const;
    bool operator!=(const PulseIndexer::Iterator &other) const;
 
  private:
    const PulseIndexer *m_indexer;
    const size_t m_lastPulseIndex;
 
    bool calculateEventRange();
 
    IteratorValue m_value;
  };
 
  // ----------------------------------------- pulse indexer class start
  PulseIndexer(std::shared_ptr<std::vector<uint64_t> const> const &event_index, const std::size_t firstEventIndex,
               const std::size_t numEvents, const std::string &entry_name, const std::vector<size_t> &pulse_roi);
 
  size_t getFirstPulseIndex() const;
  size_t getLastPulseIndex() const;
  std::pair<size_t, size_t> getEventIndexRange(const size_t pulseIndex) const;
  size_t getStartEventIndex(const size_t pulseIndex) const;
  size_t getStopEventIndex(const size_t pulseIndex) const;
 
  const Iterator cbegin() const;
  const Iterator cend() const;
  Iterator begin() const;
  Iterator end() const;
 
private:
  PulseIndexer(); // do not allow empty constructor
 
  size_t determineFirstPulseIndex() const;
  size_t determineLastPulseIndex() const;
  bool includedPulse(const size_t pulseIndex) const;
 
  const std::shared_ptr<std::vector<uint64_t> const> m_event_index;
 
  std::size_t m_firstEventIndex;
 
  std::size_t m_numEvents;
 
  std::vector<std::size_t> m_roi;
  bool m_roi_complex;
 
  std::size_t m_numPulses;
 
  const std::string m_entry_name;
};
 
} // namespace DataHandling
} // namespace Mantid