CListModeDataPETSIRD.h

/*
 
     Copyright 2025, 2026, University Medical Center Groningen
     Copyright 2025, MGH / HST A. Martinos Center for Biomedical Imaging
 
    SPDX-License-Identifier: Apache-2.0
    See STIR/LICENSE.txt for details.
 
 */
 
#ifndef __stir_listmode_CListModeDataPETSIRD_H__
#define __stir_listmode_CListModeDataPETSIRD_H__
 
#include "stir/listmode/CListModeDataBasedOnCoordinateMap.h"
#include "stir/listmode/CListRecord.h"
#include "stir/listmode/CListRecordPETSIRD.h"
#include "stir/Succeeded.h"
#include "petsird_helpers.h"
#include "stir/PETSIRDInfo.h"
#include "petsird/binary/protocols.h"
#include "petsird/hdf5/protocols.h"
 
START_NAMESPACE_STIR

class CListModeDataPETSIRD : public CListModeDataBasedOnCoordinateMap
{
private:

  struct PetsirdCursor
  {

    bool is_prompt = true;
    std::size_t event_in_block = 0;
    std::size_t time_block_index = 0;
    petsird::TimeBlock time_block;
    petsird::EventTimeBlock event_block;
    bool has_cached_blocks = false;
  };
 
public:
  CListModeDataPETSIRD(const std::string& listmode_filename, bool use_hdf5);
 
  virtual shared_ptr<CListRecord> get_empty_record_sptr() const override;
 
  Succeeded get_next_record(CListRecord& record_of_general_type) const override;
 
  SavedPosition save_get_position() override;


  void reopen_and_prime();
 
  Succeeded seek_to_event_block_index(std::size_t target_event_block_index) const;
 
  Succeeded set_get_position(const SavedPosition& pos) override;
 
  virtual bool has_delayeds() const override { return m_has_delayeds; }
 
  Succeeded reset() override;
  // expose singles for dead time correction
  const std::vector<float>& get_singles_per_bucket() const { return singles_per_bucket; }
  double get_singles_time_start() const { return singles_time_start; }
  double get_singles_time_stop() const { return singles_time_stop; }
 
protected:
  virtual Succeeded open_lm_file() const override;
 
  shared_ptr<petsird::PETSIRDReaderBase> current_lm_data_ptr;
 
private:
  const bool use_hdf5;
  mutable unsigned long int curr_event_in_event_block = 0;
  mutable petsird::TimeBlock curr_time_block;
  mutable petsird::EventTimeBlock curr_event_block;
  mutable bool curr_is_prompt = true;
  mutable bool m_has_delayeds;
  shared_ptr<const PETSIRDInfo> petsird_info_sptr;
  mutable PetsirdCursor m_saved_cursor;
  mutable std::size_t m_time_block_index = 0;

  mutable std::vector<PetsirdCursor> m_saved_positions;
  // accumulated singles per bucket from SinglesHistogramTimeBlock entries
  mutable std::vector<float> singles_per_bucket;
  mutable double singles_time_start = 0.0;
  mutable double singles_time_stop = 0.0;
};
 
END_NAMESPACE_STIR
#endif // CLISTMODEDATAPETSIRD_H