Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

#include <itkConstShapedNeighborhoodIterator.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >:

Collaboration graph
[legend]

List of all members.


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.


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 Index
< itkGetStaticConstMacro(Dimension)> 
IndexType
typedef IndexType::IndexValueType IndexValueType
typedef Neighborhood
< PixelType,
itkGetStaticConstMacro(Dimension)> 
NeighborhoodType
typedef TImage::RegionType RegionType

Public Member Functions

const IndexListTypeGetActiveIndexList () const
IndexListType::size_type GetActiveIndexListSize () const
 itkStaticConstMacro (Dimension, unsigned int, TImage::ImageDimension)
Selfoperator++ ()
Selfoperator+= (const OffsetType &)
Selfoperator-- ()
Selfoperator-= (const OffsetType &)
virtual ~ConstShapedNeighborhoodIterator ()
virtual void ActivateOffset (const OffsetType &off)
virtual void DeactivateOffset (const OffsetType &off)
Selfoperator= (const Self &orig)
virtual void PrintSelf (std::ostream &, Indent) const
const ConstIteratorBegin () const
 ConstShapedNeighborhoodIterator ()
const ConstIteratorEnd () const
virtual void ClearActiveList ()
 ConstShapedNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)

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

Friends

struct ConstIterator

Classes

struct  ConstIterator

Member Typedef Documentation

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

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
typedef ImageBoundaryCondition<ImageType>* itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ImageBoundaryConditionPointerType

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

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 >, and itk::ShapedNeighborhoodIterator< TImage >.

Definition at line 104 of file itkConstShapedNeighborhoodIterator.h.

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
typedef Index<itkGetStaticConstMacro(Dimension)> itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::IndexType

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

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

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

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

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

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

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

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

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

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

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

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


Constructor & Destructor Documentation

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

Default constructor

Definition at line 210 of file itkConstShapedNeighborhoodIterator.h.

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

Virtual destructor

Definition at line 220 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 224 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 ( const unsigned  int  )  [protected, virtual]

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

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 289 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 *,::itk::GetImageDimension< TImage >::ImageDimension >.

Definition at line 201 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 >, and itk::ShapedNeighborhoodIterator< TImage >.

Definition at line 296 of file itkConstShapedNeighborhoodIterator.h.

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

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

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 291 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 *,::itk::GetImageDimension< TImage >::ImageDimension >.

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

Definition at line 206 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 306 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 310 of file itkConstShapedNeighborhoodIterator.h.

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

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]

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::PrintSelf ( std::ostream &  ,
Indent   
) const [virtual]


Friends And Related Function Documentation

template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition<TImage>>
friend struct ConstIterator [friend]


Member Data Documentation

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

Definition at line 357 of file itkConstShapedNeighborhoodIterator.h.

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

Definition at line 356 of file itkConstShapedNeighborhoodIterator.h.

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

Definition at line 359 of file itkConstShapedNeighborhoodIterator.h.

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

Definition at line 358 of file itkConstShapedNeighborhoodIterator.h.


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

Generated at Sat Feb 28 14:53:50 2009 for ITK by doxygen 1.5.6 written by Dimitri van Heesch, © 1997-2000