ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes
itk::ReflectiveImageRegionConstIterator< TImage > Class Template Reference

Multi-dimensional image iterator which only walks a region. More...

#include <itkReflectiveImageRegionConstIterator.h>

Inheritance diagram for itk::ReflectiveImageRegionConstIterator< TImage >:
Collaboration diagram for itk::ReflectiveImageRegionConstIterator< TImage >:

List of all members.

Public Types

typedef TImage ImageType
typedef TImage::IndexType IndexType
typedef TImage::OffsetType OffsetType
typedef OffsetType::OffsetValueType OffsetValueType
typedef TImage::PixelContainer PixelContainer
typedef PixelContainer::Pointer PixelContainerPointer
typedef TImage::RegionType RegionType
typedef
ReflectiveImageRegionConstIterator 
Self
typedef TImage::SizeType SizeType
typedef TImage::SizeValueType SizeValueType
typedef
ImageConstIteratorWithIndex
< TImage > 
Superclass

Public Member Functions

void FillOffsets (const OffsetValueType &value)
OffsetType GetBeginOffset (const OffsetType &offset)
OffsetType GetEndOffset (const OffsetType &offset)
void GoToBegin (void)
bool IsAtBegin (void) const
bool IsReflected (unsigned int) const
Selfoperator++ ()
Selfoperator= (const Self &it)
 ReflectiveImageRegionConstIterator (const Self &it)
 ReflectiveImageRegionConstIterator ()
 ReflectiveImageRegionConstIterator (const ImageConstIteratorWithIndex< TImage > &it)
 ReflectiveImageRegionConstIterator (TImage *ptr, const RegionType &region)
void SetBeginOffset (const OffsetType &offset)
void SetEndOffset (const OffsetType &offset)
 ~ReflectiveImageRegionConstIterator ()

Private Attributes

OffsetType m_BeginOffset
OffsetType m_EndOffset
bool m_IsFirstPass [TImage::ImageDimension]

Detailed Description

template<typename TImage>
class itk::ReflectiveImageRegionConstIterator< TImage >

Multi-dimensional image iterator which only walks a region.

ReflectiveImageRegionConstIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionConstIterator is templated over the image type. ReflectiveImageRegionConstIterator is constrained to walk only within the specified region.

ReflectiveImageRegionConstIterator will perform two passes over the image along each dimension. It is useful for algorithms that require to go back and forth (once) over the data.

By setting the BeginOffset and EndOffset parameters, you can arrange for the starting point, when going forwards, to be different from the ending point, when going backwards. Along dimension d, when going forwards the iterator traverses the interval [BeginIndex[d]+BeginOffset[d], EndIndex[d]). When going back, it traverses the interval (EndIndex[d]-EndOffset[d], BeginIndex[d]]. Setting both offsets to (1, ..., 1) enables the DanielssonDistanceMapImageFilter to process the entire image, rather than removing a one-pixel border.

See also:
DanielssonDistanceMapImageFilter

Definition at line 52 of file itkReflectiveImageRegionConstIterator.h.


Member Typedef Documentation

template<typename TImage>
typedef TImage itk::ReflectiveImageRegionConstIterator< TImage >::ImageType

Image typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Image back to itk::Image to that is it not confused with ImageIterator::Image.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 69 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
typedef TImage::IndexType itk::ReflectiveImageRegionConstIterator< TImage >::IndexType

Index typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index to that is it not confused with ImageIterator::Index.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 63 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
typedef TImage::OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::OffsetType

Type of the Offset taken from the image. These typedefs are duplicated from the superclass for gcc support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 89 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
typedef OffsetType::OffsetValueType itk::ReflectiveImageRegionConstIterator< TImage >::OffsetValueType
template<typename TImage>
typedef TImage::PixelContainer itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainer

PixelContainer typedef support. Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 75 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
typedef PixelContainer::Pointer itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainerPointer
template<typename TImage>
typedef TImage::RegionType itk::ReflectiveImageRegionConstIterator< TImage >::RegionType

Region typedef support. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Region back to itk::ImageRegion so that is it not confused with ImageIterator::Index.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 83 of file itkReflectiveImageRegionConstIterator.h.

Standard class typedefs.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 56 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
typedef TImage::SizeType itk::ReflectiveImageRegionConstIterator< TImage >::SizeType

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Reimplemented in itk::ReflectiveImageRegionIterator< TImage >.

Definition at line 84 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
typedef TImage::SizeValueType itk::ReflectiveImageRegionConstIterator< TImage >::SizeValueType
template<typename TImage>
typedef ImageConstIteratorWithIndex< TImage > itk::ReflectiveImageRegionConstIterator< TImage >::Superclass

Constructor & Destructor Documentation

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>
itk::ReflectiveImageRegionConstIterator< TImage >::~ReflectiveImageRegionConstIterator ( ) [inline]

Default destructor.

Definition at line 96 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator ( TImage *  ptr,
const RegionType region 
)

Constructor establishes an iterator to walk a particular image and a particular region of that image.

template<typename TImage>
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator ( const Self it)

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

template<typename TImage>
itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator ( const ImageConstIteratorWithIndex< TImage > &  it)

Constructor that can be used to cast from an ImageIterator to an ReflectiveImageRegionConstIterator. Many routines return an ImageIterator but for a particular task, you may want an ReflectiveImageRegionConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from * an ImageIterator to a ReflectiveImageRegionConstIterator.


Member Function Documentation

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::FillOffsets ( const OffsetValueType value)

Fill both offsets with a single value.

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetBeginOffset ( const OffsetType offset) [inline]

Get the begin offset. Forward iteration starts at this offset from the current region.

Definition at line 151 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetEndOffset ( const OffsetType offset) [inline]

Get the end offset. Reverse iteration starts at this offset from the current region.

Definition at line 156 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::GoToBegin ( void  )

Move an iterator to the beginning of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::IsAtBegin ( void  ) const [inline]

Is the iterator at the beginning of the region?

Definition at line 134 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::IsReflected ( unsigned  int) const
template<typename TImage>
Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator++ ( )

Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.

See also:
operator++(int)
template<typename TImage>
Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator= ( const Self it)

operator= is provided to make sure the handle to the image is properly reference counted.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::SetBeginOffset ( const OffsetType offset) [inline]

Set the begin offset. Forward iteration starts at this offset from the current region.

Definition at line 141 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::SetEndOffset ( const OffsetType offset) [inline]

Set the end offset. Reverse iteration starts at this offset from the current region.

Definition at line 146 of file itkReflectiveImageRegionConstIterator.h.


Member Data Documentation

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::m_BeginOffset [private]

Definition at line 164 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::m_EndOffset [private]

Definition at line 165 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::m_IsFirstPass[TImage::ImageDimension] [private]

Definition at line 163 of file itkReflectiveImageRegionConstIterator.h.


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