#include <itkConstNeighborhoodIteratorWithOnlyIndex.h>

Inheritance diagram for itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >:

Collaboration diagram for itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >:

Detailed Description

template<class TImage>
class itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >

Index-only version of ConstNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of indecies across an itk::Image or itk::ImageBase.

ConstNeighborhoodIteratorWithOnlyIndex implements the index-only methods of NeighborhoodIterator. No image data is accessed, so this iterator can be used with type itk::ImageBase. It serves as a base class from which other iterators can be derived. See NeighborhoodIterator for more complete information.

The parent class itk::Neighborhood is declared with 'char' as its first template parameter, because the pixel type is not used in this class.

Other index-only iterators:

See Also: ImageConstIteratorWithOnlyIndex; ConstNeighborhoodIteratorWithOnlyIndex

Other iterators:

See Also: ImageIterator; NeighborhoodIterator; Neighborhood

Definition at line 60 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Public Types
typedef Superclass::ConstIterator	ConstIterator

typedef unsigned int	DimensionValueType

typedef char	DummyNeighborhoodPixelType

typedef Superclass::Iterator	Iterator

typedef NeighborhoodType::NeighborIndexType	NeighborIndexType

typedef Superclass::OffsetType	OffsetType

typedef Superclass::RadiusType	RadiusType

typedef ConstNeighborhoodIteratorWithOnlyIndex	Self

typedef Superclass::SizeType	SizeType

typedef Neighborhood < DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) >	Superclass


typedef TImage	ImageType

typedef TImage::RegionType	RegionType

typedef Index < itkGetStaticConstMacro(Dimension) >	IndexType

typedef Neighborhood < DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) >	NeighborhoodType

Public Types inherited from itk::Neighborhood< char, TImage::ImageDimension >
typedef NeighborhoodAllocator < char >	AllocatorType

typedef AllocatorType::const_iterator	ConstIterator

typedef unsigned int	DimensionValueType

typedef AllocatorType::iterator	Iterator

typedef SizeValueType	NeighborIndexType

typedef Offset< VDimension >	OffsetType

typedef char	PixelType

typedef Neighborhood	Self

typedef SizeType::SizeValueType	SizeValueType

typedef SliceIterator< char, Self >	SliceIteratorType

Public Member Functions
OffsetType	ComputeInternalIndex (NeighborIndexType n) const

	ConstNeighborhoodIteratorWithOnlyIndex ()

	ConstNeighborhoodIteratorWithOnlyIndex (const ConstNeighborhoodIteratorWithOnlyIndex &)

	ConstNeighborhoodIteratorWithOnlyIndex (const SizeType &radius, const ImageType *ptr, const RegionType &region)

IndexType	GetBeginIndex () const

IndexType	GetBound () const

IndexValueType	GetBound (NeighborIndexType n) const

RegionType	GetBoundingBoxAsImageRegion () const

const ImageType *	GetImagePointer (void) const

virtual IndexType	GetIndex (void) const

virtual IndexType	GetIndex (const OffsetType &o) const

virtual IndexType	GetIndex (NeighborIndexType i) const

bool	GetNeedToUseBoundaryCondition () const

RegionType	GetRegion () const

virtual void	GoToBegin ()

virtual void	GoToEnd ()

bool	InBounds () const

bool	IndexInBounds (NeighborIndexType n, OffsetType &internalIndex, OffsetType &offset) const

virtual void	Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)

virtual bool	IsAtBegin () const

virtual bool	IsAtEnd () const

void	NeedToUseBoundaryConditionOff ()

void	NeedToUseBoundaryConditionOn ()

bool	operator!= (const Self &it) const

Self &	operator++ ()

Self &	operator+= (const OffsetType &)

OffsetType	operator- (const Self &b)

Self &	operator-- ()

Self &	operator-= (const OffsetType &)

bool	operator< (const Self &it) const

bool	operator<= (const Self &it) const

Self &	operator= (const Self &orig)

bool	operator== (const Self &it) const

bool	operator> (const Self &it) const

bool	operator>= (const Self &it) const

virtual void	PrintSelf (std::ostream &, Indent) const

void	SetLocation (const IndexType &position)

void	SetNeedToUseBoundaryCondition (bool b)

virtual	~ConstNeighborhoodIteratorWithOnlyIndex ()

Public Member Functions inherited from itk::Neighborhood< char, TImage::ImageDimension >
NeighborIndexType	GetCenterNeighborhoodIndex () const

char	GetCenterValue () const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

OffsetType	GetOffset (NeighborIndexType i) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeValueType	GetSize (DimensionValueType n) const

SizeType	GetSize () const

std::slice	GetSlice (unsigned int) const

OffsetValueType	GetStride (DimensionValueType axis) const

	Neighborhood (const Self &other)

bool	operator!= (const Self &other) const

Self &	operator= (const Self &other)

bool	operator== (const Self &other) const

void	Print (std::ostream &os) const

void	SetRadius (const SizeType &)

void	SetRadius (const SizeValueType)

NeighborIndexType	Size () const

virtual	~Neighborhood ()

	Neighborhood ()

Iterator	End ()

ConstIterator	End () const

Iterator	Begin ()

ConstIterator	Begin () const

char &	operator[] (NeighborIndexType i)

const char &	operator[] (NeighborIndexType i) const

char &	GetElement (NeighborIndexType i)

char &	operator[] (const OffsetType &o)

const char &	operator[] (const OffsetType &o) const

void	SetRadius (const SizeValueType *rad)

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

Static Public Attributes
static const DimensionValueType	Dimension = TImage::ImageDimension

Static Public Attributes inherited from itk::Neighborhood< char, TImage::ImageDimension >
static const unsigned int	NeighborhoodDimension

Protected Member Functions
virtual void	SetBeginIndex (const IndexType &start)

virtual void	SetBound (const SizeType &)

virtual void	SetEndIndex ()

virtual void	SetLoop (const IndexType &p)

Protected Member Functions inherited from itk::Neighborhood< char, TImage::ImageDimension >
virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

void	SetSize ()

Protected Attributes
IndexType	m_BeginIndex

IndexType	m_Bound

ImageType::ConstPointer	m_ConstImage

IndexType	m_EndIndex

bool	m_InBounds [Dimension]

IndexType	m_InnerBoundsHigh

IndexType	m_InnerBoundsLow

bool	m_IsInBounds

bool	m_IsInBoundsValid

IndexType	m_Loop

bool	m_NeedToUseBoundaryCondition

RegionType	m_Region

Additional Inherited Members
Public Attributes inherited from itk::Neighborhood< char, TImage::ImageDimension >
typedef::itk::Size< VDimension >	RadiusType

typedef::itk::Size< VDimension >	SizeType

Member Typedef Documentation

template<class TImage>

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

Definition at line 82 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef unsigned int itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DimensionValueType

Type used to refer to space dimensions

Definition at line 66 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef char itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DummyNeighborhoodPixelType

Definition at line 71 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef TImage itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ImageType

Typedef support for common objects

Definition at line 85 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef Index< itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexType

Typedef support for common objects

Definition at line 87 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

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

Definition at line 81 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef Neighborhood< DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeighborhoodType

Typedef support for common objects

Definition at line 88 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef NeighborhoodType::NeighborIndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeighborIndexType

Type used to refer to the elements in the list of neighbor pixels.

Definition at line 92 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef Superclass::OffsetType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::OffsetType

Inherit typedefs from superclass

Definition at line 78 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

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

Definition at line 79 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef TImage::RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::RegionType

Typedef support for common objects

Definition at line 86 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef ConstNeighborhoodIteratorWithOnlyIndex itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Self

Standard class typedefs.

Definition at line 74 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef Superclass::SizeType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SizeType

Definition at line 80 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

typedef Neighborhood< DummyNeighborhoodPixelType, itkGetStaticConstMacro(Dimension) > itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Superclass

Definition at line 75 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

template<class TImage>

itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstNeighborhoodIteratorWithOnlyIndex ( )

Default constructor

template<class TImage>

virtual itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::~ConstNeighborhoodIteratorWithOnlyIndex ( )

inlinevirtual

Virtual destructor

Definition at line 98 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

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

Copy constructor

template<class TImage>

itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ConstNeighborhoodIteratorWithOnlyIndex	(	const SizeType &	radius,
		const ImageType *	ptr,
		const RegionType &	region
	)

Constructor which establishes the region size, neighborhood, and image over which to walk.

Member Function Documentation

template<class TImage>

OffsetType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ComputeInternalIndex ( NeighborIndexType 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>

IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBeginIndex ( ) const

inline

Returns the N-dimensional starting index of the iterator's position on the image.

Definition at line 165 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBound ( ) const

inline

Returns the array of upper loop bounds used during iteration.

Definition at line 118 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

IndexValueType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBound ( NeighborIndexType n ) const

inline

Returns the loop bound used to define the edge of a single dimension in the itk::Image region.

Definition at line 125 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetBoundingBoxAsImageRegion ( ) const

Returns a bounding box for the region spanned by this neighborhood represented by an itk::ImageRegion

template<class TImage>

const ImageType* itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetImagePointer ( void ) const

inline

Returns a smartpointer to the image on which this iterator operates.

Definition at line 131 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

virtual IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex ( void ) const

inlinevirtual

Returns the N-dimensional index of the iterator's position in the image.

Definition at line 138 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Referenced by itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator!=(), and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator==().

template<class TImage>

virtual IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex ( const OffsetType & o ) const

inlinevirtual

Returns the image index for neighbor pixel at offset o from the center of the neighborhood.

Definition at line 145 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

virtual IndexType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex ( NeighborIndexType i ) const

inlinevirtual

Returns the image index for neighbor pixel at index i in the neighborhood.

Definition at line 152 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetNeedToUseBoundaryCondition ( ) const

inline

Definition at line 313 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

RegionType itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetRegion ( ) const

inline

Returns the region of iteration.

Definition at line 158 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GoToBegin ( )

virtual

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

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GoToEnd ( )

virtual

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

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::InBounds ( ) const

Returns false if the iterator overlaps region boundaries, true otherwise. Also updates an internal boolean array indicating which of the iterator's faces are out of bounds.

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexInBounds	(	NeighborIndexType	n,
		OffsetType &	internalIndex,
		OffsetType &	offset
	)		const

Returns true if the neighborhood index is within region boundaries, false otherwise. If false, then internalIndex and offset are calculated. Otherwise their values are left unchanged. Also updates an internal boolean array indicating which of the iterator's faces are out of bounds.

Parameters

n	- linear neighborhood index.
internalIndex	- calculated for index `n` only when the neighborhood is not completely within region boundaries.
offset	- per-dimension offsets for index n to nearest boundary index, calculate only when the neighborhood is not completely within region boundaries.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< 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.

template<class TImage>

virtual bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IsAtBegin ( ) const

inlinevirtual

Virtual method for determining whether the iterator is at the beginning of its iteration region.

Definition at line 189 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

virtual bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IsAtEnd ( ) const

virtual

Virtual method for determining whether the iterator has reached the end of its iteration region.

template<class TImage>

void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeedToUseBoundaryConditionOff ( )

inline

Definition at line 303 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeedToUseBoundaryConditionOn ( )

inline

Definition at line 298 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator!= ( const Self & it ) const

inline

Returns a boolean != comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored.

Definition at line 221 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex().

template<class TImage>

Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator++ ( )

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

template<class TImage>

Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< 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::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator- ( const Self & b )

inline

Distance between two iterators

Definition at line 274 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::m_Loop.

template<class TImage>

Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator-- ( )

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

template<class TImage>

Self& itk::ConstNeighborhoodIteratorWithOnlyIndex< 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>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator< ( const Self & it ) const

Returns a boolean < comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator<= ( const Self & it ) const

Returns a boolean <= comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

template<class TImage>

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

Assignment operator

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator== ( const Self & it ) const

inline

Returns a boolean == comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored.

Definition at line 213 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

References itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::GetIndex().

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator> ( const Self & it ) const

Returns a boolean > comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

template<class TImage>

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::operator>= ( const Self & it ) const

Returns a boolean >= comparison of the current location/index of two ConstNeighborhoodIteratorWithOnlyIndexs of like dimensionality. The radii of the iterators are ignored. The comparison progresses by dimension starting from the greatest.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::PrintSelf	(	std::ostream &	,
		Indent
	)		const

virtual

Standard itk print method

Reimplemented from itk::Neighborhood< char, TImage::ImageDimension >.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetBeginIndex ( const IndexType & start )

inlineprotectedvirtual

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

Definition at line 334 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetBound ( const SizeType & )

protectedvirtual

Virtual method for setting internal loop boundaries. This method must be defined in each subclass because each subclass may handle loop boundaries differently.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetEndIndex ( )

protectedvirtual

Default method for setting the last index of the iteration region.

template<class TImage>

void itk::ConstNeighborhoodIteratorWithOnlyIndex< 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 258 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

template<class TImage>

virtual void itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::SetLoop ( const IndexType & p )