SinglesRatesForTimeSlices.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_SinglesRatesForTimeSlices_H__
#define __stir_data_SinglesRatesForTimeSlices_H__

#include "stir/data/SinglesRates.h"
#include "stir/Array.h"
#include "stir/TimeFrameDefinitions.h"

START_NAMESPACE_STIR

class SinglesRatesForTimeSlices : public SinglesRates

{
public:
  SinglesRatesForTimeSlices();

  // implementation of pure virtual in SinglesRates
  float get_singles(const int singles_bin_index, const double start_time, const double end_time) const override;

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

  /*
   *! Get time slice index for a time slice ending at or after t.
   *
   * Each slice of singles data has a corresponing time recorded with
   * the singles counts. This time is considered to represent the time
   * at the end of the slice.
   *
   * For a given double precision number of seconds, t, this function
   * will return the slice index for the first time slice that has a
   * corresponding time greater than or equal to t.
   *
   * Assuming contiguous slices that end at the time recorded for the slice,
   * this function returns the slice in which t is contained.
   *
   * This function assumes that all slices are continguous.
   * If the supplied t does not actually fall within a frame, the closest
   * frame (ending after t) is returned. Values of t before the first time
   * slice will result in the index to the first slice being returned.
   */
  virtual int get_end_time_slice_index(double t) const;

  /*
   *! Get time slice index for a time slice ending after t.
   *
   * Each slice of singles data has a corresponing time recorded with
   * the singles counts. This time is considered to represent the time
   * at the end of the slice.
   *
   * For a given double precision number of seconds, t, this function
   * will return the slice index for the first time slice that has a
   * correspdoning time greater than t.
   *
   * Assuming contiguous slices that end at the time recorded for the slice,
   * this function returns the slice which starts before t. A time interval
   * that begins at t should contain only time slices that end _after_ t
   * not at t.
   *
   * This function assumes that all slices are continguous.
   * If the supplied t does not actually fall within a frame, the closest
   * frame (ending after t) is returned. Values of t before the first time
   * slice will result in the index to the first slice being returned.
   */
  virtual int get_start_time_slice_index(double t) const;

#if 0
 //
 // The singles rate returned is the rate for a whole singles unit.
 //
 int get_singles_rate(int singles_bin_index, int time_slice) const;
#endif
  void set_singles(int singles_bin_index, int time_slice, int new_singles);

  //
  // Returns the number of new bins.
  int rebin(std::vector<double>& new_end_times);

  std::vector<double> get_times() const;

  // Some inspectors

  int get_num_time_slices() const;

  double get_singles_time_interval() const;

  TimeFrameDefinitions get_time_frame_definitions() const;

protected:

  Array<2, int> _singles;


  std::vector<double> _times;

  int _num_time_slices;


  double _singles_time_interval;

  void set_time_interval();

  double get_slice_start_time(int slice_index) const;
};

END_NAMESPACE_STIR

#endif