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

Extends the bi-directional NeighborhoodIterator to a random access iterator. More...

#include <itkRandomAccessNeighborhoodIterator.h>

Inheritance diagram for itk::RandomAccessNeighborhoodIterator:

[legend]Collaboration diagram for itk::RandomAccessNeighborhoodIterator< TImage >:

[legend]List of all members.

Public Types
typedef RandomAccessNeighborhoodIterator	Self
typedef ConstRandomAccessNeighborhoodIterator< TImage >	Superclass
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::PixelType	PixelType
typedef Superclass::SizeType	SizeType
typedef Superclass::ImageType	ImageType
typedef Superclass::RegionType	RegionType
typedef Superclass::IndexType	IndexType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::RadiusType	RadiusType
typedef Superclass::NeighborhoodType	NeighborhoodType
typedef Superclass::Iterator	Iterator
typedef Superclass::ConstIterator	ConstIterator
typedef Superclass::ImageBoundaryConditionPointerType	ImageBoundaryConditionPointerType
Public Methods
	itkStaticConstMacro (Dimension, unsigned int, Superclass::Dimension)
	RandomAccessNeighborhoodIterator ()
	RandomAccessNeighborhoodIterator (const RandomAccessNeighborhoodIterator &n)
	RandomAccessNeighborhoodIterator (const SizeType &radius, ImageType *ptr, const RegionType &region)
virtual void	PrintSelf (std::ostream &, Indent) const
InternalPixelType *	GetCenterPointer ()
virtual void	SetCenterPixel (const PixelType &p)
virtual void	SetNeighborhood (const NeighborhoodType &)
virtual void	SetPixel (const unsigned long i, const PixelType &v)
Self &	operator= (const Self &orig)

---

Detailed Description

template<class TImage>
class itk::RandomAccessNeighborhoodIterator< TImage >

Extends the bi-directional NeighborhoodIterator to a random access iterator.

This class adds several methods to NeighborhoodIterator to allow arbitrary, N-dimensional movement of the iterator through an image. This iterator can be incremented or decremented by an itk::Offset. Subtracting two RandomAccessNeighborhoodIterator objects returns an itk::Offset representing the distance between them.

See also:

NeighborhoodIterator , Offset

Definition at line 42 of file itkRandomAccessNeighborhoodIterator.h.

---

Member Typedef Documentation

template<class TImage> typedef Superclass::ConstIterator itk::RandomAccessNeighborhoodIterator< TImage >::ConstIterator

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 64 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::ImageBoundaryConditionPointerType itk::RandomAccessNeighborhoodIterator< TImage >::ImageBoundaryConditionPointerType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 66 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::ImageType itk::RandomAccessNeighborhoodIterator< TImage >::ImageType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 57 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::IndexType itk::RandomAccessNeighborhoodIterator< TImage >::IndexType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 59 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::InternalPixelType itk::RandomAccessNeighborhoodIterator< TImage >::InternalPixelType

Extract typedefs from superclass Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 54 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::Iterator itk::RandomAccessNeighborhoodIterator< TImage >::Iterator

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 63 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::NeighborhoodType itk::RandomAccessNeighborhoodIterator< TImage >::NeighborhoodType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 62 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::OffsetType itk::RandomAccessNeighborhoodIterator< TImage >::OffsetType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 60 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::PixelType itk::RandomAccessNeighborhoodIterator< TImage >::PixelType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 55 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::RadiusType itk::RandomAccessNeighborhoodIterator< TImage >::RadiusType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 61 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::RegionType itk::RandomAccessNeighborhoodIterator< TImage >::RegionType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 58 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef RandomAccessNeighborhoodIterator itk::RandomAccessNeighborhoodIterator< TImage >::Self

Standard class typedefs. Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 47 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef Superclass::SizeType itk::RandomAccessNeighborhoodIterator< TImage >::SizeType

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 56 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> typedef ConstRandomAccessNeighborhoodIterator<TImage> itk::RandomAccessNeighborhoodIterator< TImage >::Superclass

Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 48 of file itkRandomAccessNeighborhoodIterator.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::RandomAccessNeighborhoodIterator< TImage >::RandomAccessNeighborhoodIterator (    )  [inline]

Default constructor. Definition at line 69 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> itk::RandomAccessNeighborhoodIterator< TImage >::RandomAccessNeighborhoodIterator (  const RandomAccessNeighborhoodIterator< TImage > &    n )  [inline]

Copy constructor Definition at line 72 of file itkRandomAccessNeighborhoodIterator.h. References itkGenericOutputMacro.

template<class TImage> itk::RandomAccessNeighborhoodIterator< TImage >::RandomAccessNeighborhoodIterator (  const SizeType &    radius, ImageType *    ptr, const RegionType &    region )  [inline]

Constructor which establishes the region size, neighborhood, and image over which to walk. Definition at line 85 of file itkRandomAccessNeighborhoodIterator.h. References itkGenericOutputMacro, and HardConnectedComponentImageFilter::RegionType.

---

Member Function Documentation

template<class TImage> InternalPixelType* itk::RandomAccessNeighborhoodIterator< TImage >::GetCenterPointer (    )  [inline]

Returns the central memory pointer of the neighborhood. Definition at line 95 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> itk::RandomAccessNeighborhoodIterator< TImage >::itkStaticConstMacro (  Dimension   , unsigned    int, Superclass::Dimension    )

Extract typedefs from superclass. Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >.

template<class TImage> Self& itk::RandomAccessNeighborhoodIterator< TImage >::operator= (  const Self &    orig )  [inline]

Assignment operator Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >. Definition at line 76 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> virtual void itk::RandomAccessNeighborhoodIterator< TImage >::PrintSelf (  std::ostream &   , Indent    )  const [virtual]

Standard print method Reimplemented from itk::ConstRandomAccessNeighborhoodIterator< TImage >.

template<class TImage> virtual void itk::RandomAccessNeighborhoodIterator< TImage >::SetCenterPixel (  const PixelType &    p )  [inline, virtual]

Set the center pixel value. Definition at line 99 of file itkRandomAccessNeighborhoodIterator.h.

template<class TImage> virtual void itk::RandomAccessNeighborhoodIterator< TImage >::SetNeighborhood (  const NeighborhoodType &    )  [virtual]

Virtual function that replaces the pixel values in the image neighborhood that are pointed to by this RandomAccessNeighborhoodIterator with the pixel values contained in a Neighborhood.

template<class TImage> virtual void itk::RandomAccessNeighborhoodIterator< TImage >::SetPixel (  const unsigned long    i, const PixelType &    v )  [inline, virtual]

Set the pixel value. Definition at line 108 of file itkRandomAccessNeighborhoodIterator.h.

---

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

• itkRandomAccessNeighborhoodIterator.h

---