itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction > Class Template Reference
[Image Iterators]

Iterates over a flood-filled spatial function. More...

#include <itkFloodFilledFunctionConditionalConstIterator.h>

Inheritance diagram for itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >:

[legend]Collaboration diagram for itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >:

[legend]List of all members.

Public Types
typedef FloodFilledFunctionConditionalConstIterator	Self
typedef TFunction	FunctionType
typedef TFunction::InputType	FunctionInputType
typedef TImage::IndexType	IndexType
typedef TImage::SizeType	SizeType
typedef TImage::RegionType	RegionType
typedef TImage	ImageType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::PixelType	PixelType
Public Member Functions
	itkStaticConstMacro (NDimensions, unsigned int, TImage::ImageDimension)
	FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndices)
	FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
void	FindSeedPixel ()
void	FindSeedPixels ()
void	InitializeIterator ()
virtual	~FloodFilledFunctionConditionalConstIterator ()
virtual bool	IsPixelIncluded (const IndexType &index) const =0
Self &	operator= (const Self &it)
const IndexType	GetIndex ()
const PixelType &	Get (void) const
bool	IsAtEnd ()
void	GoToBegin ()
void	operator++ ()
void	DoFloodStep ()
void	AddSeed (const IndexType seed)
void	ClearSeeds ()
Static Public Member Functions
unsigned int	GetIteratorDimension ()
Protected Types
typedef Image< unsigned char, itkGetStaticConstMacro(NDimensions)	TTempImage )
Protected Attributes
SmartPointer< FunctionType >	m_Function
TTempImage::Pointer	tempPtr
std::vector< IndexType >	m_StartIndices
const double *	m_ImageOrigin
const double *	m_ImageSpacing
RegionType	m_ImageRegion
std::queue< IndexType >	m_IndexStack
FunctionInputType	m_LocationVector
bool	m_FoundUncheckedNeighbor
bool	m_IsValidIndex

---

Detailed Description

template<class TImage, class TFunction>
class itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >

Iterates over a flood-filled spatial function.

Definition at line 39 of file itkFloodFilledFunctionConditionalConstIterator.h.

---

Member Typedef Documentation

template<class TImage, class TFunction> typedef TFunction::InputType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType

Type of vector used to store location info in the spatial function Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 50 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef TFunction itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionType

Type of function Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 47 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef TImage itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ImageType

Image typedef support. Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 62 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef TImage::IndexType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType

Index typedef support. Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 53 of file itkFloodFilledFunctionConditionalConstIterator.h. Referenced by itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::~FloodFilledFunctionConditionalConstIterator().

template<class TImage, class TFunction> typedef TImage::InternalPixelType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType

Internal Pixel Type Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 65 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef TImage::PixelType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::PixelType

External Pixel Type Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 68 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef TImage::RegionType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::RegionType

Region typedef support Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 59 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef FloodFilledFunctionConditionalConstIterator itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Self

Standard class typedefs. Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 44 of file itkFloodFilledFunctionConditionalConstIterator.h. Referenced by itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::~FloodFilledFunctionConditionalConstIterator().

template<class TImage, class TFunction> typedef TImage::SizeType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SizeType

Size typedef support. Reimplemented from itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 56 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> typedef Image<unsigned char, itkGetStaticConstMacro(NDimensions) itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::TTempImage) [protected]

A temporary image used for storing info about indices 0 = pixel has not yet been processed 1 = pixel is not inside the function 2 = pixel is inside the function, neighbor check incomplete 3 = pixel is inside the function, neighbor check complete Definition at line 201 of file itkFloodFilledFunctionConditionalConstIterator.h. Referenced by itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++().

---

Constructor & Destructor Documentation

template<class TImage, class TFunction> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledFunctionConditionalConstIterator (  const ImageType *  imagePtr, FunctionType *  fnPtr, IndexType  startIndex )

Constructor establishes an iterator to walk a particular image and a particular region of that image. This version of the constructor uses an explicit seed pixel for the flood fill, the "startIndex"

template<class TImage, class TFunction> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledFunctionConditionalConstIterator (  const ImageType *  imagePtr, FunctionType *  fnPtr, std::vector< IndexType > &  startIndices )

Constructor establishes an iterator to walk a particular image and a particular region of that image. This version of the constructor uses a list of seed pixels for the flood fill

template<class TImage, class TFunction> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledFunctionConditionalConstIterator (  const ImageType *  imagePtr, FunctionType *  fnPtr )

Constructor establishes an iterator to walk a particular image and a particular region of that image. This version of the constructor should be used when the seed pixel is unknown

template<class TImage, class TFunction> virtual itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::~FloodFilledFunctionConditionalConstIterator (   )  [inline, virtual]

Default Destructor. Definition at line 109 of file itkFloodFilledFunctionConditionalConstIterator.h. References itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType, and itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Self.

---

Member Function Documentation

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed (  const IndexType  seed  )  [inline]

Put more seeds on the list Definition at line 142 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds (   )  [inline]

Clear all the seeds Definition at line 149 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep (   )

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixel (   )

Automatically find a seed pixel and set m_StartIndex. Does nothing if a seed pixel isn't found. A seed pixel is determined by traversing the input image's image's LargestPossibleRegion and applying the IsPixelIncluded() test.

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixels (   )

Automatically find all seed pixels.

template<class TImage, class TFunction> const PixelType& itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Get (  void   )  const [inline, virtual]

Get the pixel value Implements itk::ConditionalConstIterator< TImage >. Reimplemented in itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >. Definition at line 134 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> const IndexType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIndex (  void   )  [inline, virtual]

Get the index. This provides a read only reference to the index. This causes the index to be calculated from pointer arithmetic and is therefore an expensive operation. See also: SetIndex Implements itk::ConditionalConstIterator< TImage >. Definition at line 130 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Get the dimension (size) of the index. Reimplemented from itk::ConditionalConstIterator< TImage >. Definition at line 123 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin (   )  [inline]

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region. Definition at line 157 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator (   )

Initializes the iterator, called from constructor

template<class TImage, class TFunction> bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsAtEnd (   )  [inline, virtual]

Is the iterator at the end of the region? Implements itk::ConditionalConstIterator< TImage >. Definition at line 138 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> virtual bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsPixelIncluded (  const IndexType &  index  )  const [pure virtual]

Compute whether the index of interest should be included in the flood Implements itk::ConditionalConstIterator< TImage >. Implemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >.

template<class TImage, class TFunction> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::itkStaticConstMacro (  NDimensions  , 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. Reimplemented from itk::ConditionalConstIterator< TImage >.

template<class TImage, class TFunction> void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++ (   )  [inline, virtual]

Walk forward one index Implements itk::ConditionalConstIterator< TImage >. Definition at line 187 of file itkFloodFilledFunctionConditionalConstIterator.h. References itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::TTempImage.

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

operator= is provided to make sure the handle to the image is properly reference counted. Reimplemented from itk::ConditionalConstIterator< TImage >. Definition at line 116 of file itkFloodFilledFunctionConditionalConstIterator.h. References itk::ConditionalConstIterator< TImage >::m_Image, and itk::ConditionalConstIterator< TImage >::m_Region.

---

Member Data Documentation

template<class TImage, class TFunction> bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FoundUncheckedNeighbor [protected]

Indicates whether or not we've found a neighbor that needs to be checked. Definition at line 223 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> SmartPointer<FunctionType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function [protected]

Smart pointer to the function we're evaluating Definition at line 194 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> const double* itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin [protected]

The origin of the source image Definition at line 208 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> RegionType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageRegion [protected]

Region of the source image Definition at line 214 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> const double* itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing [protected]

The spacing of the source image Definition at line 211 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> std::queue<IndexType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack [protected]

Stack used to hold the path of the iterator through the image Definition at line 217 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IsValidIndex [protected]

Indicates whether or not an index is valid (inside an image)/ Definition at line 226 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> FunctionInputType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_LocationVector [protected]

Location vector used in the flood algorithm Definition at line 220 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> std::vector<IndexType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_StartIndices [protected]

A list of locations to start the recursive fill Definition at line 205 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction> TTempImage::Pointer itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::tempPtr [protected]

Definition at line 202 of file itkFloodFilledFunctionConditionalConstIterator.h.

---

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

• itkFloodFilledFunctionConditionalConstIterator.h

---