aimstil  5.0.5
til::ConstVolumetricIterator< ImageC< T > > Class Template Reference

#include <til/ConstImageVolumetricIterator.h>

Inheritance diagram for til::ConstVolumetricIterator< ImageC< T > >:
Collaboration diagram for til::ConstVolumetricIterator< ImageC< T > >:

Public Types

typedef T value_type
 
typedef const T & reference
 
typedef ImageC< T > TImage
 

Public Member Functions

 ConstVolumetricIterator ()
 
 ConstVolumetricIterator (const ImageC< T > &im)
 
 ConstVolumetricIterator (const ImageC< T > &im, const Range< int, 3 > &roi)
 
virtual ~ConstVolumetricIterator ()
 
virtual void init ()
 
virtual void init (const Range< int, 3 > &box)
 
void set_pos (const numeric_array< int, 3 > &pos)
 
void setUnsafePos (const numeric_array< int, 3 > &pos)
 
const numeric_array< int, 3 > & pos () const
 
const Range< int, 3 > & roi () const
 
const ImageC< T > & image () const
 
INLINEgetUnsafeValue (int offsetx, int offsety, int offsetz) const
 Get value of a neighbor WITHOUT RANGE CHECKING. More...
 
template<int offsetx, int offsety, int offsetz>
INLINEgetUnsafeValue () const
 Get value of a neighbor WITHOUT RANGE CHECKING. More...
 
INLINEgetUnsafeValue (const numeric_array< int, 3 > &offset) const
 Get value of a neighbor WITHOUT RANGE CHECKING. More...
 
template<class Extrapolator , int offsetx, int offsety, int offsetz>
INLINEgetValue () const
 
template<class Extrapolator >
getValue (const numeric_array< int, 3 > &offset) const
 Get value of a neighbor. More...
 
INLINEoperator() (const numeric_array< int, 3 > &offset) const
 
INLINE void operator++ ()
 Go to next image element. More...
 
INLINE bool next ()
 Go to next image element, return whether operation succeeded. More...
 
INLINE void next (ImageAxis axis)
 Go to next element in the following direction. More...
 
INLINE bool isAtEnd () const
 Test whether the iterator has reached the end of the image or not. More...
 
reference operator* () const
 Return the value of the current element. More...
 
T * getIndex () const
 

Detailed Description

template<typename T>
class til::ConstVolumetricIterator< ImageC< T > >

Definition at line 23 of file ConstImageVolumetricIterator.h.

Member Typedef Documentation

◆ reference

template<typename T >
typedef const T& til::ConstVolumetricIterator< ImageC< T > >::reference

Definition at line 28 of file ConstImageVolumetricIterator.h.

◆ TImage

template<typename T >
typedef ImageC<T> til::ConstVolumetricIterator< ImageC< T > >::TImage

Definition at line 29 of file ConstImageVolumetricIterator.h.

◆ value_type

template<typename T >
typedef T til::ConstVolumetricIterator< ImageC< T > >::value_type

Definition at line 27 of file ConstImageVolumetricIterator.h.

Constructor & Destructor Documentation

◆ ConstVolumetricIterator() [1/3]

template<typename T >
til::ConstVolumetricIterator< ImageC< T > >::ConstVolumetricIterator ( )
inline

Definition at line 34 of file ConstImageVolumetricIterator.h.

◆ ConstVolumetricIterator() [2/3]

template<typename T >
til::ConstVolumetricIterator< ImageC< T > >::ConstVolumetricIterator ( const ImageC< T > &  im)
inline

Definition at line 37 of file ConstImageVolumetricIterator.h.

◆ ConstVolumetricIterator() [3/3]

template<typename T >
til::ConstVolumetricIterator< ImageC< T > >::ConstVolumetricIterator ( const ImageC< T > &  im,
const Range< int, 3 > &  roi 
)
inline

Definition at line 40 of file ConstImageVolumetricIterator.h.

◆ ~ConstVolumetricIterator()

template<typename T >
virtual til::ConstVolumetricIterator< ImageC< T > >::~ConstVolumetricIterator ( )
inlinevirtual

Definition at line 42 of file ConstImageVolumetricIterator.h.

Member Function Documentation

◆ getIndex()

template<typename T >
T* til::ConstVolumetricIterator< ImageC< T > >::getIndex ( ) const
inline

Definition at line 212 of file ConstImageVolumetricIterator.h.

◆ getUnsafeValue() [1/3]

template<typename T >
INLINE T til::ConstVolumetricIterator< ImageC< T > >::getUnsafeValue ( int  offsetx,
int  offsety,
int  offsetz 
) const
inline

Get value of a neighbor WITHOUT RANGE CHECKING.

NB: the offset is passed, not the actual position

Definition at line 80 of file ConstImageVolumetricIterator.h.

◆ getUnsafeValue() [2/3]

template<typename T >
template<int offsetx, int offsety, int offsetz>
INLINE T til::ConstVolumetricIterator< ImageC< T > >::getUnsafeValue ( ) const
inline

Get value of a neighbor WITHOUT RANGE CHECKING.

NB: the offset is passed as a template parameter

Definition at line 92 of file ConstImageVolumetricIterator.h.

◆ getUnsafeValue() [3/3]

template<typename T >
INLINE T til::ConstVolumetricIterator< ImageC< T > >::getUnsafeValue ( const numeric_array< int, 3 > &  offset) const
inline

Get value of a neighbor WITHOUT RANGE CHECKING.

NB: the offset is passed, not the actual position

Definition at line 99 of file ConstImageVolumetricIterator.h.

◆ getValue() [1/2]

template<typename T >
template<class Extrapolator , int offsetx, int offsety, int offsetz>
INLINE T til::ConstVolumetricIterator< ImageC< T > >::getValue ( ) const
inline

Definition at line 108 of file ConstImageVolumetricIterator.h.

◆ getValue() [2/2]

template<typename T >
template<class Extrapolator >
T til::ConstVolumetricIterator< ImageC< T > >::getValue ( const numeric_array< int, 3 > &  offset) const
inline

Get value of a neighbor.

Extrapolation is done if the position lies beyond image range. NB: the offset is passed, not the actual position Get value of a neighbor. Extrapolation is done if the position lies beyond image range. NB: the offset is passed, not the actual position

Definition at line 154 of file ConstImageVolumetricIterator.h.

References til::contains().

◆ image()

template<typename T >
const ImageC<T>& til::ConstVolumetricIterator< ImageC< T > >::image ( ) const
inline

Definition at line 73 of file ConstImageVolumetricIterator.h.

◆ init() [1/2]

template<typename T >
void til::ConstVolumetricIterator< ImageC< T > >::init ( )
virtual

Definition at line 270 of file ConstImageVolumetricIterator.h.

References til::getRange(), and INLINE.

◆ init() [2/2]

template<typename T >
void til::ConstVolumetricIterator< ImageC< T > >::init ( const Range< int, 3 > &  box)
virtual

◆ isAtEnd()

template<typename T >
INLINE bool til::ConstVolumetricIterator< ImageC< T > >::isAtEnd ( ) const
inline

Test whether the iterator has reached the end of the image or not.

Definition at line 203 of file ConstImageVolumetricIterator.h.

◆ next() [1/2]

template<typename T >
INLINE bool til::ConstVolumetricIterator< ImageC< T > >::next ( )

Go to next image element, return whether operation succeeded.

Definition at line 369 of file ConstImageVolumetricIterator.h.

References INLINE.

◆ next() [2/2]

template<typename T >
INLINE void til::ConstVolumetricIterator< ImageC< T > >::next ( ImageAxis  axis)

Go to next element in the following direction.

Definition at line 395 of file ConstImageVolumetricIterator.h.

◆ operator()()

template<typename T >
INLINE T til::ConstVolumetricIterator< ImageC< T > >::operator() ( const numeric_array< int, 3 > &  offset) const
inline

Definition at line 184 of file ConstImageVolumetricIterator.h.

References INLINE, and til::operator++().

◆ operator*()

template<typename T >
reference til::ConstVolumetricIterator< ImageC< T > >::operator* ( ) const
inline

Return the value of the current element.

Definition at line 206 of file ConstImageVolumetricIterator.h.

◆ operator++()

template<typename T >
INLINE void til::ConstVolumetricIterator< ImageC< T > >::operator++ ( )

Go to next image element.

Definition at line 307 of file ConstImageVolumetricIterator.h.

◆ pos()

template<typename T >
const numeric_array<int,3>& til::ConstVolumetricIterator< ImageC< T > >::pos ( ) const
inline

Definition at line 67 of file ConstImageVolumetricIterator.h.

◆ roi()

template<typename T >
const Range<int,3>& til::ConstVolumetricIterator< ImageC< T > >::roi ( ) const
inline

Definition at line 70 of file ConstImageVolumetricIterator.h.

◆ set_pos()

template<typename T >
void til::ConstVolumetricIterator< ImageC< T > >::set_pos ( const numeric_array< int, 3 > &  pos)

Definition at line 328 of file ConstImageVolumetricIterator.h.

References til::contains().

◆ setUnsafePos()

template<typename T >
void til::ConstVolumetricIterator< ImageC< T > >::setUnsafePos ( const numeric_array< int, 3 > &  pos)
inline

Definition at line 349 of file ConstImageVolumetricIterator.h.

References INLINE.


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