#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:: Examples/Iterators/NeighborhoodIterators1.cxx, Examples/Iterators/NeighborhoodIterators2.cxx, Examples/Iterators/NeighborhoodIterators3.cxx, Examples/Iterators/NeighborhoodIterators4.cxx, Examples/Iterators/NeighborhoodIterators5.cxx, WikiExamples/Iterators/ConstantBoundaryCondition.cxx, and WikiExamples/Iterators/ConstNeighborhoodIterator.cxx.

Definition at line 51 of file itkConstNeighborhoodIterator.h.

Public Types
using	BoundaryConditionType = TBoundaryCondition

using	ConstIterator = typename Superclass::ConstIterator

using	DimensionValueType = unsigned int

using	ImageBoundaryConditionConstPointerType = const ImageBoundaryCondition< ImageType, OutputImageType > *

using	ImageBoundaryConditionPointerType = ImageBoundaryCondition< ImageType, OutputImageType > *

using	ImageType = TImage

using	IndexType = Index< Self::Dimension >

using	InternalPixelType = typename TImage::InternalPixelType

using	Iterator = typename Superclass::Iterator

using	NeighborhoodAccessorFunctorType = typename ImageType::NeighborhoodAccessorFunctorType

using	NeighborhoodType = Neighborhood< PixelType, Self::Dimension >

using	NeighborIndexType = typename NeighborhoodType::NeighborIndexType

using	OffsetType = typename Superclass::OffsetType

using	OutputImageType = typename BoundaryConditionType::OutputImageType

using	PixelType = typename TImage::PixelType

using	RadiusType = typename Superclass::RadiusType

using	RegionType = typename TImage::RegionType

using	Self = ConstNeighborhoodIterator

using	SizeType = typename Superclass::SizeType

using	Superclass = Neighborhood< InternalPixelType *, Self::Dimension >

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

using	ConstIterator = typename AllocatorType::const_iterator

using	DimensionValueType = unsigned int

using	Iterator = typename AllocatorType::iterator

using	NeighborIndexType = SizeValueType

using	OffsetType = Offset< VDimension >

using	PixelType = TImage::InternalPixelType *

using	RadiusType = ::itk::Size< VDimension >

using	Self = Neighborhood

using	SizeType = ::itk::Size< VDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SliceIteratorType = SliceIterator< TImage::InternalPixelType *, Self >

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

IndexType	GetFastIndexPlusOffset (const OffsetType &o) const

const ImageType *	GetImagePointer () const

ITK_ITERATOR_VIRTUAL IndexType	GetIndex () const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL IndexType	GetIndex (const OffsetType &o) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL IndexType	GetIndex (NeighborIndexType i) const ITK_ITERATOR_FINAL

bool	GetNeedToUseBoundaryCondition () const

ITK_ITERATOR_VIRTUAL NeighborhoodType	GetNeighborhood () const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetNext (const unsigned axis, NeighborIndexType i) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetNext (const unsigned axis) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetPixel (const NeighborIndexType i) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetPixel (NeighborIndexType i, bool &IsInBounds) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetPixel (const OffsetType &o) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetPrevious (const unsigned axis, NeighborIndexType i) const ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL PixelType	GetPrevious (const unsigned axis) const ITK_ITERATOR_FINAL

RegionType	GetRegion () const

OffsetType	GetWrapOffset () const

OffsetValueType	GetWrapOffset (NeighborIndexType n) const

ITK_ITERATOR_VIRTUAL void	GoToBegin () ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL void	GoToEnd () ITK_ITERATOR_FINAL

bool	InBounds () const

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

bool	IndexInBounds (const NeighborIndexType n) const

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

ITK_ITERATOR_VIRTUAL bool	IsAtBegin () const ITK_ITERATOR_FINAL

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

ITK_ITERATOR_VIRTUAL void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i) ITK_ITERATOR_FINAL

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

ITK_ITERATOR_VIRTUAL void	ResetBoundaryCondition () ITK_ITERATOR_FINAL

void	SetBoundaryCondition (const TBoundaryCondition &c)

void	SetNeedToUseBoundaryCondition (bool b)

ITK_ITERATOR_VIRTUAL void	SetRegion (const RegionType &region) ITK_ITERATOR_FINAL

	~ConstNeighborhoodIterator () override=default


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


ITK_ITERATOR_VIRTUAL bool	IsAtEnd () const ITK_ITERATOR_FINAL


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

	itkTypeMacroNoParent (Neighborhood)

	Neighborhood (const Self &other)

	Neighborhood (Self &&)=default

bool	operator!= (const Self &other) const

Self &	operator= (const Self &other)

Self &	operator= (Self &&)=default

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 ()=default

	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 constexpr DimensionValueType	Dimension = TImage::ImageDimension

Static Public Attributes inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
static constexpr unsigned int	NeighborhoodDimension

Protected Member Functions
ITK_ITERATOR_VIRTUAL void	SetBeginIndex (const IndexType &start) ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL void	SetBound (const SizeType &) ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL void	SetEndIndex () ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL void	SetLoop (const IndexType &p) ITK_ITERATOR_FINAL

ITK_ITERATOR_VIRTUAL void	SetPixelPointers (const IndexType &) ITK_ITERATOR_FINAL

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 {false}

bool	m_IsInBoundsValid {false}

IndexType	m_Loop

bool	m_NeedToUseBoundaryCondition {false}

NeighborhoodAccessorFunctorType	m_NeighborhoodAccessorFunctor

RegionType	m_Region

OffsetType	m_WrapOffset