ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions
itk::ReflectiveImageRegionIterator< TImage > Class Template Reference

#include <itkReflectiveImageRegionIterator.h>

+ Inheritance diagram for itk::ReflectiveImageRegionIterator< TImage >:
+ Collaboration diagram for itk::ReflectiveImageRegionIterator< TImage >:

List of all members.

Public Types

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

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

Protected Member Functions

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

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 44 of file itkReflectiveImageRegionIterator.h.


Member Typedef Documentation

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

Accessor type that converts data between internal and external representations.

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 64 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 59 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 52 of file itkReflectiveImageRegionIterator.h.

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

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 53 of file itkReflectiveImageRegionIterator.h.

Internal Pixel Type

Reimplemented from itk::ImageConstIteratorWithIndex< TImage >.

Definition at line 62 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 56 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 60 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 63 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 58 of file itkReflectiveImageRegionIterator.h.

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

Standard class typedefs.

Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 48 of file itkReflectiveImageRegionIterator.h.

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

Size typedef support.

Reimplemented from itk::ReflectiveImageRegionConstIterator< TImage >.

Definition at line 54 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >
typedef Superclass::SizeValueType itk::ReflectiveImageRegionIterator< TImage >::SizeValueType
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::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 >
void itk::ReflectiveImageRegionIterator< TImage >::Set ( const PixelType value) const [inline]

Set the pixel value

Definition at line 82 of file itkReflectiveImageRegionIterator.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 88 of file itkReflectiveImageRegionIterator.h.


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