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

#include <itkConstShapedNeighborhoodIterator.h>

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

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

List of all members.

Classes
struct	ConstIterator

Public Types
typedef TBoundaryCondition	BoundaryConditionType
typedef ImageBoundaryCondition < ImageType > *	ImageBoundaryConditionPointerType
typedef IndexListType::const_iterator	IndexListConstIterator
typedef IndexListType::iterator	IndexListIterator
typedef std::list < NeighborIndexType >	IndexListType
typedef TImage::InternalPixelType	InternalPixelType
typedef NeighborhoodType::NeighborIndexType	NeighborIndexType
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelType	PixelType
typedef Superclass::RadiusType	RadiusType
typedef ConstShapedNeighborhoodIterator	Self
typedef Superclass::SizeType	SizeType
typedef SizeType::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
void	CreateActiveListFromNeighborhood (const NeighborhoodType &)
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
virtual void	ActivateIndex (NeighborIndexType)
	ConstShapedNeighborhoodIterator (const ConstShapedNeighborhoodIterator &)
virtual void	DeactivateIndex (NeighborIndexType)

Protected Attributes
IndexListType	m_ActiveIndexList
bool	m_CenterIsActive
ConstIterator	m_ConstBeginIterator
ConstIterator	m_ConstEndIterator

Friends
struct	ConstIterator

Additional Inherited Members
Private Types inherited from itk::NeighborhoodIterator< TImage, TBoundaryCondition >
typedef Superclass::Iterator	Iterator
Private Types inherited from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >
typedef unsigned int	DimensionValueType
typedef ImageBoundaryCondition < ImageType > const *	ImageBoundaryConditionConstPointerType
typedef ImageType::NeighborhoodAccessorFunctorType	NeighborhoodAccessorFunctorType
Private Types inherited from itk::Neighborhood< TImage::InternalPixelType *, TImage::ImageDimension >
typedef NeighborhoodAllocator < TImage::InternalPixelType * >	AllocatorType
typedef SliceIterator < TImage::InternalPixelType *, Self >	SliceIteratorType
Private Member Functions inherited from itk::NeighborhoodIterator< TImage, TBoundaryCondition >
InternalPixelType *	GetCenterPointer ()
	NeighborhoodIterator ()
	NeighborhoodIterator (const NeighborhoodIterator &n)
	NeighborhoodIterator (const SizeType &radius, ImageType *ptr, const RegionType &region)
virtual void	SetCenterPixel (const PixelType &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	SetPixel (const unsigned i, const PixelType &v)
virtual void	SetPrevious (const unsigned axis, const unsigned i, const PixelType &v)
virtual void	SetPixel (const OffsetType o, const PixelType &v)
virtual void	SetPrevious (const unsigned axis, const PixelType &v)
Private Member Functions inherited from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >
OffsetType	ComputeInternalIndex (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
const ImageType *	GetImagePointer (void) const
virtual IndexType	GetIndex (void) const
virtual IndexType	GetIndex (const OffsetType &o) const
virtual IndexType	GetIndex (NeighborIndexType i) const
bool	GetNeedToUseBoundaryCondition () const
virtual NeighborhoodType	GetNeighborhood () const
virtual PixelType	GetNext (const unsigned axis, NeighborIndexType i) const
virtual PixelType	GetNext (const unsigned axis) const
virtual PixelType	GetPixel (NeighborIndexType i, bool &IsInBounds) const
virtual PixelType	GetPixel (const OffsetType &o) const
virtual PixelType	GetPixel (const OffsetType &o, bool &IsInBounds) const
virtual PixelType	GetPrevious (const unsigned axis, NeighborIndexType i) const
virtual PixelType	GetPrevious (const unsigned axis) const
RegionType	GetRegion () const
OffsetType	GetWrapOffset () const
OffsetValueType	GetWrapOffset (NeighborIndexType n) const
virtual void	GoToBegin ()
virtual void	GoToEnd ()
bool	InBounds () const
bool	IndexInBounds (NeighborIndexType n, OffsetType &internalIndex, OffsetType &offset) const
virtual void	Initialize (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual bool	IsAtBegin () const
void	NeedToUseBoundaryConditionOff ()
void	NeedToUseBoundaryConditionOn ()
bool	operator!= (const Self &it) 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 &it) const
bool	operator>= (const Self &it) const
virtual void	OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
virtual void	ResetBoundaryCondition ()
void	SetBoundaryCondition (const TBoundaryCondition &c)
void	SetNeedToUseBoundaryCondition (bool b)
virtual	~ConstNeighborhoodIterator ()
	ConstNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
virtual PixelType	GetPixel (NeighborIndexType i) const
virtual bool	IsAtEnd () const
void	SetLocation (const IndexType &position)
Private 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
	Neighborhood (const Self &other)
bool	operator!= (const Self &other) const
Self &	operator= (const Self &other)
bool	operator== (const Self &other) const
void	Print (std::ostream &os) const
void	SetRadius (const SizeType &)
void	SetRadius (const SizeValueType *rad)
void	SetRadius (const SizeValueType)
NeighborIndexType	Size () const
virtual	~Neighborhood ()
	Neighborhood ()
Iterator	End ()
Iterator	Begin ()
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
AllocatorType &	GetBufferReference ()
const AllocatorType &	GetBufferReference () const

---

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:

itkVectorImageTest.cxx.

Definition at line 72 of file itkConstShapedNeighborhoodIterator.h.

---

Member Typedef Documentation

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

typedef TBoundaryCondition itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::BoundaryConditionType

Typedef for boundary condition type.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 114 of file itkConstShapedNeighborhoodIterator.h.

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

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

Typedef for generic boundary condition pointer

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 117 of file itkConstShapedNeighborhoodIterator.h.

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

typedef TImage itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType

Typedef support for common objects

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 96 of file itkConstShapedNeighborhoodIterator.h.

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

typedef IndexListType::const_iterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListConstIterator

Definition at line 111 of file itkConstShapedNeighborhoodIterator.h.

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

typedef IndexListType::iterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexListIterator

Definition at line 110 of file itkConstShapedNeighborhoodIterator.h.

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

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

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

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 108 of file itkConstShapedNeighborhoodIterator.h.

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

typedef Index< itkGetStaticConstMacro(Dimension) > itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType

Typedef support for common objects

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 98 of file itkConstShapedNeighborhoodIterator.h.

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

typedef IndexType::IndexValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexValueType

Typedef support for common objects

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 99 of file itkConstShapedNeighborhoodIterator.h.

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

typedef TImage::InternalPixelType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::InternalPixelType

Extract image type information.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 78 of file itkConstShapedNeighborhoodIterator.h.

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

typedef Neighborhood< PixelType, itkGetStaticConstMacro(Dimension) > itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborhoodType

Typedef support for common objects

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 101 of file itkConstShapedNeighborhoodIterator.h.

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

typedef NeighborhoodType::NeighborIndexType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::NeighborIndexType

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

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 104 of file itkConstShapedNeighborhoodIterator.h.

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

typedef Superclass::OffsetType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetType

Inherit typedefs from superclass

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 89 of file itkConstShapedNeighborhoodIterator.h.

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

typedef OffsetType::OffsetValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 90 of file itkConstShapedNeighborhoodIterator.h.

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

typedef TImage::PixelType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PixelType

External support for pixel type.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 79 of file itkConstShapedNeighborhoodIterator.h.

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

typedef Superclass::RadiusType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType

Radius typedef support.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 91 of file itkConstShapedNeighborhoodIterator.h.

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

typedef TImage::RegionType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RegionType

Typedef support for common objects

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 97 of file itkConstShapedNeighborhoodIterator.h.

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

typedef ConstShapedNeighborhoodIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Self

Standard class typedefs.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 85 of file itkConstShapedNeighborhoodIterator.h.

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

typedef Superclass::SizeType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType

Size and value typedef support.

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 92 of file itkConstShapedNeighborhoodIterator.h.

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

typedef SizeType::SizeValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType

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

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 93 of file itkConstShapedNeighborhoodIterator.h.

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

typedef NeighborhoodIterator< TImage, TBoundaryCondition > itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 86 of file itkConstShapedNeighborhoodIterator.h.

---

Constructor & Destructor Documentation

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

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

inline

Default constructor

Definition at line 217 of file itkConstShapedNeighborhoodIterator.h.

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

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

inlinevirtual

Virtual destructor

Definition at line 227 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class 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 231 of file itkConstShapedNeighborhoodIterator.h.

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

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

protected

Copy constructor

---

Member Function Documentation

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

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

protectedvirtual

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.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

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

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

inlinevirtual

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

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

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

inline

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

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

Definition at line 208 of file itkConstShapedNeighborhoodIterator.h.

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

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

inlinevirtual

Removes all active pixels from this neighborhood.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 307 of file itkConstShapedNeighborhoodIterator.h.

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

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

(

const NeighborhoodType &

)

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

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

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

protectedvirtual

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

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

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

inlinevirtual

Assignment operator

Definition at line 302 of file itkConstShapedNeighborhoodIterator.h.

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

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

inline

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

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

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 213 of file itkConstShapedNeighborhoodIterator.h.

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

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

inline

Returns the list of active indices in the neighborhood

Definition at line 317 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class 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 321 of file itkConstShapedNeighborhoodIterator.h.

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

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

(

)

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

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

template<class TImage, class 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.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

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

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

(

)

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

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

template<class TImage, class 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.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

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

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

inline

Assignment operator

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 281 of file itkConstShapedNeighborhoodIterator.h.

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

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

virtual

Standard itk print method

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

---

Friends And Related Function Documentation

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

friend struct ConstIterator

friend

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 354 of file itkConstShapedNeighborhoodIterator.h.

---

Member Data Documentation

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

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

static

Save the image dimension.

Reimplemented from itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 82 of file itkConstShapedNeighborhoodIterator.h.

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

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

protected

Definition at line 371 of file itkConstShapedNeighborhoodIterator.h.

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

bool itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive

protected

Definition at line 370 of file itkConstShapedNeighborhoodIterator.h.

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

ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstBeginIterator

protected

Definition at line 373 of file itkConstShapedNeighborhoodIterator.h.

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

ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstEndIterator

protected

Definition at line 372 of file itkConstShapedNeighborhoodIterator.h.

---

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

• itkConstShapedNeighborhoodIterator.h