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

itk::ConditionalConstIterator< TImage > Class Template Reference
[Image Iterators]

ConditionalConstIterator is a base class for other iterators where membership in the set of output pixels is "conditional" upon some property, calculation, etc. For example, a threshold iterator might walk a region and return only those pixels which meet a minimum intensity condition. More...

#include <itkConditionalConstIterator.h>

Inheritance diagram for itk::ConditionalConstIterator< TImage >:

Inheritance graph
[legend]

List of all members.

Public Types

typedef TImage ImageType
typedef TImage::IndexType IndexType
typedef TImage::InternalPixelType InternalPixelType
typedef TImage::PixelType PixelType
typedef TImage::RegionType RegionType
typedef ConditionalConstIterator Self
typedef TImage::SizeType SizeType

Public Member Functions

 ConditionalConstIterator ()
virtual const PixelTypeGet (void) const =0
virtual const IndexType GetIndex ()=0
virtual bool IsAtEnd ()=0
virtual bool IsPixelIncluded (const IndexType &index) const =0
 itkStaticConstMacro (NDimension, unsigned int, TImage::ImageDimension)
virtual void operator++ ()=0
Selfoperator= (const Self &it)
virtual ~ConditionalConstIterator ()

Static Public Member Functions

static unsigned int GetIteratorDimension ()

Protected Attributes

ImageType::ConstWeakPointer m_Image
bool m_IsAtEnd
RegionType m_Region


Detailed Description

template<class TImage>
class itk::ConditionalConstIterator< TImage >

ConditionalConstIterator is a base class for other iterators where membership in the set of output pixels is "conditional" upon some property, calculation, etc. For example, a threshold iterator might walk a region and return only those pixels which meet a minimum intensity condition.

This class is the const version of the ConditionalIterator for this reason it doesn't support the Set() method.

Definition at line 38 of file itkConditionalConstIterator.h.


Member Typedef Documentation

template<class TImage>
typedef TImage itk::ConditionalConstIterator< TImage >::ImageType

template<class TImage>
typedef TImage::IndexType itk::ConditionalConstIterator< TImage >::IndexType

template<class TImage>
typedef TImage::InternalPixelType itk::ConditionalConstIterator< TImage >::InternalPixelType

template<class TImage>
typedef TImage::PixelType itk::ConditionalConstIterator< TImage >::PixelType

template<class TImage>
typedef TImage::RegionType itk::ConditionalConstIterator< TImage >::RegionType

template<class TImage>
typedef ConditionalConstIterator itk::ConditionalConstIterator< TImage >::Self

template<class TImage>
typedef TImage::SizeType itk::ConditionalConstIterator< TImage >::SizeType


Constructor & Destructor Documentation

template<class TImage>
itk::ConditionalConstIterator< TImage >::ConditionalConstIterator (  ) 

Constructor

template<class TImage>
virtual itk::ConditionalConstIterator< TImage >::~ConditionalConstIterator (  )  [virtual]

Destructor


Member Function Documentation

template<class TImage>
virtual const PixelType& itk::ConditionalConstIterator< TImage >::Get ( void   )  const [pure virtual]

template<class TImage>
virtual const IndexType itk::ConditionalConstIterator< TImage >::GetIndex (  )  [pure virtual]

template<class TImage>
static unsigned int itk::ConditionalConstIterator< TImage >::GetIteratorDimension (  )  [inline, static]

template<class TImage>
virtual bool itk::ConditionalConstIterator< TImage >::IsAtEnd (  )  [pure virtual]

template<class TImage>
virtual bool itk::ConditionalConstIterator< TImage >::IsPixelIncluded ( const IndexType index  )  const [pure virtual]

template<class TImage>
itk::ConditionalConstIterator< TImage >::itkStaticConstMacro ( NDimension  ,
unsigned  int,
TImage::ImageDimension   
)

Dimension of the image the iterator walks. This constant is needed so that functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

template<class TImage>
virtual void itk::ConditionalConstIterator< TImage >::operator++ (  )  [pure virtual]

template<class TImage>
Self& itk::ConditionalConstIterator< TImage >::operator= ( const Self it  )  [inline]

operator= is provided to make sure the handle to the image is properly reference counted.

Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Definition at line 72 of file itkConditionalConstIterator.h.


Member Data Documentation

template<class TImage>
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image [protected]

template<class TImage>
bool itk::ConditionalConstIterator< TImage >::m_IsAtEnd [protected]

Is the iterator at the end of its walk?

Definition at line 110 of file itkConditionalConstIterator.h.

template<class TImage>
RegionType itk::ConditionalConstIterator< TImage >::m_Region [protected]


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

Generated at Tue Sep 15 07:18:19 2009 for ITK by doxygen 1.5.8 written by Dimitri van Heesch, © 1997-2000