ProjMatrixByDensel.h

Go to the documentation of this file.

//
//

#ifndef __stir_recon_buildblock_ProjMatrixByDensel_H__
#define __stir_recon_buildblock_ProjMatrixByDensel_H__

/*
    Copyright (C) 2000- 2011, Hammersmith Imanet Ltd
    See STIR/LICENSE.txt for details
*/

#include "stir/RegisteredObject.h"
#include "stir/recon_buildblock/ProjMatrixElemsForOneDensel.h"
#include "stir/recon_buildblock/DataSymmetriesForDensels.h"
#include "stir/Densel.h"
#include "stir/ProjDataInfo.h" // todo replace by forward declaration
#include <map>
#include "stir/shared_ptr.h"

START_NAMESPACE_STIR

// template <typename elemT> class RelatedViewgrams;
// class Densel;
template <int num_dimensions, typename elemT>
class DiscretisedDensity;
class ProjMatrixByDensel : public RegisteredObject<ProjMatrixByDensel>
{
public:
  ~ProjMatrixByDensel() override {}


  virtual void set_up(const shared_ptr<const ProjDataInfo>& proj_data_info_ptr,
                      const shared_ptr<const DiscretisedDensity<3, float>>& density_info_ptr // TODO should be Info only
                      )
      = 0;

  virtual const DataSymmetriesForDensels* get_symmetries_ptr() const = 0;


  inline void get_proj_matrix_elems_for_one_densel(ProjMatrixElemsForOneDensel&, const Densel&) const;

#if 0
  // TODO
  virtual void write_to_file_by_densel(
    const char * const file_name_without_extension) const;
#endif
  // TODO implement this one at some point ?
  /*
  virtual void write_to_file_by_bin(
  const char * const file_name_without_extension);
  */

  // void set_maximum_cache_size(const unsigned long size){;}
  void enable_cache(bool v)
  {
    cache_disabled = !v;
  }
  /* TODO
  void set_subset_usage(const SubsetInfo&, const int num_access_times);
  */

protected:
  ProjMatrixByDensel();

  virtual void calculate_proj_matrix_elems_for_one_densel(ProjMatrixElemsForOneDensel&) const = 0;


  bool cache_disabled;

  Succeeded get_cached_proj_matrix_elems_for_one_densel(ProjMatrixElemsForOneDensel&) const;

  inline void cache_proj_matrix_elems_for_one_densel(const ProjMatrixElemsForOneDensel&) const;

private:
  typedef unsigned int CacheKey;

  typedef std::map<CacheKey, ProjMatrixElemsForOneDensel> MapProjMatrixElemsForOneDensel;
  typedef MapProjMatrixElemsForOneDensel::iterator MapProjMatrixElemsForOneDenselIterator;
  typedef MapProjMatrixElemsForOneDensel::const_iterator const_MapProjMatrixElemsForOneDenselIterator;

  mutable MapProjMatrixElemsForOneDensel cache_collection;

  inline static CacheKey cache_key(const Densel& Densel);
};

END_NAMESPACE_STIR

#include "stir_experimental/recon_buildblock/ProjMatrixByDensel.inl"

#endif // __ProjMatrixByDensel_H__