#include <itkConstNeighborhoodIteratorWithOnlyIndex.h>

Detailed Description

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

Index-only version of ConstNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of indices 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.

Inheritance diagram for itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >:

Collaboration diagram for itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >:

Public Types
using	ConstIterator = typename AllocatorType::const_iterator

using	DimensionValueType = unsigned int

using	DummyNeighborhoodPixelType = char

using	ImageType = TImage

using	IndexType = Index< Self::Dimension >

using	Iterator = typename AllocatorType::iterator

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

using	NeighborIndexType = typename NeighborhoodType::NeighborIndexType

using	OffsetType = Offset< VDimension >

using	RadiusType = itk::Size< VDimension >

using	RegionType = typename TImage::RegionType

using	Self = ConstNeighborhoodIteratorWithOnlyIndex

using	SizeType = itk::Size< VDimension >

using	Superclass = Neighborhood< DummyNeighborhoodPixelType, Self::Dimension >

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

using	ConstIterator = typename AllocatorType::const_iterator

using	DimensionValueType = unsigned int

using	Iterator = typename AllocatorType::iterator

using	NeighborIndexType = SizeValueType

using	OffsetType = Offset< VDimension >

using	PixelType = char

using	RadiusType = itk::Size< VDimension >

using	Self = Neighborhood

using	SizeType = itk::Size< VDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SliceIteratorType = SliceIterator< char, Self >

Public Member Functions
OffsetType	ComputeInternalIndex (NeighborIndexType n) const

	ConstNeighborhoodIteratorWithOnlyIndex ()=default

	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 () const

IndexType	GetIndex () const

IndexType	GetIndex (const OffsetType &o) const

IndexType	GetIndex (NeighborIndexType i) const

bool	GetNeedToUseBoundaryCondition () const

RegionType	GetRegion () const

void	GoToBegin ()

void	GoToEnd ()

bool	InBounds () const

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

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

bool	IsAtBegin () const

bool	IsAtEnd () const

	ITK_DEFAULT_COPY_AND_MOVE (ConstNeighborhoodIteratorWithOnlyIndex)

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

void	NeedToUseBoundaryConditionOff ()

void	NeedToUseBoundaryConditionOn ()

Self &	operator++ ()

Self &	operator+= (const OffsetType &)

OffsetType	operator- (const Self &b) const

Self &	operator-- ()

Self &	operator-= (const OffsetType &)

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

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

void	SetLocation (const IndexType &position)

void	SetNeedToUseBoundaryCondition (bool b)

	~ConstNeighborhoodIteratorWithOnlyIndex () override=default

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

char	GetCenterValue () const

virtual const char *	GetNameOfClass () const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

OffsetType	GetOffset (NeighborIndexType i) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeType	GetSize () const

SizeValueType	GetSize (DimensionValueType n) const

std::slice	GetSlice (unsigned int) const

OffsetValueType	GetStride (DimensionValueType axis) const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

	Neighborhood ()=default

	Neighborhood (const Self &)=default

	Neighborhood (Self &&)=default

Self &	operator= (const Self &)=default

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

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

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

Protected Member Functions
void	SetBeginIndex (const IndexType &start)

void	SetBound (const SizeType &)

void	SetEndIndex ()

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

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

void	SetSize ()

Protected Attributes
IndexType	m_BeginIndex { { 0 } }

IndexType	m_Bound { { 0 } }

ImageType::ConstPointer	m_ConstImage {}

IndexType	m_EndIndex { { 0 } }

bool	m_InBounds [Dimension] { false }

IndexType	m_InnerBoundsHigh {}

IndexType	m_InnerBoundsLow {}

bool	m_IsInBounds { false }

bool	m_IsInBoundsValid { false }

IndexType	m_Loop { { 0 } }

bool	m_NeedToUseBoundaryCondition { false }

RegionType	m_Region {}

Member Typedef Documentation

◆ ConstIterator

template<typename TImage >

using itk::Neighborhood< TPixel, VDimension, TAllocator >::ConstIterator = typename AllocatorType::const_iterator

Definition at line 76 of file itkNeighborhood.h.

◆ DimensionValueType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DimensionValueType = unsigned int

Type used to refer to space dimensions

Definition at line 66 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ DummyNeighborhoodPixelType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::DummyNeighborhoodPixelType = char

Definition at line 71 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ ImageType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::ImageType = TImage

Typedef support for common objects

Definition at line 85 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ IndexType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexType = Index<Self::Dimension>

Definition at line 87 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ Iterator

template<typename TImage >

using itk::Neighborhood< TPixel, VDimension, TAllocator >::Iterator = typename AllocatorType::iterator

Iterator type alias support Note the naming is intentional, i.e., AllocatorType::iterator and AllocatorType::const_iterator, because the allocator may be a vnl object or other type, which uses this form.

Definition at line 75 of file itkNeighborhood.h.

◆ NeighborhoodType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeighborhoodType = Neighborhood<DummyNeighborhoodPixelType, Self::Dimension>

Definition at line 88 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ NeighborIndexType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::NeighborIndexType = typename NeighborhoodType::NeighborIndexType

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

Definition at line 91 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ OffsetType

template<typename TImage >

using itk::Neighborhood< TPixel, VDimension, TAllocator >::OffsetType = Offset<VDimension>

Offset type used to reference neighbor locations

Definition at line 86 of file itkNeighborhood.h.

◆ RadiusType

template<typename TImage >

using itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType = itk::Size<VDimension>

Radius type alias support

Definition at line 83 of file itkNeighborhood.h.

◆ RegionType

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::RegionType = typename TImage::RegionType

Definition at line 86 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ Self

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Self = ConstNeighborhoodIteratorWithOnlyIndex

Standard class type aliases.

Definition at line 74 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ SizeType

template<typename TImage >

using itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeType = itk::Size<VDimension>

Size and value type alias support

Definition at line 79 of file itkNeighborhood.h.

◆ Superclass

template<typename TImage >

using itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::Superclass = Neighborhood<DummyNeighborhoodPixelType, Self::Dimension>

Definition at line 75 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

Constructor & Destructor Documentation

◆ ConstNeighborhoodIteratorWithOnlyIndex() [1/2]

template<typename TImage >

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

default

Default constructor

◆ ~ConstNeighborhoodIteratorWithOnlyIndex()

template<typename TImage >

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

overridedefault

Virtual destructor

◆ ConstNeighborhoodIteratorWithOnlyIndex() [2/2]

template<typename 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

◆ ComputeInternalIndex()

template<typename 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.

◆ GetBeginIndex()

template<typename 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 168 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetBound() [1/2]

template<typename TImage >

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

inline

Returns the array of upper loop bounds used during iteration.

Definition at line 114 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetBound() [2/2]

template<typename 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 122 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetBoundingBoxAsImageRegion()

template<typename TImage >

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

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

◆ GetImagePointer()

template<typename TImage >

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

inline

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

Definition at line 129 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetIndex() [1/3]

template<typename TImage >

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

inline

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

Definition at line 137 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

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

◆ GetIndex() [2/3]

template<typename TImage >

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

inline

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

Definition at line 145 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetIndex() [3/3]

template<typename TImage >

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

inline

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

Definition at line 153 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetNeedToUseBoundaryCondition()

template<typename TImage >

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

inline

Definition at line 331 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GetRegion()

template<typename TImage >

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

inline

Returns the region of iteration.

Definition at line 160 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ GoToBegin()

template<typename TImage >

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

Method for rewinding the iterator to its beginning image index.

◆ GoToEnd()

template<typename TImage >

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

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

◆ InBounds()

template<typename 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.

◆ IndexInBounds()

template<typename TImage >

bool itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >::IndexInBounds	(	const 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.

◆ Initialize()

template<typename TImage >

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

Initializes the iterator to walk a particular image and a particular region of that image.

◆ IsAtBegin()

template<typename TImage >

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

inline

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

Definition at line 195 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ IsAtEnd()

template<typename TImage >

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

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

◆ ITK_DEFAULT_COPY_AND_MOVE()

template<typename TImage >

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

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TImage >

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

◆ NeedToUseBoundaryConditionOff()

template<typename TImage >

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

inline

Definition at line 319 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ NeedToUseBoundaryConditionOn()

template<typename TImage >

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

inline

Definition at line 313 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ operator++()

template<typename 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.

◆ operator+=()

template<typename 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.

◆ operator-()

template<typename TImage >

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

inline

Distance between two iterators

Definition at line 286 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

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

◆ operator--()

template<typename 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.

◆ operator-=()

template<typename 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.

◆ operator<()

template<typename 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.

◆ operator<=()

template<typename 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.

◆ operator==()

template<typename 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 223 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

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

◆ operator>()

template<typename 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.

◆ operator>=()

template<typename 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.

◆ PrintSelf()

template<typename TImage >

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

overridevirtual

Standard itk print method

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

◆ SetBeginIndex()

template<typename TImage >

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

inlineprotected

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

Definition at line 355 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.

◆ SetBound()

template<typename TImage >

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

protected

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

◆ SetEndIndex()

template<typename TImage >

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

protected

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

◆ SetLocation()

template<typename 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 267 of file itkConstNeighborhoodIteratorWithOnlyIndex.h.