Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

Multi-dimensional image iterator that walks an image region, excluding a second region contained within the first. More...

#include <itkImageRegionExclusionIteratorWithIndex.h>

Inheritance diagram for itk::ImageRegionExclusionIteratorWithIndex< TImage >:
Inheritance graph
[legend]
Collaboration diagram for itk::ImageRegionExclusionIteratorWithIndex< 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
ImageRegionExclusionIteratorWithIndex 
Self
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef
ImageRegionExclusionConstIteratorWithIndex
< TImage > 
Superclass

Public Member Functions

Self Begin (void) const
Self End (void) const
PixelType Get (void) const
const IndexTypeGetIndex () const
const RegionTypeGetRegion () const
void GoToBegin (void)
void GoToReverseBegin (void)
 ImageRegionExclusionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
 ImageRegionExclusionIteratorWithIndex (ImageType *ptr, const RegionType &region)
 ImageRegionExclusionIteratorWithIndex ()
bool IsAtEnd (void) const
bool IsAtReverseEnd (void) const
bool operator!= (const Self &it) const
Selfoperator++ ()
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
bool Remaining ()
void Set (const PixelType &value) const
void SetExclusionRegion (const RegionType &region)
void SetExclusionRegionToInsetRegion ()
const PixelTypeValue (void) const
PixelTypeValue (void)



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



 ImageRegionExclusionIteratorWithIndex (const ImageRegionExclusionConstIteratorWithIndex< TImage > &it)
Selfoperator= (const ImageRegionExclusionConstIteratorWithIndex< 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::ImageRegionExclusionIteratorWithIndex< TImage >

Multi-dimensional image iterator that walks an image region, excluding a second region contained within the first.

Most of the functionality of this iterator is inherited from the ImageRegionExclusionConstIteratorWithIndex, which should be consulted for details. This class only adds write access to the iterator.

MORE INFORMATION
For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from http://www.itk.org.
See also:
ImageConstIterator
ConditionalConstIterator
ConstNeighborhoodIterator
ConstShapedNeighborhoodIterator
ConstSliceIterator
CorrespondenceDataStructureIterator
FloodFilledFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalIterator
FloodFilledSpatialFunctionConditionalConstIterator
FloodFilledSpatialFunctionConditionalIterator
ImageConstIterator
ImageConstIteratorWithIndex
ImageIterator
ImageIteratorWithIndex
ImageLinearConstIteratorWithIndex
ImageLinearIteratorWithIndex
ImageRandomConstIteratorWithIndex
ImageRandomIteratorWithIndex
ImageRegionConstIterator
ImageRegionConstIteratorWithIndex
ImageRegionExclusionConstIteratorWithIndex
ImageRegionExclusionIteratorWithIndex
ImageRegionIterator
ImageRegionIteratorWithIndex
ImageRegionReverseConstIterator
ImageRegionReverseIterator
ImageReverseConstIterator
ImageReverseIterator
ImageSliceConstIteratorWithIndex
ImageSliceIteratorWithIndex
NeighborhoodIterator
PathConstIterator
PathIterator
ShapedNeighborhoodIterator
SliceIterator
ImageConstIteratorWithIndex

Definition at line 64 of file itkImageRegionExclusionIteratorWithIndex.h.


Member Typedef Documentation

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

Definition at line 132 of file itkImageConstIteratorWithIndex.h.

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 84 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Definition at line 79 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Types inherited from the Superclass

Reimplemented from itk::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 72 of file itkImageRegionExclusionIteratorWithIndex.h.

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 82 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Type of the Offset taken from the image

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 76 of file itkImageRegionExclusionIteratorWithIndex.h.

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::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 80 of file itkImageRegionExclusionIteratorWithIndex.h.

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

External Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 83 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Definition at line 78 of file itkImageRegionExclusionIteratorWithIndex.h.

Standard class typedefs.

Reimplemented from itk::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 68 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Size typedef support.

Reimplemented from itk::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 74 of file itkImageRegionExclusionIteratorWithIndex.h.


Constructor & Destructor Documentation

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >
itk::ImageRegionExclusionIteratorWithIndex< TImage >::ImageRegionExclusionIteratorWithIndex ( 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::ImageRegionExclusionIteratorWithIndex< TImage >::ImageRegionExclusionIteratorWithIndex ( const ImageIteratorWithIndex< TImage > &  it  ) 

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

template<typename TImage >
itk::ImageRegionExclusionIteratorWithIndex< TImage >::ImageRegionExclusionIteratorWithIndex ( const ImageRegionExclusionConstIteratorWithIndex< 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>
PixelType itk::ImageConstIteratorWithIndex< TImage >::Get ( void   )  const [inline, inherited]

Get the pixel value

Definition at line 237 of file itkImageConstIteratorWithIndex.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::ImageConstIteratorWithIndex< TImage >::GoToBegin ( void   )  [inherited]
template<typename TImage>
void itk::ImageConstIteratorWithIndex< TImage >::GoToReverseBegin ( void   )  [inherited]

Move an iterator to the End of the region.

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::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::ImageRegionExclusionConstIteratorWithIndex< 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>
Self& itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::operator-- (  )  [inherited]

Decrement (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 beginning of the row of the region to the end of the next row of the region) up until the iterator tries to moves past the first pixel of the region. Here, the iterator will be set to be one pixel past the beginning 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::ImageRegionExclusionIteratorWithIndex< TImage >::operator= ( const ImageRegionExclusionConstIteratorWithIndex< 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::ImageRegionExclusionIteratorWithIndex< TImage >::Set ( const PixelType value  )  const [inline]

Set the pixel value

Definition at line 103 of file itkImageRegionExclusionIteratorWithIndex.h.

template<typename TImage>
void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SetExclusionRegion ( const RegionType region  )  [inherited]

Method to define the Exclusion region. The iterator will skip pixels inside this region.

Warning:
The exclusion region must be completly containe inside the normal region used to construct the iterator. A border of at least on pixels should exist between the normal region and the exclusion region.
template<typename TImage>
void itk::ImageRegionExclusionConstIteratorWithIndex< TImage >::SetExclusionRegionToInsetRegion (  )  [inherited]

Set the exclusion region to be inset one pixel in from the region the iterator walks. This configures the iterator to only walk the pixels on the boundary of the region.

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>
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.

template<typename TImage >
PixelType& itk::ImageRegionExclusionIteratorWithIndex< 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 109 of file itkImageRegionExclusionIteratorWithIndex.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 Fri Apr 16 22:30:18 2010 for ITK by doxygen 1.6.1 written by Dimitri van Heesch, © 1997-2000