#include <itkShapedNeighborhoodIterator.h>

Detailed Description

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

A neighborhood iterator which can take on an arbitrary shape.

General Information: The ShapedNeighborhoodIterator is a refinement of NeighborhoodIterator which allows the user to specify which of the neighborhood elements are active and which will be ignored. This is useful for applications which only need to work with a subset of the neighborhood around a pixel such as morphological operations or cellular automata. This iterator can also be used, for example, to specify "cross-shaped" neighborhood where only elements along a spatial axes are significant.

Constructing a shaped neighborhood iterator: A shaped neighborhood iterator is constructed by constructing a list of active neighbor locations. The list is called the ActiveIndexList. The methods ActivateOffset, DeactivateOffset, and ClearActiveList are used to construct the ActiveIndexList. The argument to Activate/DeactivateOffset is an itk::Offset which represents the ND spatial offset from the center of the neighborhood. For example, to activate the center pixel in the neighborhood, you would do the following:

using ImageType = Image<float, 3>;
ShapedNeighborhoodIterator<ImageType> it(radius, image, region);
ShapedNeighborhoodIterator<ImageType>::OffsetType offset = {{0,0,0}};
it.ActivateOffset(offset);

where radius, image, and region are as described in NeighborhoodIterator.

Once a neighborhood location has been activated, iteration (operator++, operator--, operator+=, operator-=) will update the value at the active location. Note that values at inactive locations will NOT be valid if queried.

Accessing elements in a shaped neighborhood.: To access the value at an active neighborhood location, you can use the standard GetPixel, SetPixel methods. SetPixel is not defined for ConstShapedNeighborhoodIterator. The class will not complain if you attempt to access a value at a non-active location, but be aware that the result will be undefined. Error checking is not done in this case for the sake of efficiency.

A second way to access active shaped neighborhood values is through a ShapedNeighborhoodIterator::Iterator or ConstShapedNeighborhoodIterator::ConstIterator. The following example demonstrates the use of these iterators.

using ImageType = Image<float, 3>;
ShapedNeighborhoodIterator<ImageType> it(radius, image, region);
...
it.ActivateOffset(offset1);
it.ActivateOffset(offset2);
it.ActivateOffset(offset3);
// etc..
...
for (auto i = it.Begin(); ! i.IsAtEnd(); ++i)
{ i.Set(i.Get() + 1.0); }
// you may also use i != i.End(), but IsAtEnd() may be slightly faster.

You can also iterate backward through the neighborhood active list.

i = it.End();
--i;
while (i != it.Begin())
{
  i.Set(i.Get() + 1.0);
  --i;
}
 i.Set(i.Get() + 1.0);

The Get() Set() syntax was chosen versus defining operator* for these iterators because lvalue vs. rvalue context information is needed to determine whether bounds checking must take place.

See also: Neighborhood

MORE INFORMATION: For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from https://www.itk.org.

See also: ImageConstIterator; ConditionalConstIterator; ConstNeighborhoodIterator; ConstShapedNeighborhoodIterator; ConstSliceIterator; CorrespondenceDataStructureIterator; FloodFilledFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalIterator; FloodFilledSpatialFunctionConditionalConstIterator; FloodFilledSpatialFunctionConditionalIterator; ImageConstIterator; ImageConstIteratorWithIndex; ImageIterator; ImageIteratorWithIndex; ImageLinearConstIteratorWithIndex; ImageLinearIteratorWithIndex; ImageRandomConstIteratorWithIndex; ImageRandomIteratorWithIndex; ImageRegionConstIterator; ImageRegionConstIteratorWithIndex; ImageRegionExclusionConstIteratorWithIndex; ImageRegionExclusionIteratorWithIndex; ImageRegionIterator; ImageRegionIteratorWithIndex; ImageRegionReverseConstIterator; ImageRegionReverseIterator; ImageReverseConstIterator; ImageReverseIterator; ImageSliceConstIteratorWithIndex; ImageSliceIteratorWithIndex; NeighborhoodIterator; PathConstIterator; PathIterator; ShapedNeighborhoodIterator; SliceIterator; ImageConstIteratorWithIndex; ShapedImageNeighborhoodRange

ITK Sphinx Examples:

All ITK Sphinx Examples

Iterate Over A Region With A Shaped Neighborhood Iterator Manually

Iterate Over A Region With A Shaped Neighborhood Iterator

Definition at line 149 of file itkShapedNeighborhoodIterator.h.

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

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

Classes
struct	Iterator

Public Types
using	InternalPixelType = typename TImage::InternalPixelType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelType = typename TImage::PixelType

using	Self = ShapedNeighborhoodIterator

using	Superclass = ConstShapedNeighborhoodIterator<TImage, TBoundaryCondition>

Public Types inherited from itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >
using	BoundaryConditionType = TBoundaryCondition

using	ImageBoundaryConditionPointerType = ImageBoundaryCondition<ImageType> *

using	ImageType = TImage

using	IndexListConstIterator = typename IndexListType::const_iterator

using	IndexListIterator = typename IndexListType::iterator

using	IndexListType = std::list<NeighborIndexType>

using	IndexType = Index<Self::Dimension>

using	IndexValueType = typename IndexType::IndexValueType

using	InternalPixelType = typename TImage::InternalPixelType

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

using	NeighborIndexType = typename NeighborhoodType::NeighborIndexType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelType = typename TImage::PixelType

using	RegionType = typename TImage::RegionType

using	Self = ConstShapedNeighborhoodIterator

using	SizeValueType = typename SizeType::SizeValueType

using	Superclass = NeighborhoodIterator<TImage, TBoundaryCondition>

Public Member Functions
ConstIterator	Begin () const

ConstIterator	End () const

void	SetCenterPixel (const PixelType &p)

void	SetPixel (const OffsetType o, const PixelType &v)

void	SetPixel (const unsigned int n, const PixelType &v)

void	SetPixel (const unsigned int n, const PixelType &v, bool &status)

	ShapedNeighborhoodIterator ()=default

	ShapedNeighborhoodIterator (const ShapedNeighborhoodIterator &o)=delete

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

	~ShapedNeighborhoodIterator () override=default


Self &	operator= (const Self &orig)


Iterator	Begin ()

Iterator	End ()

Public Member Functions inherited from itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >
const IndexListType &	GetActiveIndexList () const

IndexListType::size_type	GetActiveIndexListSize () const

Self &	operator++ ()

Self &	operator+= (const OffsetType &)

Self &	operator-- ()

Self &	operator-= (const OffsetType &)

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

ConstIterator	Begin () const

ConstIterator	End () const

	ConstShapedNeighborhoodIterator ()=default

	~ConstShapedNeighborhoodIterator () override=default

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

	ConstShapedNeighborhoodIterator (const ConstShapedNeighborhoodIterator &)=delete

Self &	operator= (const Self &orig)

InternalPixelType *	GetCenterPointer ()

void	ActivateOffset (const OffsetType &off)

void	DeactivateOffset (const OffsetType &off)

template<typename TOffsets>
void	ActivateOffsets (const TOffsets &offsets)

void	ClearActiveList ()

template<typename TNeighborPixel>
void	CreateActiveListFromNeighborhood (const Neighborhood< TNeighborPixel, Self::Dimension > &)

void	CreateActiveListFromNeighborhood (const NeighborhoodType &neighborhood)

Static Public Attributes
static constexpr unsigned int	Dimension = TImage::ImageDimension

Static Public Attributes inherited from itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >
static constexpr unsigned int	Dimension = TImage::ImageDimension

Protected Attributes
friend	Superclass

Protected Attributes inherited from itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >
IndexListType	m_ActiveIndexList {}

bool	m_CenterIsActive { false }

Friends
struct	ConstIterator

Additional Inherited Members
Protected Member Functions inherited from itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >
void	ActivateIndex (NeighborIndexType)

void	DeactivateIndex (NeighborIndexType)

void	SetCenterPixel (const PixelType &p)

void	SetPixel (const OffsetType o, const PixelType &v)

void	SetPixel (const unsigned int n, const PixelType &v)

void	SetPixel (const unsigned int n, const PixelType &v, bool &status)

Member Typedef Documentation

◆ InternalPixelType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

using itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType = typename TImage::InternalPixelType

Extract image type information.

Definition at line 154 of file itkShapedNeighborhoodIterator.h.

◆ OffsetValueType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

using itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 166 of file itkShapedNeighborhoodIterator.h.

◆ PixelType

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

using itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType = typename TImage::PixelType

Definition at line 155 of file itkShapedNeighborhoodIterator.h.

◆ Self

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

using itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Self = ShapedNeighborhoodIterator

Standard class type aliases.

Definition at line 161 of file itkShapedNeighborhoodIterator.h.

◆ Superclass

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

using itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass = ConstShapedNeighborhoodIterator<TImage, TBoundaryCondition>

Definition at line 162 of file itkShapedNeighborhoodIterator.h.

Constructor & Destructor Documentation

◆ ShapedNeighborhoodIterator() [1/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ShapedNeighborhoodIterator ( )

default

Default constructor

◆ ~ShapedNeighborhoodIterator()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::~ShapedNeighborhoodIterator ( )

overridedefault

Virtual destructor

◆ ShapedNeighborhoodIterator() [2/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ShapedNeighborhoodIterator ( const ShapedNeighborhoodIterator< TImage, TBoundaryCondition > & o )

delete

Copy constructor

◆ ShapedNeighborhoodIterator() [3/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ShapedNeighborhoodIterator	(	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 222 of file itkShapedNeighborhoodIterator.h.

Member Function Documentation

◆ Begin() [1/2]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

Iterator itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Begin ( )

inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 244 of file itkShapedNeighborhoodIterator.h.

◆ Begin() [2/2]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Begin ( ) const

inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 239 of file itkConstShapedNeighborhoodIterator.h.

◆ End() [1/2]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

Iterator itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::End ( )

inline

Returns a const iterator for the neighborhood which points to the first pixel in the neighborhood.

Definition at line 249 of file itkShapedNeighborhoodIterator.h.

◆ End() [2/2]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::End ( ) const

inline

Returns a const iterator for the neighborhood which points to the last pixel in the neighborhood.

Definition at line 247 of file itkConstShapedNeighborhoodIterator.h.

◆ operator=()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

Self & itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator= ( const Self & orig )

inline

Assignment operator

Definition at line 234 of file itkShapedNeighborhoodIterator.h.

◆ SetCenterPixel()

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

( const PixelType & p )

Returns the central pixel of the neighborhood.

◆ SetPixel() [1/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

	(	const OffsetType	o,
		const PixelType &	v )

Set the pixel at offset o from the neighborhood center

◆ SetPixel() [2/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

	(	const unsigned int	n,
		const PixelType &	v )

Set the pixel at the ith location.

◆ SetPixel() [3/3]

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

(	const unsigned int	n,
	const PixelType &	v,
	bool &	status )

Special SetPixel method which quietly ignores out-of-bounds attempts. Sets status TRUE if pixel has been set, FALSE otherwise.

Friends And Related Symbol Documentation

◆ ConstIterator

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

friend struct ConstIterator

friend

Definition at line 417 of file itkConstShapedNeighborhoodIterator.h.

Member Data Documentation

◆ Dimension

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

unsigned int itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Dimension = TImage::ImageDimension

staticconstexpr

Save the image dimension.

Definition at line 158 of file itkShapedNeighborhoodIterator.h.

◆ Superclass

template<typename TImage, typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

friend itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass

protected

Definition at line 259 of file itkShapedNeighborhoodIterator.h.

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

itkShapedNeighborhoodIterator.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ InternalPixelType

◆ OffsetValueType

◆ PixelType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ShapedNeighborhoodIterator() [1/3]

◆ ~ShapedNeighborhoodIterator()

◆ ShapedNeighborhoodIterator() [2/3]

◆ ShapedNeighborhoodIterator() [3/3]

Member Function Documentation

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ End() [1/2]

◆ End() [2/2]

◆ operator=()

◆ SetCenterPixel()

◆ SetPixel() [1/3]

◆ SetPixel() [2/3]

◆ SetPixel() [3/3]

Friends And Related Symbol Documentation

◆ ConstIterator

Member Data Documentation

◆ Dimension

◆ Superclass