#include <itkConstNeighborhoodIterator.h>

Inheritance diagram for itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >:

Collaboration diagram for itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >:

Detailed Description

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
class itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >

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

Wiki Examples:

Examples:: Iterators/NeighborhoodIterators1.cxx, Iterators/NeighborhoodIterators2.cxx, Iterators/NeighborhoodIterators3.cxx, Iterators/NeighborhoodIterators4.cxx, and Iterators/NeighborhoodIterators5.cxx.

Definition at line 51 of file itkConstNeighborhoodIterator.h.

Public Types
typedef TBoundaryCondition	BoundaryConditionType

typedef Superclass::ConstIterator	ConstIterator

typedef unsigned int	DimensionValueType

typedef ImageBoundaryCondition < ImageType > const *	ImageBoundaryConditionConstPointerType

typedef ImageBoundaryCondition < ImageType > *	ImageBoundaryConditionPointerType

typedef TImage::InternalPixelType	InternalPixelType

typedef Superclass::Iterator	Iterator

typedef ImageType::NeighborhoodAccessorFunctorType	NeighborhoodAccessorFunctorType

typedef NeighborhoodType::NeighborIndexType	NeighborIndexType

typedef Superclass::OffsetType	OffsetType

typedef TImage::PixelType	PixelType

typedef Superclass::RadiusType	RadiusType

typedef ConstNeighborhoodIterator	Self

typedef Superclass::SizeType	SizeType

typedef Neighborhood < InternalPixelType *, itkGetStaticConstMacro(Dimension) >	Superclass


typedef TImage	ImageType

typedef TImage::RegionType	RegionType

typedef Index < itkGetStaticConstMacro(Dimension) >	IndexType

typedef Neighborhood < PixelType, itkGetStaticConstMacro(Dimension) >	NeighborhoodType

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

typedef AllocatorType::const_iterator	ConstIterator

typedef unsigned int	DimensionValueType

typedef AllocatorType::iterator	Iterator

typedef SizeValueType	NeighborIndexType

typedef Offset< VDimension >	OffsetType

typedef TImage::InternalPixelType *	PixelType

typedef Neighborhood	Self

typedef SizeType::SizeValueType	SizeValueType

typedef SliceIterator < TImage::InternalPixelType *, Self >	SliceIteratorType

Public Member Functions
OffsetType	ComputeInternalIndex (const NeighborIndexType n) const

	ConstNeighborhoodIterator ()

	ConstNeighborhoodIterator (const ConstNeighborhoodIterator &)

IndexType	GetBeginIndex () const

IndexType	GetBound () const

IndexValueType	GetBound (NeighborIndexType n) const

ImageBoundaryConditionPointerType	GetBoundaryCondition () const

RegionType	GetBoundingBoxAsImageRegion () const

PixelType	GetCenterPixel () const

const InternalPixelType *	GetCenterPointer () 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

virtual NeighborhoodType	GetNeighborhood () const

virtual PixelType	GetNext (const unsigned axis, NeighborIndexType i) const

virtual PixelType	GetNext (const unsigned axis) const

virtual PixelType	GetPixel (NeighborIndexType i, bool &IsInBounds) const

virtual PixelType	GetPixel (const OffsetType &o) const

virtual PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const

virtual PixelType	GetPrevious (const unsigned axis, NeighborIndexType i) const

virtual PixelType	GetPrevious (const unsigned axis) const

RegionType	GetRegion () const

OffsetType	GetWrapOffset () const

OffsetValueType	GetWrapOffset (NeighborIndexType n) 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

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	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)

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

virtual void	ResetBoundaryCondition ()

void	SetBoundaryCondition (const TBoundaryCondition &c)

void	SetNeedToUseBoundaryCondition (bool b)

virtual void	SetRegion (const RegionType &region)

virtual	~ConstNeighborhoodIterator ()


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


virtual PixelType	GetPixel (NeighborIndexType i) const


virtual bool	IsAtEnd () const


void	SetLocation (const IndexType &position)

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

TImage::InternalPixelType *	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

TImage::InternalPixelType *&	operator[] (NeighborIndexType i)

const TImage::InternalPixelType *&	operator[] (NeighborIndexType i) const

TImage::InternalPixelType *&	GetElement (NeighborIndexType i)

TImage::InternalPixelType *&	operator[] (const OffsetType &o)

const TImage::InternalPixelType *&	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< TImage::InternalPixelType *, 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)

virtual void	SetPixelPointers (const IndexType &)

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

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

void	SetSize ()

Protected Attributes
const InternalPixelType *	m_Begin

IndexType	m_BeginIndex

IndexType	m_Bound

ImageBoundaryConditionPointerType	m_BoundaryCondition

ImageType::ConstWeakPointer	m_ConstImage

const InternalPixelType *	m_End

IndexType	m_EndIndex

bool	m_InBounds [Dimension]

IndexType	m_InnerBoundsHigh

IndexType	m_InnerBoundsLow

TBoundaryCondition	m_InternalBoundaryCondition

bool	m_IsInBounds

bool	m_IsInBoundsValid

IndexType	m_Loop

bool	m_NeedToUseBoundaryCondition

NeighborhoodAccessorFunctorType	m_NeighborhoodAccessorFunctor

RegionType	m_Region

OffsetType	m_WrapOffset

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

typedef::itk::Size< VDimension >	SizeType