ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
itk::ConditionalConstIterator< TImage > Class Template Referenceabstract

#include <itkConditionalConstIterator.h>

+ Inheritance diagram for itk::ConditionalConstIterator< TImage >:

Detailed Description

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

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.

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 PixelType Get (void) const =0
 
virtual const IndexType GetIndex ()=0
 
virtual bool IsAtEnd ()=0
 
virtual bool IsPixelIncluded (const IndexType &index) const =0
 
virtual void operator++ ()=0
 
Selfoperator= (const Self &it)
 
virtual ~ConditionalConstIterator ()
 

Static Public Member Functions

static unsigned int GetIteratorDimension (void)
 

Static Public Attributes

static const unsigned int NDimension = TImage::ImageDimension
 

Protected Attributes

ImageType::ConstWeakPointer m_Image
 
bool m_IsAtEnd
 
RegionType m_Region
 

Member Typedef Documentation

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

Image typedef support.

Definition at line 60 of file itkConditionalConstIterator.h.

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

Index typedef support.

Definition at line 51 of file itkConditionalConstIterator.h.

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

Internal Pixel Type

Definition at line 63 of file itkConditionalConstIterator.h.

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

External Pixel Type

Definition at line 66 of file itkConditionalConstIterator.h.

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

Region typedef support.

Definition at line 57 of file itkConditionalConstIterator.h.

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

Standard class typedefs.

Definition at line 42 of file itkConditionalConstIterator.h.

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

Size typedef support.

Definition at line 54 of file itkConditionalConstIterator.h.

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 ( void  )
inlinestatic

Get the dimension (size) of the index.

Definition at line 82 of file itkConditionalConstIterator.h.

References itk::ConditionalConstIterator< TImage >::NDimension.

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

Definition at line 73 of file itkConditionalConstIterator.h.

References itk::ConditionalConstIterator< TImage >::m_Image, itk::ConditionalConstIterator< TImage >::m_IsAtEnd, and itk::ConditionalConstIterator< TImage >::m_Region.

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 114 of file itkConditionalConstIterator.h.

Referenced by itk::ConditionalConstIterator< TImage >::operator=().

template<class TImage >
RegionType itk::ConditionalConstIterator< TImage >::m_Region
protected
template<class TImage >
const unsigned int itk::ConditionalConstIterator< TImage >::NDimension = TImage::ImageDimension
static

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.

Definition at line 48 of file itkConditionalConstIterator.h.

Referenced by itk::ConditionalConstIterator< TImage >::GetIteratorDimension().


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