STIR 6.5.0
stir::RelatedBins Class Reference

This class contains all information about a set of bins related by symmetry. More...

#include "stir/recon_buildblock/RelatedBins.h"

Public Types

typedef std::random_access_iterator_tag iterator_category
 typedefs for iterator support
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
 typedefs to make it partly comply with STL requirements
typedef std::vector< Bin >::const_iterator const_iterator

Public Member Functions

 RelatedBins ()
 Default constructor: creates no bins, no symmetries.
int get_num_related_bins () const
 get the number of related bins
Bin get_basic_bin () const
 get 'basic' bin coordinates
const DataSymmetriesForBins * get_symmetries_ptr () const
 return the symmetries used
RelatedBins get_empty_copy () const
 get an empty copy
iterator begin ()
 use to initialise an iterator to the first element of the vector
iterator end ()
 iterator 'past' the last element of the vector
const_iterator begin () const
 use to initialise an iterator to the first element of the (const) vector
const_iterator end () const
 iterator 'past' the last element of the (const) vector

Detailed Description

This class contains all information about a set of bins related by symmetry.

Constructor & Destructor Documentation

◆ RelatedBins()

stir::RelatedBins::RelatedBins ( )
inline

Default constructor: creates no bins, no symmetries.

References RelatedBins().

Referenced by get_empty_copy(), and RelatedBins().

Member Function Documentation

◆ get_symmetries_ptr()

const DataSymmetriesForBins * stir::RelatedBins::get_symmetries_ptr ( ) const
inline

◆ get_empty_copy()

RelatedBins stir::RelatedBins::get_empty_copy ( ) const

get an empty copy

References begin(), end(), and RelatedBins().

◆ begin() [1/2]

RelatedBins::iterator stir::RelatedBins::begin ( )
inline

use to initialise an iterator to the first element of the vector

References stir::VectorWithOffset< T >::begin().

Referenced by stir::ProjMatrixElemsForOneBin::back_project(), stir::ProjMatrixElemsForOneBin::forward_project(), and get_empty_copy().

◆ end() [1/2]

RelatedBins::iterator stir::RelatedBins::end ( )
inline

◆ begin() [2/2]

RelatedBins::const_iterator stir::RelatedBins::begin ( ) const
inline

use to initialise an iterator to the first element of the (const) vector

References stir::VectorWithOffset< T >::begin().

◆ end() [2/2]

RelatedBins::const_iterator stir::RelatedBins::end ( ) const
inline

iterator 'past' the last element of the (const) vector

References stir::VectorWithOffset< T >::end().


The documentation for this class was generated from the following files: