SinglesRates.h

Go to the documentation of this file.

//
//
/*
    Copyright (C) 2000- 2007, Hammersmith Imanet Ltd
    Copyright (C) 2021, University College London
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_data_SinglesRates_H__
#define __stir_data_SinglesRates_H__

//#include "stir/Array.h"
#include "stir/DetectionPosition.h"
#include "stir/RegisteredObject.h"
#include "stir/Scanner.h"
#include "stir/shared_ptr.h"
#include "stir/deprecated.h"
#include <vector>

START_NAMESPACE_STIR

class TimeFrameDefinitions;

class FrameSinglesRates
{

public:
  typedef std::vector<float>::iterator iterator;
  typedef std::vector<float>::const_iterator const_iterator;


  FrameSinglesRates(std::vector<float>& avg_singles_rates, double start_time, double end_time, shared_ptr<Scanner> scanner);

  FrameSinglesRates(double start_time, double end_time, shared_ptr<Scanner> scanner);

  //
  // The singles rate returned is the rate for a whole singles unit.
  //
  float get_singles_rate(int singles_bin_index) const;

  //
  // The singles rate returned is the rate for a whole singles unit.
  //
  float get_singles_rate(const DetectionPosition<>& det_pos) const;

  const_iterator begin() const { return this->_singles.begin(); }

  iterator begin() { return this->_singles.begin(); }

  const_iterator end() const { return this->_singles.end(); }

  iterator end() { return this->_singles.end(); }

  double get_start_time() const;

  double get_end_time() const;

  inline const Scanner* get_scanner_ptr() const;

private:
  double _start_time;
  double _end_time;
  std::vector<float> _singles;

  // Scanner specifics
  shared_ptr<Scanner> _scanner_sptr;
};

class SinglesRates : public RegisteredObject<SinglesRates>
{
public:
  ~SinglesRates() override {}

  virtual float get_singles_rate(const int singles_bin_index, const double start_time, const double end_time) const;


  virtual float get_singles(const int singles_bin_index, const double start_time, const double end_time) const = 0;


  virtual float get_singles_rate(const DetectionPosition<>& det_pos, const double start_time, const double end_time) const;


  virtual float get_singles(const DetectionPosition<>& det_pos, const double start_time, const double end_time) const;

  inline const Scanner* get_scanner_ptr() const;

  //  for a frame begining at start_time and ending at end_time.
  // virtual FrameSinglesRates get_rates_for_frame(double start_time,
  //                                              double end_time) const = 0;

#if 0
 virtual TimeFrameDefinitions
   get_time_frame_definitions() const = 0;
#endif

protected:
  shared_ptr<Scanner> scanner_sptr;
};

END_NAMESPACE_STIR

#include "stir/data/SinglesRates.inl"
#endif