itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition > Class Template Reference
[Image Iterators]

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.

Public Types
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::PixelType	PixelType
typedef ConstShapedNeighborhoodIterator	Self
typedef NeighborhoodIterator< TImage, TBoundaryCondition >	Superclass
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef Superclass::RadiusType	RadiusType
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef std::list< unsigned int >	IndexListType
typedef TBoundaryCondition	BoundaryConditionType
typedef ImageBoundaryCondition< ImageType > *	ImageBoundaryConditionPointerType
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
	itkStaticConstMacro (Dimension, unsigned int, TImage::ImageDimension)
virtual	~ConstShapedNeighborhoodIterator ()
const IndexListType &	GetActiveIndexList () const
IndexListType::size_type	GetActiveIndexListSize () const
Self &	operator++ ()
Self &	operator-- ()
Self &	operator+= (const OffsetType &)
Self &	operator-= (const OffsetType &)
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 ()
Protected Member Functions
	ConstShapedNeighborhoodIterator (const ConstShapedNeighborhoodIterator &)
virtual void	ActivateIndex (const unsigned int)
virtual void	DeactivateIndex (const unsigned int)
Protected Attributes
bool	m_CenterIsActive
IndexListType	m_ActiveIndexList
ConstIterator	m_ConstEndIterator
ConstIterator	m_ConstBeginIterator

---

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

ImageIterator

NeighborhoodIterator

ShapedNeighborhoodIterator

Definition at line 42 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 >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 77 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 >. Definition at line 80 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 >. Definition at line 65 of file itkConstShapedNeighborhoodIterator.h. Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> typedef std::list<unsigned int> 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 >. Definition at line 74 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 >. Definition at line 67 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 from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 68 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 >. Definition at line 47 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 >. Definition at line 69 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 >. Definition at line 58 of file itkConstShapedNeighborhoodIterator.h. Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator::Get().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> typedef OffsetType::OffsetValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::OffsetValueType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 59 of file itkConstShapedNeighborhoodIterator.h.

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

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 48 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> typedef Superclass::RadiusType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::RadiusType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 60 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 >. Definition at line 66 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 >. Definition at line 54 of file itkConstShapedNeighborhoodIterator.h. Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator::ConstIterator(), and itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator::GetNeighborhoodIndex().

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> typedef Superclass::SizeType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeType

Reimplemented from itk::NeighborhoodIterator< TImage, TBoundaryCondition >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 61 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> typedef Superclass::SizeValueType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::SizeValueType

Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 62 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 >. Definition at line 55 of file itkConstShapedNeighborhoodIterator.h. Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator().

---

Constructor & Destructor Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstShapedNeighborhoodIterator (   )  [inline]

Default constructor Definition at line 173 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> virtual itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::~ConstShapedNeighborhoodIterator (   )  [inline, virtual]

Virtual destructor Definition at line 183 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 187 of file itkConstShapedNeighborhoodIterator.h. References itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageType, and itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Superclass.

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 (  const unsigned  int  )  [protected, virtual]

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ActivateOffset (  const OffsetType &  off  )  [inline, virtual]

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 251 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. Definition at line 164 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ClearActiveList (   )  [inline, virtual]

Removes all active pixels from this neighborhood. Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 258 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateIndex (  const unsigned  int  )  [protected, virtual]

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateOffset (  const OffsetType &  off  )  [inline, virtual]

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 253 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 in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >. Definition at line 169 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 indicies in the neighborhood Definition at line 268 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 indicies. Definition at line 272 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::itkStaticConstMacro (  Dimension  , unsigned  int, TImage::ImageDimension  )

Save the image dimension. Reimplemented from itk::ConstNeighborhoodIterator< TImage >. Reimplemented in itk::ShapedNeighborhoodIterator< 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 updataed. Reimplemented from itk::ConstNeighborhoodIterator< TImage >.

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> Self& itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::operator-- (   )

Reimplements the operator-- method so that only active pixel locations are updataed. Reimplemented from itk::ConstNeighborhoodIterator< TImage >.

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

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 >. Definition at line 232 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 >.

---

Member Data Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> IndexListType itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ActiveIndexList [protected]

Definition at line 317 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> bool itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_CenterIsActive [protected]

Definition at line 316 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstBeginIterator [protected]

Definition at line 319 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>> ConstIterator itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::m_ConstEndIterator [protected]

Definition at line 318 of file itkConstShapedNeighborhoodIterator.h.

---

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

• itkConstShapedNeighborhoodIterator.h

---