itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference

#include <itkConstShapedNeighborhoodIterator.h>

Detailed Description

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

Const version of ShapedNeighborhoodIterator, defining iteration of a local N-dimensional neighborhood of pixels across an itk::Image.

ConstShapedNeighborhoodIterator implements the read-only methods of ShapedNeighborhoodIterator. A "shaped" neighborhood iterator is one that allows you to specify which neighbor elements are active and which are inactive. See ShapedNeighborhoodIterator for more information.

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

Definition at line 72 of file itkConstShapedNeighborhoodIterator.h.

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

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

Classes
struct	ConstIterator

Public Types
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
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

Protected Member Functions
void	ActivateIndex (NeighborIndexType)
void	DeactivateIndex (NeighborIndexType)
void	SetCenterPixel (const PixelType &p)
void	SetPixel (const OffsetType o, const PixelType &v)
void	SetPixel (const unsigned int i, const PixelType &v)
void	SetPixel (const unsigned int i, const PixelType &v, bool &status)

Protected Attributes
IndexListType	m_ActiveIndexList {}
bool	m_CenterIsActive { false }

Friends
struct	ConstIterator

Additional Inherited Members
Private Types inherited from itk::NeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
using	Self = NeighborhoodIterator
using	Superclass = ConstNeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
Private Types inherited from itk::ConstNeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
using	BoundaryConditionType = ZeroFluxNeumannBoundaryCondition< TImage >
using	ConstIterator = typename AllocatorType::const_iterator
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 AllocatorType::iterator
using	NeighborhoodAccessorFunctorType = typename ImageType::NeighborhoodAccessorFunctorType
using	NeighborhoodType = Neighborhood< PixelType, Self::Dimension >
using	NeighborIndexType = typename NeighborhoodType::NeighborIndexType
using	OffsetType = Offset< VDimension >
using	OutputImageType = typename BoundaryConditionType::OutputImageType
using	PixelType = typename TImage::PixelType
using	RadiusType = itk::Size< VDimension >
using	RegionType = typename TImage::RegionType
using	Self = ConstNeighborhoodIterator
using	SizeType = itk::Size< VDimension >
using	Superclass = Neighborhood< InternalPixelType *, Self::Dimension >
Private 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 >
Private Member Functions inherited from itk::NeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
InternalPixelType *	GetCenterPointer ()
	NeighborhoodIterator ()
	NeighborhoodIterator (const NeighborhoodIterator &n)
	NeighborhoodIterator (const SizeType &radius, ImageType *ptr, const RegionType &region)
void	SetCenterPixel (const PixelType &p)
void	SetNeighborhood (const NeighborhoodType &)
void	SetNext (const unsigned int axis, const PixelType &v)
void	SetNext (const unsigned int axis, const unsigned int i, const PixelType &v)
void	SetPixel (const unsigned int i, const PixelType &v)
void	SetPixel (const unsigned int i, const PixelType &v, bool &status)
void	SetPrevious (const unsigned int axis, const unsigned int i, const PixelType &v)
Self &	operator= (const Self &orig)
void	SetPixel (const OffsetType o, const PixelType &v)
void	SetPrevious (const unsigned int axis, const PixelType &v)
Private Member Functions inherited from itk::ConstNeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
OffsetType	ComputeInternalIndex (const NeighborIndexType n) const
	ConstNeighborhoodIterator ()=default
	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
IndexType	GetIndex () const
IndexType	GetIndex (const OffsetType &o) const
IndexType	GetIndex (NeighborIndexType i) const
bool	GetNeedToUseBoundaryCondition () const
NeighborhoodType	GetNeighborhood () const
PixelType	GetNext (const unsigned int axis) const
PixelType	GetNext (const unsigned int axis, NeighborIndexType i) const
PixelType	GetPixel (const NeighborIndexType i) const
PixelType	GetPixel (const OffsetType &o) const
PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const
PixelType	GetPixel (NeighborIndexType i, bool &IsInBounds) const
PixelType	GetPrevious (const unsigned int axis) const
PixelType	GetPrevious (const unsigned int axis, NeighborIndexType i) const
RegionType	GetRegion () const
OffsetType	GetWrapOffset () const
OffsetValueType	GetWrapOffset (NeighborIndexType n) const
void	GoToBegin ()
void	GoToEnd ()
bool	InBounds () const
bool	IndexInBounds (const NeighborIndexType n) 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
	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
Self &	operator= (const Self &orig)
bool	operator== (const Self &it) const
bool	operator> (const Self &it) const
bool	operator>= (const Self &it) const
void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
void	PrintSelf (std::ostream &, Indent) const override
void	ResetBoundaryCondition ()
void	SetBoundaryCondition (const ZeroFluxNeumannBoundaryCondition< TImage > &c)
void	SetNeedToUseBoundaryCondition (bool b)
void	SetRegion (const RegionType &region)
	~ConstNeighborhoodIterator () override=default
	ConstNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
bool	IsAtEnd () const
void	SetLocation (const IndexType &position)
void	SetBeginIndex (const IndexType &start)
void	SetBound (const SizeType &)
void	SetEndIndex ()
void	SetLoop (const IndexType &p)
void	SetPixelPointers (const IndexType &)
Private Member Functions inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
NeighborIndexType	GetCenterNeighborhoodIndex () const
TImage::InternalPixelType *	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
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
virtual void	Allocate (NeighborIndexType i)
virtual void	ComputeNeighborhoodOffsetTable ()
virtual void	ComputeNeighborhoodStrideTable ()
virtual void	PrintSelf (std::ostream &, Indent) const
void	SetSize ()
Private Attributes inherited from itk::ConstNeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
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
ZeroFluxNeumannBoundaryCondition< TImage >	m_InternalBoundaryCondition
bool	m_IsInBounds
bool	m_IsInBoundsValid
IndexType	m_Loop
bool	m_NeedToUseBoundaryCondition
NeighborhoodAccessorFunctorType	m_NeighborhoodAccessorFunctor
RegionType	m_Region
OffsetType	m_WrapOffset
Static Private Attributes inherited from itk::ConstNeighborhoodIterator< TImage, ZeroFluxNeumannBoundaryCondition< TImage > >
static constexpr DimensionValueType	Dimension
Static Private Attributes inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
static constexpr unsigned int	NeighborhoodDimension

Member Typedef Documentation

BoundaryConditionType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType = TBoundaryCondition

Typedef for boundary condition type.

Definition at line 110 of file itkConstShapedNeighborhoodIterator.h.

ImageBoundaryConditionPointerType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType = ImageBoundaryCondition<ImageType> *

Typedef for generic boundary condition pointer

Definition at line 113 of file itkConstShapedNeighborhoodIterator.h.

ImageType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType = TImage

Typedef support for common objects

Definition at line 94 of file itkConstShapedNeighborhoodIterator.h.

IndexListConstIterator

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListConstIterator = typename IndexListType::const_iterator

Definition at line 107 of file itkConstShapedNeighborhoodIterator.h.

IndexListIterator

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListIterator = typename IndexListType::iterator

Definition at line 106 of file itkConstShapedNeighborhoodIterator.h.

IndexListType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListType = std::list<NeighborIndexType>

An stl storage container type that can be sorted. The type used for the list of active offsets in the neighborhood.

Definition at line 104 of file itkConstShapedNeighborhoodIterator.h.

IndexType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType = Index<Self::Dimension>

Definition at line 96 of file itkConstShapedNeighborhoodIterator.h.

IndexValueType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexValueType = typename IndexType::IndexValueType

Definition at line 97 of file itkConstShapedNeighborhoodIterator.h.

InternalPixelType

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

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

Extract image type information.

Definition at line 76 of file itkConstShapedNeighborhoodIterator.h.

NeighborhoodType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType = Neighborhood<PixelType, Self::Dimension>

Definition at line 98 of file itkConstShapedNeighborhoodIterator.h.

NeighborIndexType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborIndexType = typename NeighborhoodType::NeighborIndexType

Definition at line 100 of file itkConstShapedNeighborhoodIterator.h.

OffsetValueType

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

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

Definition at line 88 of file itkConstShapedNeighborhoodIterator.h.

PixelType

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

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

Definition at line 77 of file itkConstShapedNeighborhoodIterator.h.

RegionType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType = typename TImage::RegionType

Definition at line 95 of file itkConstShapedNeighborhoodIterator.h.

Self

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

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

Standard class type aliases.

Definition at line 83 of file itkConstShapedNeighborhoodIterator.h.

SizeValueType

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

using itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType = typename SizeType::SizeValueType

Definition at line 91 of file itkConstShapedNeighborhoodIterator.h.

Superclass

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

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

Definition at line 84 of file itkConstShapedNeighborhoodIterator.h.

Constructor & Destructor Documentation

ConstShapedNeighborhoodIterator() [1/3]

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

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

default

Default constructor

~ConstShapedNeighborhoodIterator()

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

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

overridedefault

Virtual destructor

ConstShapedNeighborhoodIterator() [2/3]

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

itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( 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 262 of file itkConstShapedNeighborhoodIterator.h.

ConstShapedNeighborhoodIterator() [3/3]

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

itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator ( const ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > &  )

delete

Copy constructor

Member Function Documentation

ActivateIndex()

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

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateIndex ( NeighborIndexType  )

protected

Class is protected here so that it is not publicly accessible, but can be accessed by subclasses.. Add/Remove a neighborhood index to/from the active. Locations in the active list are the only accessible elements in the neighborhood. The argument is an index location calculated as an offset into a linear array which represents the image region defined by the radius of this iterator, with the smallest dimension as the fastest increasing index.

ActivateOffset()

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

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffset ( const OffsetType &  off )

inline

Add/Remove a neighborhood offset (from the center of the neighborhood) to/from the active list. Active list offsets are the only locations updated and accessible through the iterator.

Definition at line 332 of file itkConstShapedNeighborhoodIterator.h.

ActivateOffsets()

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

template<typename TOffsets >

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffsets ( const TOffsets &  offsets )

inline

Activates a whole range of offsets, for example, an std::vector<OffsetType>, which could be from GenerateImageNeighborhoodOffsets(shape).

Definition at line 347 of file itkConstShapedNeighborhoodIterator.h.

Begin()

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 241 of file itkConstShapedNeighborhoodIterator.h.

ClearActiveList()

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

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ClearActiveList ( )

inline

Removes all active pixels from this neighborhood.

Definition at line 358 of file itkConstShapedNeighborhoodIterator.h.

CreateActiveListFromNeighborhood() [1/2]

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

template<typename TNeighborPixel >

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::CreateActiveListFromNeighborhood

(

const Neighborhood< TNeighborPixel, Self::Dimension > &

)

Add non-zero neighborhood offsets to the active list. The radius of the neighborhood must match the radius of the shaped iterator

CreateActiveListFromNeighborhood() [2/2]

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

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::CreateActiveListFromNeighborhood ( const NeighborhoodType &  neighborhood )

inline

Add non-zero neighborhood offsets to the active list. The radius of the neighborhood must match the radius of the shaped iterator

Definition at line 386 of file itkConstShapedNeighborhoodIterator.h.

DeactivateIndex()

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

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateIndex ( NeighborIndexType  )

protected

DeactivateOffset()

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

void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateOffset ( const OffsetType &  off )

inline

Add/Remove a neighborhood offset (from the center of the neighborhood) to/from the active list. Active list offsets are the only locations updated and accessible through the iterator.

Definition at line 337 of file itkConstShapedNeighborhoodIterator.h.

End()

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 249 of file itkConstShapedNeighborhoodIterator.h.

GetActiveIndexList()

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

const IndexListType & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexList ( ) const

inline

Returns the list of active indices in the neighborhood

Definition at line 367 of file itkConstShapedNeighborhoodIterator.h.

GetActiveIndexListSize()

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

IndexListType::size_type itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::GetActiveIndexListSize ( ) const

inline

Returns the size of the list of active neighborhood indices.

Definition at line 374 of file itkConstShapedNeighborhoodIterator.h.

GetCenterPointer()

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

InternalPixelType * itk::NeighborhoodIterator< TImage, TBoundaryCondition >::GetCenterPointer ( )

inline

Returns the central memory pointer of the neighborhood.

Definition at line 260 of file itkNeighborhoodIterator.h.

operator++()

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

Self & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator++

(

)

Reimplements the operator++ method so that only active pixel locations are updated.

operator+=()

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

Self & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::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 , typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

Self & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator--

(

)

Reimplements the operator-- method so that only active pixel locations are updated.

operator-=()

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

Self & itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::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 , typename TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>

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

inline

Assignment operator

Definition at line 312 of file itkConstShapedNeighborhoodIterator.h.

References itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ActiveIndexList, and itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive.

PrintSelf()

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

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

overridevirtual

Standard itk print method

Reimplemented from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >.

SetCenterPixel()

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

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetCenterPixel ( const PixelType &  p )

inlineprotected

Returns the central pixel of the neighborhood.

Definition at line 267 of file itkNeighborhoodIterator.h.

SetPixel() [1/3]

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

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel ( const OffsetType  o, const PixelType &  v  )

inlineprotected

Set the pixel at offset o from the neighborhood center

Definition at line 291 of file itkNeighborhoodIterator.h.

SetPixel() [2/3]

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

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel ( const unsigned int  i, const PixelType &  v  )

protected

Set the pixel at the ith location.

SetPixel() [3/3]

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

void itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetPixel ( const unsigned int  i, const PixelType &  v, bool &  status  )

protected

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

Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator::ProtectedSet().

Friends And Related Function Documentation

ConstIterator

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

friend struct ConstIterator

friend

Definition at line 419 of file itkConstShapedNeighborhoodIterator.h.

Member Data Documentation

Dimension

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

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

staticconstexpr

Save the image dimension.

Definition at line 80 of file itkConstShapedNeighborhoodIterator.h.

m_ActiveIndexList

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

IndexListType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ActiveIndexList {}

protected

Definition at line 437 of file itkConstShapedNeighborhoodIterator.h.

Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

m_CenterIsActive

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

bool itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive { false }

protected

Definition at line 436 of file itkConstShapedNeighborhoodIterator.h.

Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator=().

---

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

• itkConstShapedNeighborhoodIterator.h