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 which only walks a region. 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 ImageRegionExclusionIteratorWithIndex Self
typedef ImageRegionExclusionConstIteratorWithIndex<
TImage > 
Superclass
typedef Superclass::IndexType IndexType
typedef Superclass::IndexValueType IndexValueType
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef Superclass::OffsetType OffsetType
typedef Superclass::OffsetValueType OffsetValueType
typedef Superclass::RegionType RegionType
typedef Superclass::ImageType ImageType
typedef Superclass::PixelContainer PixelContainer
typedef Superclass::PixelContainerPointer PixelContainerPointer
typedef Superclass::InternalPixelType InternalPixelType
typedef Superclass::PixelType PixelType
typedef Superclass::AccessorType AccessorType

Public Member Functions

 ImageRegionExclusionIteratorWithIndex ()
 ImageRegionExclusionIteratorWithIndex (ImageType *ptr, const RegionType &region)
 ImageRegionExclusionIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)
void Set (const PixelType &value) const
PixelTypeValue (void)

Protected Member Functions

 ImageRegionExclusionIteratorWithIndex (const ImageRegionExclusionConstIteratorWithIndex< TImage > &it)
Selfoperator= (const ImageRegionExclusionConstIteratorWithIndex< TImage > &it)

Detailed Description

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

Multi-dimensional image iterator which only walks a region.

ImageRegionExclusionIteratorWithIndex is a templated class to represent a multi-dimensional iterator. ImageRegionExclusionIteratorWithIndex is templated over the image type ImageRegionExclusionIteratorWithIndex 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 ImageRegionExclusionConstIteratorWithIndex. The current class only adds write access to image pixels.

See also:
ImageRegionExclusionConstIteratorWithIndex

Definition at line 45 of file itkImageRegionExclusionIteratorWithIndex.h.


Member Typedef Documentation

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

Accessor type that convert data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 65 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 60 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 53 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 54 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 63 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 57 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 58 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Definition at line 61 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Reimplemented from itk::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 62 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 64 of file itkImageRegionExclusionIteratorWithIndex.h.

Referenced by itk::ImageRegionExclusionIteratorWithIndex< TImage >::Set(), and itk::ImageRegionExclusionIteratorWithIndex< TImage >::Value().

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 59 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Standard class typedefs.

Reimplemented from itk::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 49 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 55 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 56 of file itkImageRegionExclusionIteratorWithIndex.h.

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

Reimplemented from itk::ImageRegionExclusionConstIteratorWithIndex< TImage >.

Definition at line 50 of file itkImageRegionExclusionIteratorWithIndex.h.


Constructor & Destructor Documentation

template<typename TImage>
itk::ImageRegionExclusionIteratorWithIndex< TImage >::ImageRegionExclusionIteratorWithIndex  ) 
 

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::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>
void itk::ImageRegionExclusionIteratorWithIndex< TImage >::Set const PixelType value  )  const [inline]
 

Set the pixel value Definition at line 84 of file itkImageRegionExclusionIteratorWithIndex.h.

References itk::ImageRegionExclusionIteratorWithIndex< TImage >::PixelType.

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 90 of file itkImageRegionExclusionIteratorWithIndex.h.

References itk::ImageRegionExclusionIteratorWithIndex< TImage >::PixelType.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:55:41 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000