Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes

itk::ReflectiveImageRegionIterator< TImage > Class Template Reference
[Image Iterators]

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

#include <itkReflectiveImageRegionIterator.h>

Inheritance diagram for itk::ReflectiveImageRegionIterator< TImage >:
Inheritance graph
[legend]
Collaboration diagram for itk::ReflectiveImageRegionIterator< TImage >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef TImage::AccessorFunctorType AccessorFunctorType
typedef Superclass::AccessorType AccessorType
typedef Superclass::ImageType ImageType
typedef Superclass::IndexType IndexType
typedef Superclass::IndexValueType IndexValueType
typedef
Superclass::InternalPixelType 
InternalPixelType
typedef Superclass::OffsetType OffsetType
typedef Superclass::OffsetValueType OffsetValueType
typedef Superclass::PixelContainer PixelContainer
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
typedef Superclass::PixelType PixelType
typedef Superclass::RegionType RegionType
typedef
ReflectiveImageRegionIterator 
Self
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef
ReflectiveImageRegionConstIterator
< TImage > 
Superclass

Public Member Functions

Self Begin (void) const
Self End (void) const
void FillOffsets (const OffsetValueType &value)
PixelType Get (void) const
OffsetType GetBeginOffset (const OffsetType &offset)
OffsetType GetEndOffset (const OffsetType &offset)
const IndexTypeGetIndex () const
const RegionTypeGetRegion () const
void GoToBegin (void)
void GoToReverseBegin (void)
bool IsAtBegin (void) const
bool IsAtEnd (void) const
bool IsAtReverseEnd (void) const
bool IsReflected (unsigned int) const
bool operator!= (const Self &it) const
Selfoperator++ ()
bool operator< (const Self &it) const
bool operator<= (const Self &it) const
bool operator== (const Self &it) const
bool operator> (const Self &it) const
bool operator>= (const Self &it) const
 ReflectiveImageRegionIterator (const ImageIteratorWithIndex< TImage > &it)
 ReflectiveImageRegionIterator (ImageType *ptr, const RegionType &region)
 ReflectiveImageRegionIterator ()
bool Remaining ()
void Set (const PixelType &value) const
void SetBeginOffset (const OffsetType &offset)
void SetEndOffset (const OffsetType &offset)
PixelTypeValue (void)
const PixelTypeValue (void) const

void SetIndex (const IndexType &ind)

Static Public Member Functions

static unsigned int GetImageDimension ()

Static Public Attributes

static const unsigned int ImageDimension = TImage::ImageDimension

Protected Member Functions

 ReflectiveImageRegionIterator (const ReflectiveImageRegionConstIterator< TImage > &it)
Selfoperator= (const ReflectiveImageRegionConstIterator< TImage > &it)

Protected Attributes

const InternalPixelTypem_Begin
IndexType m_BeginIndex
const InternalPixelTypem_End
IndexType m_EndIndex
TImage::ConstWeakPointer m_Image
unsigned long m_OffsetTable [ImageDimension+1]
AccessorType m_PixelAccessor
AccessorFunctorType m_PixelAccessorFunctor
const InternalPixelTypem_Position
IndexType m_PositionIndex
RegionType m_Region
bool m_Remaining

Detailed Description

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

Multi-dimensional image iterator which only walks a region.

ReflectiveImageRegionIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionIterator is templated over the image type ReflectiveImageRegionIterator is constrained to walk only within the specified region and along a line parallel to one of the coordinate axis.

Most of the functionality is inherited from the ReflectiveImageRegionConstIterator. The current class only adds write access to image pixels.

See also:
ReflectiveImageRegionConstIterator

Definition at line 45 of file itkReflectiveImageRegionIterator.h.


Member Typedef Documentation

template<typename TImage>
typedef TImage::AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::AccessorFunctorType [inherited]

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >
typedef Superclass::AccessorType itk::ReflectiveImageRegionIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 65 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::ImageType itk::ReflectiveImageRegionIterator< 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::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 60 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::IndexType itk::ReflectiveImageRegionIterator< TImage >::IndexType

Types inherited from the Superclass

Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 53 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::IndexValueType itk::ReflectiveImageRegionIterator< TImage >::IndexValueType

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 54 of file itkReflectiveImageRegionIterator.h.

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 63 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::OffsetType itk::ReflectiveImageRegionIterator< TImage >::OffsetType

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

Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 57 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::PixelContainer itk::ReflectiveImageRegionIterator< 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::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 61 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::PixelType itk::ReflectiveImageRegionIterator< TImage >::PixelType

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 64 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::RegionType itk::ReflectiveImageRegionIterator< 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::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 59 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef ReflectiveImageRegionIterator itk::ReflectiveImageRegionIterator< TImage >::Self

Standard class typedefs.

Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 49 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::SizeType itk::ReflectiveImageRegionIterator< TImage >::SizeType

Size typedef support.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 55 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::SizeValueType itk::ReflectiveImageRegionIterator< TImage >::SizeValueType

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 56 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef ReflectiveImageRegionConstIterator<TImage> itk::ReflectiveImageRegionIterator< TImage >::Superclass

Constructor & Destructor Documentation

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator (  ) 

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( ImageType ptr,
const RegionType region 
)

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

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( const ImageIteratorWithIndex< TImage > &  it  ) 

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

template<typename TImage >
itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( const ReflectiveImageRegionConstIterator< TImage > &  it  )  [protected]

the construction from a const iterator is declared protected in order to enforce const correctness.


Member Function Documentation

template<typename TImage>
Self itk::ImageConstIteratorWithIndex< TImage >::Begin ( void   )  const [inherited]

Move an iterator to the beginning of the region.

Deprecated:
Use GoToBegin() instead
template<typename TImage>
Self itk::ImageConstIteratorWithIndex< TImage >::End ( void   )  const [inherited]

Move an iterator to the End of the region.

Deprecated:
Use GoToReverseBegin() instead
template<typename TImage>
void itk::ReflectiveImageRegionConstIterator< TImage >::FillOffsets ( const OffsetValueType value  )  [inherited]

Fill both offsets with a single value.

template<typename TImage>
PixelType itk::ImageConstIteratorWithIndex< TImage >::Get ( void   )  const [inline, inherited]

Get the pixel value

Definition at line 237 of file itkImageConstIteratorWithIndex.h.

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

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

Definition at line 150 of file itkReflectiveImageRegionConstIterator.h.

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

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

Definition at line 155 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
static unsigned int itk::ImageConstIteratorWithIndex< TImage >::GetImageDimension (  )  [inline, static, inherited]

Get the dimension (size) of the index.

Definition at line 156 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const IndexType& itk::ImageConstIteratorWithIndex< TImage >::GetIndex ( void   )  const [inline, inherited]
template<typename TImage>
const RegionType& itk::ImageConstIteratorWithIndex< TImage >::GetRegion (  )  const [inline, inherited]

Get the region that this iterator walks. ImageIterators know the beginning and the end of the region of the image to iterate over.

Definition at line 224 of file itkImageConstIteratorWithIndex.h.

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

Move an iterator to the beginning of the region.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

template<typename TImage>
void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin ( void   )  [inherited]

Move an iterator to the End of the region.

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

Is the iterator at the beginning of the region?

Definition at line 133 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::IsAtEnd ( void   )  const [inline, inherited]
template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::IsAtReverseEnd ( void   )  const [inline, inherited]

Is the iterator at the beginning of the region?

Definition at line 261 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ReflectiveImageRegionConstIterator< TImage >::IsReflected ( unsigned  int  )  const [inherited]
template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator!= ( const Self it  )  const [inline, inherited]

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 162 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator++ (  )  [inherited]

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>
bool itk::ImageConstIteratorWithIndex< TImage >::operator< ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 190 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator<= ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "less than" another if it "points to" a lower memory location.

Definition at line 180 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >
Self& itk::ReflectiveImageRegionIterator< TImage >::operator= ( const ReflectiveImageRegionConstIterator< TImage > &  it  )  [protected]

the construction from a const iterator is declared protected in order to enforce const correctness.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator== ( const Self it  )  const [inline, inherited]

Comparison operator. Two iterators are the same if they "point to" the same memory location

Definition at line 171 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator> ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 210 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::operator>= ( const Self it  )  const [inline, inherited]

Comparison operator. An iterator is "greater than" another if it "points to" a higher location.

Definition at line 200 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::Remaining (  )  [inline, inherited]

Are there data remainning in the region ?

Definition at line 273 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >
void itk::ReflectiveImageRegionIterator< TImage >::Set ( const PixelType value  )  const [inline]

Set the pixel value

Definition at line 84 of file itkReflectiveImageRegionIterator.h.

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

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

Definition at line 140 of file itkReflectiveImageRegionConstIterator.h.

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

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

Definition at line 145 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>
void itk::ImageConstIteratorWithIndex< TImage >::SetIndex ( const IndexType ind  )  [inline, inherited]

Set the index. No bounds checking is performed.

See also:
GetIndex

Definition at line 229 of file itkImageConstIteratorWithIndex.h.

template<typename TImage >
PixelType& itk::ReflectiveImageRegionIterator< TImage >::Value ( void   )  [inline]

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 90 of file itkReflectiveImageRegionIterator.h.

template<typename TImage>
const PixelType& itk::ImageConstIteratorWithIndex< TImage >::Value ( void   )  const [inline, inherited]

Return a const reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 243 of file itkImageConstIteratorWithIndex.h.


Member Data Documentation

template<typename TImage>
const unsigned int itk::ImageConstIteratorWithIndex< TImage >::ImageDimension = TImage::ImageDimension [static, inherited]

Dimension of the image the iterator walks. This constant is needed so functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

Reimplemented in itk::ImageRandomNonRepeatingConstIteratorWithIndex< TImage >.

Definition at line 101 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Begin [protected, inherited]

Definition at line 292 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_BeginIndex [protected, inherited]

Definition at line 282 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_End [protected, inherited]

Definition at line 293 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_EndIndex [protected, inherited]

Definition at line 283 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
TImage::ConstWeakPointer itk::ImageConstIteratorWithIndex< TImage >::m_Image [protected, inherited]

Definition at line 279 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
unsigned long itk::ImageConstIteratorWithIndex< TImage >::m_OffsetTable[ImageDimension+1] [protected, inherited]

Definition at line 289 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
AccessorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor [protected, inherited]

Definition at line 297 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
AccessorFunctorType itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessorFunctor [protected, inherited]

Definition at line 298 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
const InternalPixelType* itk::ImageConstIteratorWithIndex< TImage >::m_Position [protected, inherited]
template<typename TImage>
IndexType itk::ImageConstIteratorWithIndex< TImage >::m_PositionIndex [protected, inherited]

Definition at line 281 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
RegionType itk::ImageConstIteratorWithIndex< TImage >::m_Region [protected, inherited]

Definition at line 287 of file itkImageConstIteratorWithIndex.h.

template<typename TImage>
bool itk::ImageConstIteratorWithIndex< TImage >::m_Remaining [protected, inherited]

Definition at line 295 of file itkImageConstIteratorWithIndex.h.


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

Generated at Tue Jul 13 2010 01:12:34 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000