ProjMatrixElemsForOneBin.h

Go to the documentation of this file.

//
//

#ifndef __stir_recon_buildblock_ProjMatrixElemsForOneBin__
#define __stir_recon_buildblock_ProjMatrixElemsForOneBin__

/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2009, Hammersmith Imanet Ltd
    Copyright (C) 2016, University of Hull
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/

#include "stir/recon_buildblock/ProjMatrixElemsForOneBinValue.h"
#include "stir/Bin.h"
#include <vector>

START_NAMESPACE_STIR

class Succeeded;
class RelatedBins;
template <int num_dimensions, typename elemT>
class DiscretisedDensity;

/*
  it might be a bit faster to derive this (privately) from
  std::vector<value_type> as opposed to having a member of
  that type.
  TODO: check
*/
class ProjMatrixElemsForOneBin
{
public:
  typedef ProjMatrixElemsForOneBinValue value_type;

private:
  typedef std::vector<value_type> Element_vector;

public:
  typedef Element_vector::iterator iterator;
  typedef Element_vector::const_iterator const_iterator;
  typedef Element_vector::size_type size_type;
  typedef Element_vector::difference_type difference_type;
  typedef std::random_access_iterator_tag iterator_category;

  typedef value_type& reference;
  typedef const value_type& const_reference;


  explicit ProjMatrixElemsForOneBin(const Bin& bin = Bin(), const int default_capacity = 0);

  /* rely on compiler-generated versions
  ProjMatrixElemsForOneBin( const ProjMatrixElemsForOneBin&);
  ProjMatrixElemsForOneBin& operator=(const ProjMatrixElemsForOneBin&) ;
  */

  Succeeded check_state() const;

  inline const Bin& get_bin() const;
  inline void set_bin(const Bin&);

  inline iterator begin();
  inline const_iterator begin() const;
  inline iterator end();
  inline const_iterator end() const;

  void erase();
  inline iterator erase(iterator it);

  inline void push_back(const value_type&);
  void reserve(size_type max_number);
  inline size_type size() const;
  size_type capacity() const;
  ProjMatrixElemsForOneBin& operator*=(const float d);
  ProjMatrixElemsForOneBin& operator/=(const float d);


  void sort();


  // TODO make sure we can have a const argument
  void merge(ProjMatrixElemsForOneBin& lor);


  bool operator==(const ProjMatrixElemsForOneBin&) const;
  bool operator!=(const ProjMatrixElemsForOneBin&) const;

#if 0  
  void write(std::fstream&fst) const;           
  void read(std::fstream&fst );
#endif


  float square_sum() const;

  //******************** projection operations ********************//

  void back_project(DiscretisedDensity<3, float>&, const Bin&) const;

  void forward_project(Bin&, const DiscretisedDensity<3, float>&) const;
  void back_project(DiscretisedDensity<3, float>&, const RelatedBins&) const;
  void forward_project(RelatedBins&, const DiscretisedDensity<3, float>&) const;

private:
  std::vector<value_type> elements;
  Bin bin;
};

END_NAMESPACE_STIR

#include "stir/recon_buildblock/ProjMatrixElemsForOneBin.inl"

#endif