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

Const version of RandomAccessNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image. More...

#include <itkConstRandomAccessNeighborhoodIterator.h>

Inheritance diagram for itk::ConstRandomAccessNeighborhoodIterator:

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

[legend]List of all members.

Public Types
typedef ConstRandomAccessNeighborhoodIterator	Self
typedef ConstNeighborhoodIterator< TImage >	Superclass
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::PixelType	PixelType
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef Superclass::ImageType	ImageType
typedef Superclass::RegionType	RegionType
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
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)
	ConstRandomAccessNeighborhoodIterator ()
virtual	~ConstRandomAccessNeighborhoodIterator ()
	ConstRandomAccessNeighborhoodIterator (const ConstRandomAccessNeighborhoodIterator &orig)
	ConstRandomAccessNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual void	PrintSelf (std::ostream &, Indent) const
Self &	operator+= (const OffsetType &)
Self &	operator-= (const OffsetType &)
OffsetType	operator- (const Self &b)
Self &	operator= (const Self &orig)

---

Detailed Description

template<class TImage>
class itk::ConstRandomAccessNeighborhoodIterator< TImage >

Const version of RandomAccessNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image.

ConstRandomAccessNeighborhoodIterator implements the read-only methods of RandomAccessNeighborhoodIterator. It serves as a base class from which other iterators are derived. See RandomAccessNeighborhoodIterator for more complete information.

See also:

Neighborhood , ImageIterator , NeighborhoodIterator , SmartNeighborhoodIterator , RandomAccessNeighborhoodIterator

Definition at line 40 of file itkConstRandomAccessNeighborhoodIterator.h.

---

Member Typedef Documentation

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

Support for internal iterator types. Only const iteration is supported in this class. Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 63 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef for generic boundary condition pointer Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 65 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 53 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 55 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Definition at line 56 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Extract typedefs from superclass Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 49 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 62 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 60 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 57 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Definition at line 58 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 50 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 59 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 54 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Standard class typedefs. Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 45 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 51 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Typedef support for common objects Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Definition at line 52 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 46 of file itkConstRandomAccessNeighborhoodIterator.h.

---

Constructor & Destructor Documentation

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

Default constructor Definition at line 68 of file itkConstRandomAccessNeighborhoodIterator.h.

template<class TImage> virtual itk::ConstRandomAccessNeighborhoodIterator< TImage >::~ConstRandomAccessNeighborhoodIterator (    )  [inline, virtual]

Virtual destructor Definition at line 73 of file itkConstRandomAccessNeighborhoodIterator.h.

template<class TImage> itk::ConstRandomAccessNeighborhoodIterator< TImage >::ConstRandomAccessNeighborhoodIterator (  const ConstRandomAccessNeighborhoodIterator< TImage > &    orig )  [inline]

Copy constructor Definition at line 76 of file itkConstRandomAccessNeighborhoodIterator.h.

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

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

---

Member Function Documentation

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

Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >.

template<class TImage> Self& itk::ConstRandomAccessNeighborhoodIterator< TImage >::operator+= (  const OffsetType &    )

Addition of an itk::Offset. Note that this method does not do any bounds checking. Adding an offset that moves the iterator out of its assigned region will produce undefined results.

template<class TImage> OffsetType itk::ConstRandomAccessNeighborhoodIterator< TImage >::operator- (  const Self &    b )  [inline]

Distance between two iterators Definition at line 113 of file itkConstRandomAccessNeighborhoodIterator.h.

template<class TImage> Self& itk::ConstRandomAccessNeighborhoodIterator< TImage >::operator-= (  const OffsetType &    )

Subtraction of an itk::Offset. Note that this method does not do any bounds checking. Subtracting an offset that moves the iterator out of its assigned region will produce undefined results.

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

Assignment operator Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >. Definition at line 92 of file itkConstRandomAccessNeighborhoodIterator.h.

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

Standard itk print method Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::RandomAccessNeighborhoodIterator< TImage >.

---

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

• itkConstRandomAccessNeighborhoodIterator.h

---