ITK  6.0.0
Insight 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
Data Access Objects » Iterators » Image IteratorsGroup Core » | Module ITKCommon

#include <itkConditionalConstIterator.h>

Detailed Description

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

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

Public Types

using ImageType = TImage
 
using IndexType = typename TImage::IndexType
 
using InternalPixelType = typename TImage::InternalPixelType
 
using PixelType = typename TImage::PixelType
 
using RegionType = typename TImage::RegionType
 
using Self = ConditionalConstIterator
 
using SizeType = typename TImage::SizeType
 

Public Member Functions

 ConditionalConstIterator ()=default
 
virtual const PixelType Get () const =0
 
virtual const IndexType GetIndex ()=0
 
virtual bool IsAtEnd () const =0
 
virtual bool IsPixelIncluded (const IndexType &index) const =0
 
virtual void operator++ ()=0
 
Self & operator= (const Self &it)
 
virtual ~ConditionalConstIterator ()=default
 

Static Public Member Functions

static unsigned int GetIteratorDimension ()
 

Static Public Attributes

static constexpr unsigned int NDimension = TImage::ImageDimension
 

Protected Attributes

ImageType::ConstWeakPointer m_Image {}
 
bool m_IsAtEnd { false }
 
RegionType m_Region {}
 

Member Typedef Documentation

◆ ImageType

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::ImageType = TImage

Image type alias support.

Definition at line 60 of file itkConditionalConstIterator.h.

◆ IndexType

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::IndexType = typename TImage::IndexType

Index type alias support.

Definition at line 51 of file itkConditionalConstIterator.h.

◆ InternalPixelType

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 63 of file itkConditionalConstIterator.h.

◆ PixelType

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 66 of file itkConditionalConstIterator.h.

◆ RegionType

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::RegionType = typename TImage::RegionType

Region type alias support.

Definition at line 57 of file itkConditionalConstIterator.h.

◆ Self

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::Self = ConditionalConstIterator

Standard class type aliases.

Definition at line 42 of file itkConditionalConstIterator.h.

◆ SizeType

template<typename TImage >
using itk::ConditionalConstIterator< TImage >::SizeType = typename TImage::SizeType

Size type alias support.

Definition at line 54 of file itkConditionalConstIterator.h.

Constructor & Destructor Documentation

◆ ConditionalConstIterator()

template<typename TImage >
itk::ConditionalConstIterator< TImage >::ConditionalConstIterator ( )
default

Constructor

◆ ~ConditionalConstIterator()

template<typename TImage >
virtual itk::ConditionalConstIterator< TImage >::~ConditionalConstIterator ( )
virtualdefault

Destructor

Member Function Documentation

◆ Get()

template<typename TImage >
virtual const PixelType itk::ConditionalConstIterator< TImage >::Get ( ) const
pure virtual

Get the pixel value at the current iterator location.

Implemented in itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.

◆ GetIndex()

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

◆ GetIteratorDimension()

template<typename TImage >
static unsigned int itk::ConditionalConstIterator< TImage >::GetIteratorDimension ( )
inlinestatic

Get the dimension (size) of the index.

Definition at line 85 of file itkConditionalConstIterator.h.

◆ IsAtEnd()

template<typename TImage >
virtual bool itk::ConditionalConstIterator< TImage >::IsAtEnd ( ) const
pure virtual

Is the iterator at the end of the region?

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

◆ IsPixelIncluded()

template<typename TImage >
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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >.

◆ operator++()

template<typename TImage >
virtual void itk::ConditionalConstIterator< TImage >::operator++ ( )
pure virtual

Walk forward one index.

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

◆ operator=()

template<typename 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 75 of file itkConditionalConstIterator.h.

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

Member Data Documentation

◆ m_Image

template<typename TImage >
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image {}
protected

Smart pointer to the source image.

Definition at line 115 of file itkConditionalConstIterator.h.

Referenced by itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Get(), itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Get(), itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Get(), itk::ConditionalConstIterator< TImage >::operator=(), itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Set(), itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Set(), and itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Set().

◆ m_IsAtEnd

template<typename TImage >
bool itk::ConditionalConstIterator< TImage >::m_IsAtEnd { false }
protected

Is the iterator at the end of its walk?

Definition at line 121 of file itkConditionalConstIterator.h.

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

◆ m_Region

template<typename TImage >
RegionType itk::ConditionalConstIterator< TImage >::m_Region {}
protected

Region type to iterate over.

Definition at line 118 of file itkConditionalConstIterator.h.

Referenced by itk::ConditionalConstIterator< TImage >::operator=(), itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=().

◆ NDimension

template<typename TImage >
constexpr unsigned int itk::ConditionalConstIterator< TImage >::NDimension = TImage::ImageDimension
staticconstexpr

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.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16