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>
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 |
| Self & | operator= (const Self &it) |
| virtual | ~ConditionalConstIterator () |
Static Public Member Functions | |
| static unsigned int | GetIteratorDimension () |
Static Public Attributes | |
| static const unsigned int | NDimension = TImage::ImageDimension |
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
| typedef TImage itk::ConditionalConstIterator< TImage >::ImageType |
Image typedef support.
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 59 of file itkConditionalConstIterator.h.
| typedef TImage::IndexType itk::ConditionalConstIterator< TImage >::IndexType |
Index typedef support.
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 50 of file itkConditionalConstIterator.h.
| typedef TImage::InternalPixelType itk::ConditionalConstIterator< TImage >::InternalPixelType |
Internal Pixel Type
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 62 of file itkConditionalConstIterator.h.
| typedef TImage::PixelType itk::ConditionalConstIterator< TImage >::PixelType |
External Pixel Type
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 65 of file itkConditionalConstIterator.h.
| typedef TImage::RegionType itk::ConditionalConstIterator< TImage >::RegionType |
Region typedef support.
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 56 of file itkConditionalConstIterator.h.
| typedef ConditionalConstIterator itk::ConditionalConstIterator< TImage >::Self |
Standard class typedefs.
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 41 of file itkConditionalConstIterator.h.
| typedef TImage::SizeType itk::ConditionalConstIterator< TImage >::SizeType |
Size typedef support.
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 53 of file itkConditionalConstIterator.h.
Constructor & Destructor Documentation
| itk::ConditionalConstIterator< TImage >::ConditionalConstIterator | ( | ) |
Constructor
| virtual itk::ConditionalConstIterator< TImage >::~ConditionalConstIterator | ( | ) | [virtual] |
Destructor
Member Function Documentation
| virtual const PixelType& itk::ConditionalConstIterator< TImage >::Get | ( | void | ) | const [pure virtual] |
Get the pixel value at the current iterator location.
Implemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
| virtual const IndexType itk::ConditionalConstIterator< TImage >::GetIndex | ( | ) | [pure virtual] |
Get the index at the current iterator location.
Implemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.
| static unsigned int itk::ConditionalConstIterator< TImage >::GetIteratorDimension | ( | ) | [inline, static] |
Get the dimension (size) of the index.
Reimplemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 80 of file itkConditionalConstIterator.h.
References HardConnectedComponentImageFilter::ImageDimension.
| virtual bool itk::ConditionalConstIterator< TImage >::IsAtEnd | ( | ) | [pure virtual] |
Is the iterator at the end of the region?
Implemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.
| virtual bool itk::ConditionalConstIterator< TImage >::IsPixelIncluded | ( | const IndexType & | index | ) | const [pure virtual] |
Compute whether the index of interest should be included in the flood
Implemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
| virtual void itk::ConditionalConstIterator< TImage >::operator++ | ( | ) | [pure virtual] |
Walk forward one index.
Implemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.
| 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 72 of file itkConditionalConstIterator.h.
References itk::ConditionalConstIterator< TImage >::m_Image, and itk::ConditionalConstIterator< TImage >::m_Region.
Member Data Documentation
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image [protected] |
Smart pointer to the source image.
Definition at line 104 of file itkConditionalConstIterator.h.
Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), and itk::ConditionalConstIterator< TImage >::operator=().
bool itk::ConditionalConstIterator< TImage >::m_IsAtEnd [protected] |
Is the iterator at the end of its walk?
Definition at line 110 of file itkConditionalConstIterator.h.
RegionType itk::ConditionalConstIterator< TImage >::m_Region [protected] |
Region type to iterate over.
Definition at line 107 of file itkConditionalConstIterator.h.
Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), and itk::ConditionalConstIterator< TImage >::operator=().
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 47 of file itkConditionalConstIterator.h.
The documentation for this class was generated from the following file:
