RelatedViewgrams.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000-2012, 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 __RelatedViewgrams_h__
#define __RelatedViewgrams_h__
 
#include "stir/Viewgram.h"
#include "stir/DataSymmetriesForViewSegmentNumbers.h"
#include <vector>
 
#include <iterator>
 
START_NAMESPACE_STIR
 
// forward declarations for 'friend'
class ProjData;
class ProjDataInfo;

template <typename elemT>
class RelatedViewgrams : public DataWithProjDataInfo
{
#ifdef STIR_COMPILING_SWIG_WRAPPER
public: // SWIG needs this typedef to be public
#endif
  typedef RelatedViewgrams<elemT> self_type;
 
public:

  typedef std::random_access_iterator_tag iterator_category;
  typedef Viewgram<elemT> 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 typename std::vector<Viewgram<elemT>>::iterator iterator;
  typedef typename std::vector<Viewgram<elemT>>::const_iterator const_iterator;
 
  // --- constructors ---

  inline RelatedViewgrams();
 
  // implicit copy constructor (just element-by-element copy)
  // RelatedViewgrams(const RelatedViewgrams&);


  inline RelatedViewgrams(const std::vector<Viewgram<elemT>>& viewgrams,
                          const shared_ptr<DataSymmetriesForViewSegmentNumbers>& symmetries_used);
 
  // --- const members returning info ---


  inline int get_basic_view_num() const;

  inline int get_basic_segment_num() const;

  inline int get_basic_timing_pos_num() const;

  inline ViewgramIndices get_basic_view_segment_num() const;

  inline ViewgramIndices get_basic_viewgram_indices() const;

  inline int get_num_viewgrams() const;
  inline int get_num_axial_poss() const;
  inline int get_min_axial_pos_num() const;
  inline int get_max_axial_pos_num() const;

  inline const DataSymmetriesForViewSegmentNumbers* get_symmetries_ptr() const;

  inline shared_ptr<DataSymmetriesForViewSegmentNumbers> get_symmetries_sptr() const;
  // -- members which modify the structure ---

  void grow(const IndexRange<2>& range);
 
  // TODOvoid zoom(const float zoom, const float Xoffp, const float Yoffp,
  //           const int size, const float itophi);
 
  // -- basic iterator support --

  inline iterator begin();
  inline iterator end();
  inline const_iterator begin() const;
  inline const_iterator end() const;
 
  // numeric operators

  RelatedViewgrams& operator*=(const elemT);
  RelatedViewgrams& operator/=(const elemT);
  RelatedViewgrams& operator+=(const elemT);
  RelatedViewgrams& operator-=(const elemT);

  RelatedViewgrams& operator*=(const RelatedViewgrams<elemT>&);
  RelatedViewgrams& operator/=(const RelatedViewgrams<elemT>&);
  RelatedViewgrams& operator+=(const RelatedViewgrams<elemT>&);
  RelatedViewgrams& operator-=(const RelatedViewgrams<elemT>&);
 
  // numeric functions

  elemT find_max() const;
  elemT find_min() const;
  void fill(const elemT& n);
 
  // other

  RelatedViewgrams get_empty_copy() const;



  bool has_same_characteristics(self_type const&, std::string& explanation) const;


  bool has_same_characteristics(self_type const&) const;


  bool operator==(const self_type&) const;

  bool operator!=(const self_type&) const;
 
private:
  friend class ProjData;
  friend class ProjDataInfo;
 
  // members
  std::vector<Viewgram<elemT>> viewgrams;
  shared_ptr<DataSymmetriesForViewSegmentNumbers> symmetries_used;


  inline void check_state() const;

  void debug_check_state() const;
};
 
END_NAMESPACE_STIR
 
#include "stir/RelatedViewgrams.inl"
 
#endif // __RelatedViewgrams_h__