ITK  4.1.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends
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 IndexListTypeGetActiveIndexList () const
IndexListType::size_type GetActiveIndexListSize () const
Selfoperator++ ()
Selfoperator+= (const OffsetType &)
Selfoperator-- ()
Selfoperator-= (const OffsetType &)
virtual ~ConstShapedNeighborhoodIterator ()
const ConstIteratorBegin () const
const ConstIteratorEnd () const
 ConstShapedNeighborhoodIterator ()
 ConstShapedNeighborhoodIterator (const SizeType &radius, const ImageType *ptr, const RegionType &region)
Selfoperator= (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

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
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 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
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 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
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 SizeType::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 217 of file itkConstShapedNeighborhoodIterator.h.

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

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  ) [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< ImageType >.

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 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 ( ) [inline, virtual]

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  ) [protected, virtual]
template<class TImage, class TBoundaryCondition = ZeroFluxNeumannBoundaryCondition< TImage >>
virtual void itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::DeactivateOffset ( const OffsetType off) [inline, virtual]

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

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]
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 >>
const unsigned int itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::Dimension = TImage::ImageDimension [static]
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: