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

#include <itkConstShapedNeighborhoodIterator.h>

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

[legend]

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

[legend]

List of all members.

Classes
struct	ConstIterator
Public Types
typedef TBoundaryCondition	BoundaryConditionType
typedef ImageBoundaryCondition < ImageType > *	ImageBoundaryConditionPointerType
typedef std::list< unsigned int >	IndexListType
typedef TImage::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelType	PixelType
typedef Superclass::RadiusType	RadiusType
typedef ConstShapedNeighborhoodIterator	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef NeighborhoodIterator < TImage, TBoundaryCondition >	Superclass


typedef TImage	ImageType
typedef TImage::RegionType	RegionType
typedef Index < itkGetStaticConstMacro(Dimension)>	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef Neighborhood < PixelType, itkGetStaticConstMacro(Dimension)>	NeighborhoodType
Public Member Functions
const IndexListType &	GetActiveIndexList () const
IndexListType::size_type	GetActiveIndexListSize () const
Self &	operator++ ()
Self &	operator+= (const OffsetType &)
Self &	operator-- ()
Self &	operator-= (const OffsetType &)
virtual	~ConstShapedNeighborhoodIterator ()


const ConstIterator &	Begin () const
const ConstIterator &	End () const
	ConstShapedNeighborhoodIterator ()


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


Self &	operator= (const Self &orig)
virtual void	PrintSelf (std::ostream &, Indent) const
virtual void	ActivateOffset (const OffsetType &off)
virtual void	DeactivateOffset (const OffsetType &off)


virtual void	ClearActiveList ()
Static Public Attributes
static const unsigned int	Dimension = TImage::ImageDimension
Protected Member Functions
	ConstShapedNeighborhoodIterator (const ConstShapedNeighborhoodIterator &)


virtual void	ActivateIndex (const unsigned int)
virtual void	DeactivateIndex (const unsigned int)
Protected Attributes
IndexListType	m_ActiveIndexList
bool	m_CenterIsActive
ConstIterator	m_ConstBeginIterator
ConstIterator	m_ConstEndIterator
Private Types
typedef NeighborhoodAllocator < TImage::InternalPixelType * >	AllocatorType
typedef ImageBoundaryCondition < ImageType > const *	ImageBoundaryConditionConstPointerType
typedef Superclass::Iterator	Iterator
typedef ImageType::NeighborhoodAccessorFunctorType	NeighborhoodAccessorFunctorType
typedef SliceIterator < TImage::InternalPixelType *, Self >	SliceIteratorType
Private Member Functions
virtual void	Allocate (unsigned int i)
OffsetType	ComputeInternalIndex (unsigned int n) const
virtual void	ComputeNeighborhoodOffsetTable ()
virtual void	ComputeNeighborhoodStrideTable ()
IndexType	GetBeginIndex () const
IndexType	GetBound () const
long	GetBound (unsigned int n) const
const BoundaryConditionType *	GetBoundaryCondition () const
RegionType	GetBoundingBoxAsImageRegion () const
unsigned int	GetCenterNeighborhoodIndex () const
PixelType	GetCenterPixel () const
InternalPixelType *	GetCenterPointer ()
const InternalPixelType *	GetCenterPointer () const
TImage::InternalPixelType *	GetCenterValue () const
const ImageType *	GetImagePointer (void) const
virtual IndexType	GetIndex (const OffsetType &o) const
virtual IndexType	GetIndex (const unsigned i) const
virtual IndexType	GetIndex (void) const
virtual NeighborhoodType	GetNeighborhood () const
virtual unsigned int	GetNeighborhoodIndex (const OffsetType &) const
virtual PixelType	GetNext (const unsigned axis, const unsigned i) const
virtual PixelType	GetNext (const unsigned axis) const
OffsetType	GetOffset (unsigned int i) const
virtual PixelType	GetPixel (const unsigned i, bool &IsInBounds) const
virtual PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const
virtual PixelType	GetPrevious (const unsigned axis, const unsigned i) const
virtual PixelType	GetPrevious (const unsigned axis) const
const SizeType	GetRadius () const
unsigned long	GetRadius (const unsigned long n) const
RegionType	GetRegion () const
unsigned long	GetSize (const unsigned long n) const
SizeType	GetSize () const
std::slice	GetSlice (unsigned int) const
unsigned	GetStride (const unsigned axis) const
OffsetValueType	GetWrapOffset (unsigned int n) const
OffsetType	GetWrapOffset () const
virtual void	GoToBegin ()
virtual void	GoToEnd ()
bool	InBounds () const
virtual void	Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual bool	IsAtBegin () const
bool	operator!= (const Self &it) const
bool	operator!= (const Self &other) const
OffsetType	operator- (const Self &b)
bool	operator< (const Self &it) const
bool	operator<= (const Self &it) const
bool	operator== (const Self &it) const
bool	operator== (const Self &other) const
bool	operator> (const Self &it) const
bool	operator>= (const Self &it) const
virtual void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
void	Print (std::ostream &os) const
virtual void	ResetBoundaryCondition ()
virtual void	SetBeginIndex (const IndexType &start)
virtual void	SetBound (const SizeType &)
void	SetBoundaryCondition (const TBoundaryCondition &c)
virtual void	SetCenterPixel (const PixelType &p)
virtual void	SetEndIndex ()
virtual void	SetLoop (const IndexType &p)
virtual void	SetNeighborhood (const NeighborhoodType &)
virtual void	SetNext (const unsigned axis, const unsigned i, const PixelType &v)
virtual void	SetNext (const unsigned axis, const PixelType &v)
virtual void	SetPixel (const unsigned i, const PixelType &v, bool &status)
virtual void	SetPixelPointers (const IndexType &)
virtual void	SetPrevious (const unsigned axis, const unsigned i, const PixelType &v)
virtual void	SetPrevious (const unsigned axis, const PixelType &v)
void	SetRadius (const unsigned long)
void	SetRadius (const SizeType &)
unsigned int	Size () const


virtual void	SetPixel (const unsigned i, const PixelType &v)


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


virtual PixelType	GetPixel (const unsigned i) const


virtual PixelType	GetPixel (const OffsetType &o) const


virtual bool	IsAtEnd () const


void	SetLocation (const IndexType &position)


void	NeedToUseBoundaryConditionOn ()
void	NeedToUseBoundaryConditionOff ()
void	SetNeedToUseBoundaryCondition (bool b)
bool	GetNeedToUseBoundaryCondition () const


Iterator	End ()
Iterator	Begin ()


TImage::InternalPixelType *&	operator[] (unsigned int i)
const TImage::InternalPixelType *&	operator[] (unsigned int i) const
TImage::InternalPixelType *&	GetElement (unsigned int i)


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


void	SetRadius (const unsigned long *rad)


AllocatorType &	GetBufferReference ()
const AllocatorType &	GetBufferReference () const


void	SetSize ()
Private 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
Static Private Attributes
static const unsigned int	NeighborhoodDimension
Friends
struct	ConstIterator

Detailed Description

template<class TImage, class 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 http://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

Examples:: Testing/Code/Common/itkVectorImageTest.cxx.

Definition at line 70 of file itkConstShapedNeighborhoodIterator.h.