RelatedBins.h

Go to the documentation of this file.

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

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

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

#include "stir/shared_ptr.h"
#include <vector>
#include <iterator>

START_NAMESPACE_STIR

class ProjData;
class Bin;
class DataSymmetriesForBins;
class RelatedBins
{
public:

  typedef std::random_access_iterator_tag iterator_category;
  typedef Bin value_type;
  typedef value_type& reference;
  typedef const value_type& const_reference;
  typedef std::ptrdiff_t difference_type;
  typedef std::size_t size_type;

  typedef std::vector<Bin>::iterator iterator;
  typedef std::vector<Bin>::const_iterator const_iterator;
  inline RelatedBins();

  inline int get_num_related_bins() const;

  inline Bin get_basic_bin() const;

  // get the pointer to a ProjDataInfo class
  // inline const ProjDataInfo * get_proj_data_info_sptr() const;

  inline const DataSymmetriesForBins* get_symmetries_ptr() const;

  RelatedBins get_empty_copy() const;

  // basic iterator support

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

private:
  std::vector<Bin> related_bins;
  shared_ptr<DataSymmetriesForBins> symmetries;
  inline RelatedBins(const std::vector<Bin>& related_bins, const shared_ptr<DataSymmetriesForBins>& symmetries_used);
};

END_NAMESPACE_STIR

#include "stir/recon_buildblock/RelatedBins.inl"

#endif //__RelatedBins_H__