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

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

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

#include <itkConstNeighborhoodIterator.h>

Inheritance diagram for itk::ConstNeighborhoodIterator:

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

[legend]List of all members.

Public Types
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::PixelType	PixelType
typedef ConstNeighborhoodIterator	Self
typedef Neighborhood< InternalPixelType *, itkGetStaticConstMacro(Dimension)	Superclass )
typedef Superclass::ConstIterator	ConstIterator
typedef ImageBoundaryCondition< ImageType > *	ImageBoundaryConditionPointerType

typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef TImage	ImageType
typedef TImage::RegionType	RegionType
typedef Index< itkGetStaticConstMacro(Dimension)	IndexType )
typedef IndexType::IndexValueType	IndexValueType
typedef Offset< itkGetStaticConstMacro(Dimension)	OffsetType )
typedef OffsetType::OffsetValueType	OffsetValueType
typedef Superclass::RadiusType	RadiusType
typedef Neighborhood< PixelType, itkGetStaticConstMacro(Dimension)	NeighborhoodType )
typedef Superclass::Iterator	Iterator
Public Methods
	itkStaticConstMacro (Dimension, unsigned int, TImage::ImageDimension)
	ConstNeighborhoodIterator ()
virtual	~ConstNeighborhoodIterator ()
	ConstNeighborhoodIterator (const ConstNeighborhoodIterator &)
	ConstNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
Self &	operator= (const Self &orig)
virtual void	PrintSelf (std::ostream &, Indent) const
OffsetType	ComputeInternalIndex (unsigned int n) const
IndexType	GetBound () const
long	GetBound (unsigned int n) const
const InternalPixelType *	GetCenterPointer () const
PixelType	GetCenterPixel () const
const ImageType *	GetImagePointer (void)
virtual IndexType	GetIndex (void) const
virtual NeighborhoodType	GetNeighborhood () const
InternalPixelType *	GetOutputBuffer () const
OffsetType	GetOutputWrapOffsetModifier () const
virtual PixelType	GetPixel (const unsigned long i) const
RegionType	GetRegion () const
IndexType	GetBeginIndex () const
OffsetType	GetWrapOffset () const
OffsetValueType	GetWrapOffset (unsigned int n) const
virtual void	GoToBegin ()
virtual void	GoToEnd ()
virtual void	Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual bool	IsAtBegin () const
virtual const Self &	operator++ ()
virtual const Self &	operator-- ()
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	operator>= (const Self &it) const
virtual void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType)
void	SetOutputBuffer (InternalPixelType *i)
void	SetOutputWrapOffsetModifier (const OffsetType &modifiers)
virtual void	ResetBoundaryCondition ()

virtual bool	IsAtEnd () const

void	SetLocation (const IndexType &position)
Protected Methods
virtual void	SetLoop (const IndexType &p)
virtual void	SetBound (const SizeType &)
virtual void	SetPixelPointers (const IndexType &)
virtual void	SetBeginIndex (const IndexType &start)
virtual void	SetEndIndex ()

void	ComputeStrideTable ()
Protected Attributes
IndexType	m_BeginIndex
IndexType	m_Bound
const InternalPixelType *	m_Begin
ImageType::ConstPointer	m_ConstImage
const InternalPixelType *	m_End
IndexType	m_EndIndex
IndexType	m_Loop
InternalPixelType *	m_OutputBuffer
OffsetType	m_OutputWrapOffsetModifier
RegionType	m_Region
unsigned long	m_StrideTable [Dimension]
OffsetType	m_WrapOffset

Detailed Description

template<class TImage>
class itk::ConstNeighborhoodIterator< TImage >

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

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

See also:: Neighborhood , ImageIterator , NeighborhoodIterator , SmartNeighborhoodIterator , RandomAccessNeighborhoodIterator

Definition at line 51 of file itkConstNeighborhoodIterator.h.

Member Typedef Documentation

template<class TImage>

typedef Superclass::ConstIterator itk::ConstNeighborhoodIterator< TImage >::ConstIterator

Support for internal iterator types. Only const iteration is supported in this class.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage >, itk::RandomAccessNeighborhoodIterator< TImage >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 83 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef TImage itk::ConstNeighborhoodIterator< TImage >::ImageType

Typedef support for common objects
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage >, itk::RandomAccessNeighborhoodIterator< TImage >, itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 70 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef IndexType::IndexValueType itk::ConstNeighborhoodIterator< TImage >::IndexValueType

Typedef support for common objects
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 73 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef Superclass::Iterator itk::ConstNeighborhoodIterator< TImage >::Iterator

Typedef support for common objects
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::NeighborhoodIterator< TImage >, itk::RandomAccessNeighborhoodIterator< TImage >, and itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >.
Definition at line 78 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef Offset<itkGetStaticConstMacro(Dimension) itk::ConstNeighborhoodIterator< TImage >::OffsetType)

Typedef support for common objects
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage >, itk::RandomAccessNeighborhoodIterator< TImage >, itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 74 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef OffsetType::OffsetValueType itk::ConstNeighborhoodIterator< TImage >::OffsetValueType

Typedef support for common objects
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 75 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef Superclass::RadiusType itk::ConstNeighborhoodIterator< TImage >::RadiusType

Typedef support for common objects
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::NeighborhoodIterator< TImage >, and itk::RandomAccessNeighborhoodIterator< TImage >.
Definition at line 76 of file itkConstNeighborhoodIterator.h.

template<class TImage>

typedef Superclass::SizeValueType itk::ConstNeighborhoodIterator< TImage >::SizeValueType

Typedef support for common objects
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 69 of file itkConstNeighborhoodIterator.h.

Constructor & Destructor Documentation

template<class TImage>

itk::ConstNeighborhoodIterator< TImage >::ConstNeighborhoodIterator ( )

Default constructor

template<class TImage>

virtual itk::ConstNeighborhoodIterator< TImage >::~ConstNeighborhoodIterator ( ) [inline, virtual]

Virtual destructor
Definition at line 92 of file itkConstNeighborhoodIterator.h.

template<class TImage>

itk::ConstNeighborhoodIterator< TImage >::ConstNeighborhoodIterator ( const ConstNeighborhoodIterator< TImage > & )

Copy constructor

template<class TImage>

itk::ConstNeighborhoodIterator< TImage >::ConstNeighborhoodIterator ( 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 99 of file itkConstNeighborhoodIterator.h.

Member Function Documentation

template<class TImage>

OffsetType itk::ConstNeighborhoodIterator< TImage >::ComputeInternalIndex ( unsigned int n ) const

Computes the internal, N-d offset of a pixel array position n from (0,0, ..., 0) in the "upper-left" corner of the neighborhood.

template<class TImage>

void itk::ConstNeighborhoodIterator< TImage >::ComputeStrideTable ( ) [inline, protected]

Computes the internal table of stride lengths.
Definition at line 308 of file itkConstNeighborhoodIterator.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIterator< TImage >::GetBeginIndex ( ) const [inline]

Returns the N-dimensional starting index of the iterator's position on the image.
Definition at line 166 of file itkConstNeighborhoodIterator.h.

template<class TImage>

long itk::ConstNeighborhoodIterator< TImage >::GetBound ( unsigned int n ) const [inline]

Returns the loop bound used to define the edge of a single dimension in the itk::Image region.
Definition at line 121 of file itkConstNeighborhoodIterator.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIterator< TImage >::GetBound ( ) const [inline]

Returns the array of upper loop bounds used during iteration.
Definition at line 116 of file itkConstNeighborhoodIterator.h.

template<class TImage>

PixelType itk::ConstNeighborhoodIterator< TImage >::GetCenterPixel ( ) const [inline]

Returns the pixel referenced at the center of the ConstNeighborhoodIterator.
Definition at line 129 of file itkConstNeighborhoodIterator.h.

template<class TImage>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage >::GetCenterPointer ( ) const [inline]

Returns the pointer to the center pixel of the neighborhood.
Definition at line 125 of file itkConstNeighborhoodIterator.h.

template<class TImage>

const ImageType* itk::ConstNeighborhoodIterator< TImage >::GetImagePointer ( void ) [inline]

Returns a smartpointer to the image on which this iterator operates.
Definition at line 133 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual IndexType itk::ConstNeighborhoodIterator< TImage >::GetIndex ( void ) const [inline, virtual]

Returns the N-dimensional index of the iterator's position in the image.
Definition at line 138 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual NeighborhoodType itk::ConstNeighborhoodIterator< TImage >::GetNeighborhood ( ) const [virtual]

Virtual function that "dereferences" a ConstNeighborhoodIterator, returning a Neighborhood of pixel values.
Reimplemented in itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.

template<class TImage>

InternalPixelType* itk::ConstNeighborhoodIterator< TImage >::GetOutputBuffer ( ) const [inline]

Returns the current memory location of the internal output pointer that is synchronized with the iterator.
See also:
SetOutputBuffer

Definition at line 148 of file itkConstNeighborhoodIterator.h.

template<class TImage>

OffsetType itk::ConstNeighborhoodIterator< TImage >::GetOutputWrapOffsetModifier ( ) const [inline]

Returns the offsets that will be used to adjust for differences in input and output buffer sizes.
Definition at line 153 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual PixelType itk::ConstNeighborhoodIterator< TImage >::GetPixel ( const unsigned long i ) const [inline, virtual]

Returns the pixel value referenced at a linear array location.
Reimplemented in itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 157 of file itkConstNeighborhoodIterator.h.

template<class TImage>

RegionType itk::ConstNeighborhoodIterator< TImage >::GetRegion ( ) const [inline]

Returns the region of iteration.
Definition at line 161 of file itkConstNeighborhoodIterator.h.

template<class TImage>

OffsetValueType itk::ConstNeighborhoodIterator< TImage >::GetWrapOffset ( unsigned int n ) const [inline]

Returns the internal offset associated with wrapping around a single dimension's region boundary in the itk::Image. An offset for each dimension is necessary to shift pointers when wrapping around region edges because region memory is not necessarily contiguous within the buffer.
Definition at line 178 of file itkConstNeighborhoodIterator.h.

template<class TImage>

OffsetType itk::ConstNeighborhoodIterator< TImage >::GetWrapOffset ( ) const [inline]

Returns the offsets used to wrap across dimensional boundaries.
Definition at line 170 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::GoToBegin ( ) [virtual]

Virtual method for rewinding the iterator to its beginning pixel. This is useful for writing functions which take neighborhood iterators of arbitrary type and must use virtual functions.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::GoToEnd ( ) [virtual]

Virtual method for sending the iterator to one past the last pixel in its region.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::Initialize ( const SizeType & radius,

const ImageType * ptr,

const RegionType & region

) [virtual]

Initializes the iterator to walk a particular image and a particular region of that image.
Reimplemented in itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.

template<class TImage>

virtual bool itk::ConstNeighborhoodIterator< TImage >::IsAtBegin ( ) const [inline, virtual]

Virtual method for determining whether the the iterator is at the beginning of its iteration region.
Definition at line 197 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual bool itk::ConstNeighborhoodIterator< TImage >::IsAtEnd ( ) const [inline, virtual]

Virtual method for determining whether the the iterator has reached the end of its iteration region.
Definition at line 202 of file itkConstNeighborhoodIterator.h.

template<class TImage>

itk::ConstNeighborhoodIterator< TImage >::itkStaticConstMacro ( Dimension ,

unsigned int,

TImage::ImageDimension

)

Save the image dimension.

template<class TImage>

bool itk::ConstNeighborhoodIterator< TImage >::operator!= ( const Self & it ) const [inline]

Returns a boolean != comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Definition at line 240 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual const Self& itk::ConstNeighborhoodIterator< TImage >::operator++ ( ) [virtual]

Increments the pointers in the ConstNeighborhoodIterator, wraps across boundaries automatically, accounting for the disparity in the buffer size and the region size of the image.

template<class TImage>

virtual const Self& itk::ConstNeighborhoodIterator< TImage >::operator-- ( ) [virtual]

Decrements the pointers in the ConstNeighborhoodIterator, wraps across boundaries automatically, accounting for the disparity in the buffer size and the region size of the image.

template<class TImage>

bool itk::ConstNeighborhoodIterator< TImage >::operator< ( const Self & it ) const [inline]

Returns a boolean < comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.
Definition at line 246 of file itkConstNeighborhoodIterator.h.

template<class TImage>

bool itk::ConstNeighborhoodIterator< TImage >::operator<= ( const Self & it ) const [inline]

Returns a boolean < comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.
Definition at line 252 of file itkConstNeighborhoodIterator.h.

template<class TImage>

Self& itk::ConstNeighborhoodIterator< TImage >::operator= ( const Self & orig )

Assignment operator
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage >, itk::RandomAccessNeighborhoodIterator< TImage >, itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.

template<class TImage>

bool itk::ConstNeighborhoodIterator< TImage >::operator== ( const Self & it ) const [inline]

Returns a boolean == comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Definition at line 234 of file itkConstNeighborhoodIterator.h.

template<class TImage>

bool itk::ConstNeighborhoodIterator< TImage >::operator> ( const Self & it ) const [inline]

Returns a boolean > comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.
Definition at line 258 of file itkConstNeighborhoodIterator.h.

template<class TImage>

bool itk::ConstNeighborhoodIterator< TImage >::operator>= ( const Self & it ) const [inline]

Returns a boolean >= comparison of the memory addresses of the center elements of two ConstNeighborhoodIterators of like pixel type and dimensionality. The radii of the iterators are ignored.
Definition at line 264 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::OverrideBoundaryCondition ( const ImageBoundaryConditionPointerType ) [inline, virtual]

Allows a user to override the internal boundary condition. Care should be be taken to ensure that the overriding boundary condition is a persistent object during the time it is referenced. The overriding condition can be of a different type than the default type as long as it is a subclass of ImageBoundaryCondition.
This method is only relevant in iterators that have the capability to handle boundary conditions.
Reimplemented in itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 275 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::PrintSelf ( std::ostream & ,

Indent

) const [virtual]

Standard itk print method
Reimplemented from itk::Neighborhood< TImage::InternalPixelType *,::itk::GetImageDimension< TImage >::ImageDimension >.
Reimplemented in itk::ConstRandomAccessNeighborhoodIterator< TImage >, itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< TImage >, itk::RandomAccessNeighborhoodIterator< TImage >, itk::SmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::ResetBoundaryCondition ( ) [inline, virtual]

Resets the boundary condition to the internal, default conditions specified by the template parameter.
Reimplemented in itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.
Definition at line 303 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::SetBeginIndex ( const IndexType & start ) [inline, protected, virtual]

Default method for setting the index of the first pixel in the iteration region.
Definition at line 333 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::SetBound ( const SizeType & ) [protected, virtual]

Virtual method for setting internal loop boundaries. This method must be defined in each subclass because each subclass may handle loop boundaries differently.
Reimplemented in itk::ConstSmartNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstSmartNeighborhoodIterator< TImage >.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::SetEndIndex ( ) [protected, virtual]

Default method for setting the index of the first pixel in the iteration region.

template<class TImage>

void itk::ConstNeighborhoodIterator< TImage >::SetLocation ( const IndexType & position ) [inline]

This method positions the iterator at an indexed location in the image. SetLocation should _NOT_ be used to update the position of the iterator during iteration, only for initializing it to a position prior to iteration. This method is not optimized for speed.
Definition at line 282 of file itkConstNeighborhoodIterator.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::SetLoop ( const IndexType & p ) [inline, protected, virtual]

Default method for setting the coordinate location of the iterator. Loop indicies correspond to the actual Image region index.
Definition at line 317 of file itkConstNeighborhoodIterator.h.

template<class TImage>

void itk::ConstNeighborhoodIterator< TImage >::SetOutputBuffer ( InternalPixelType * i ) [inline]

Sets the internal pointer to a memory buffer that is incremented in synch with the center of the ConstNeighborhoodIterator. This internal pointer can be used to guarantees spatial fidelity between inputs and outputs to an algorithm that uses ConstNeighborhoodIterators.
See also:
GetOutputBuffer

Definition at line 294 of file itkConstNeighborhoodIterator.h.

template<class TImage>

void itk::ConstNeighborhoodIterator< TImage >::SetOutputWrapOffsetModifier ( const OffsetType & modifiers )

Sets the offsets that will be used to adjust for any differences in input and output buffer sizes.

template<class TImage>

virtual void itk::ConstNeighborhoodIterator< TImage >::SetPixelPointers ( const IndexType & ) [protected, virtual]

Default method for setting the values of the internal pointers to itk::Image memory buffer locations. This method should generally only be called when the iterator is initialized.
See also:
SetLocation

Member Data Documentation

template<class TImage>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage >::m_Begin [protected]

A pointer to the first pixel in the iteration region.
Definition at line 348 of file itkConstNeighborhoodIterator.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIterator< TImage >::m_BeginIndex [protected]

The starting index for iteration within the itk::Image region on which this ConstNeighborhoodIterator is defined.
Definition at line 342 of file itkConstNeighborhoodIterator.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIterator< TImage >::m_Bound [protected]

An array of upper looping boundaries used during iteration.
Definition at line 345 of file itkConstNeighborhoodIterator.h.

template<class TImage>

ImageType::ConstPointer itk::ConstNeighborhoodIterator< TImage >::m_ConstImage [protected]

The image on which iteration is defined.
Definition at line 351 of file itkConstNeighborhoodIterator.h.

template<class TImage>

const InternalPixelType* itk::ConstNeighborhoodIterator< TImage >::m_End [protected]

Definition at line 356 of file itkConstNeighborhoodIterator.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIterator< TImage >::m_EndIndex [protected]

The end index for iteration within the itk::Image region on which this ConstNeighborhoodIterator is defined.
Definition at line 360 of file itkConstNeighborhoodIterator.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIterator< TImage >::m_Loop [protected]

Array of loop counters used during iteration.
Definition at line 363 of file itkConstNeighborhoodIterator.h.

template<class TImage>

InternalPixelType* itk::ConstNeighborhoodIterator< TImage >::m_OutputBuffer [protected]

A pointer to an output buffer that, if set, is moved in synch with the center position of the ConstNeighborhoodIterator.
The output buffer is assumed to be the same size as the itk::Image buffer on which the ConstNeighborhoodIterator is defined. Scalar output can be written directly to the synchronized pointer location.
Definition at line 371 of file itkConstNeighborhoodIterator.h.

template<class TImage>

OffsetType itk::ConstNeighborhoodIterator< TImage >::m_OutputWrapOffsetModifier [protected]

Modifiers that compensate for the difference in the sizes of the input and output buffers. m_OutputBuffer will be incremented by these additional values when wrapping across dimensional boundaries during iteration.
Definition at line 377 of file itkConstNeighborhoodIterator.h.

template<class TImage>

RegionType itk::ConstNeighborhoodIterator< TImage >::m_Region [protected]

The region over which iteration is defined.
Definition at line 380 of file itkConstNeighborhoodIterator.h.

template<class TImage>

unsigned long itk::ConstNeighborhoodIterator< TImage >::m_StrideTable[Dimension] [protected]

A table containing the stride length (step size in memory units) for each dimension. Computed once at construction.
Definition at line 384 of file itkConstNeighborhoodIterator.h.

template<class TImage>

OffsetType itk::ConstNeighborhoodIterator< TImage >::m_WrapOffset [protected]

The internal array of offsets that provide support for regions of interest. An offset for each dimension is necessary to shift pointers when wrapping around region edges because region memory is not necessarily contiguous within the buffer.
Definition at line 390 of file itkConstNeighborhoodIterator.h.

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

itkConstNeighborhoodIterator.h

Generated at Wed Mar 12 01:15:03 2003 for ITK by

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

Public Types

Public Methods

Protected Methods

Protected Attributes