Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Attributes

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

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

#include <itkShapedFloodFilledImageFunctionConditionalConstIterator.h>

Inheritance diagram for itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >:
Inheritance graph
[legend]
Collaboration diagram for itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
Superclass::FunctionInputType 		FunctionInputType
typedef Superclass::FunctionType FunctionType
typedef Superclass::ImageType ImageType
typedef Superclass::IndexType IndexType
typedef
Superclass::InternalPixelType 		InternalPixelType
typedef
itk::ShapedNeighborhoodIterator
< ImageType > 		NeighborhoodIteratorType
typedef TImage::OffsetType OffsetType
typedef Superclass::PixelType PixelType
typedef Superclass::RegionType RegionType
typedef
ShapedFloodFilledImageFunctionConditionalConstIterator 		Self
typedef Superclass::SizeType SizeType
typedef
ShapedFloodFilledFunctionConditionalConstIterator
< TImage, TFunction > 		Superclass

Public Member Functions

void AddSeed (const IndexType seed)
void ClearSeeds ()
void DoFloodStep ()
void FindSeedPixel ()
void FindSeedPixels ()
const PixelType & Get (void) const
virtual SmartPointer
< FunctionType > 		GetFunction () const
const IndexType GetIndex ()
void GoToBegin ()
void InitializeIterator ()
bool IsAtEnd ()
bool IsPixelIncluded (const IndexType &index) const
void operator++ ()
 ShapedFloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
 ShapedFloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
 ShapedFloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
virtual ~ShapedFloodFilledImageFunctionConditionalConstIterator ()

void SetFullyConnected (const bool _arg)
bool GetFullyConnected () const
virtual void FullyConnectedOn ()
virtual void FullyConnectedOff ()

Static Public Member Functions

static unsigned int GetIteratorDimension ()

Static Public Attributes

static const unsigned int NDimension = TImage::ImageDimension
static const unsigned int NDimensions = Superclass::NDimensions

Protected Types

typedef Image< unsigned char,
itkGetStaticConstMacro(NDimensions)> 		TTempImage

Protected Attributes

bool m_FoundUncheckedNeighbor
SmartPointer< FunctionType > m_Function
ImageType::ConstWeakPointer m_Image
ImageType::PointType m_ImageOrigin
RegionType m_ImageRegion
ImageType::SpacingType m_ImageSpacing
std::queue< IndexType > m_IndexStack
bool m_IsAtEnd
bool m_IsValidIndex
FunctionInputType m_LocationVector
NeighborhoodIteratorType m_NeighborhoodIterator
RegionType m_Region
std::vector< IndexType > m_StartIndices
TTempImage::Pointer m_TempPtr

bool m_FullyConnected

Detailed Description

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

Iterates over a flood-filled image function.

Contributed as a paper to the Insight Journal: http://hdl.handle.net/1926/1320

Definition at line 36 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

Member Typedef Documentation

template<class TImage , class TFunction >
typedef Superclass::FunctionInputType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType

Type of vector used to store location info in the spatial function

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 51 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::FunctionType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FunctionType

Type of function

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 48 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::ImageType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::ImageType

Image typedef support.

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 63 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::IndexType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::IndexType

Index typedef support.

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 54 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::InternalPixelType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType

Internal Pixel Type

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 66 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef itk::ShapedNeighborhoodIterator<ImageType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::NeighborhoodIteratorType [inherited]

Internal Neighborhood Iterator Type

Definition at line 80 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef TImage::OffsetType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::OffsetType [inherited]

Offset typedef support.

Definition at line 62 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::PixelType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::PixelType

External Pixel Type

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 69 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::RegionType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::RegionType

Region typedef support

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 60 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

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

Standard class typedefs.

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 43 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef Superclass::SizeType itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::SizeType

Size typedef support.

Reimplemented from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 57 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
typedef ShapedFloodFilledFunctionConditionalConstIterator<TImage, TFunction> itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::Superclass

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 45 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

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

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 230 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

template<class TImage , class TFunction >
itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledImageFunctionConditionalConstIterator ( const ImageType *  imagePtr,
FunctionType *  fnPtr,
IndexType  startIndex 
) [inline]

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"

Definition at line 80 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledImageFunctionConditionalConstIterator ( const ImageType *  imagePtr,
FunctionType *  fnPtr,
std::vector< IndexType > &  startIndex 
) [inline]

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

Definition at line 90 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledImageFunctionConditionalConstIterator ( const ImageType *  imagePtr,
FunctionType *  fnPtr 
) [inline]

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.

Definition at line 100 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

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

Default Destructor.

Definition at line 106 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

Member Function Documentation

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

Put more seeds on the list

Definition at line 155 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Clear all the seeds

Definition at line 161 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep (  )  [inherited]
template<class TImage , class TFunction >
void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixel (  )  [inherited]

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 LargestPossibleRegion and applying the IsPixelIncluded() test.

template<class TImage , class TFunction >
void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixels (  )  [inherited]

Automatically find all seed pixels.

template<class TImage , class TFunction >
virtual void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FullyConnectedOff (  )  [virtual, inherited]

When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.

template<class TImage , class TFunction >
virtual void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FullyConnectedOn (  )  [virtual, inherited]

When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.

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

Get the pixel value

Implements itk::ConditionalConstIterator< TImage >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 147 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFullyConnected (  )  const [inherited]

When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.

template<class TImage , class TFunction >
virtual SmartPointer<FunctionType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction (  )  const [inline, virtual, inherited]

Definition at line 206 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

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 143 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Get the dimension (size) of the index.

Reimplemented from itk::ConditionalConstIterator< TImage >.

Definition at line 136 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References HardConnectedComponentImageFilter::ImageDimension.

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

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Definition at line 168 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator (  )  [inherited]

Initializes the iterator, called from constructor

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

Is the iterator at the end of the region?

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 151 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Compute whether the index of interest should be included in the flood

Implements itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

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

Walk forward one index

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 201 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SetFullyConnected ( const bool  _arg  )  [inherited]

When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.

Member Data Documentation

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

Indicates whether or not we've found a neighbor that needs to be checked.

Definition at line 257 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FullyConnected [protected, inherited]

Defines the connectivity of the neighborhood iterator. In case of 2D the default connectivity is 4 (6 in 3D) and when m_FullyConnected is set to true the connectivity is 8 (26 in 3D).

Definition at line 267 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Smart pointer to the function we're evaluating

Definition at line 217 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Smart pointer to the source image.

Definition at line 104 of file itkConditionalConstIterator.h.

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

template<class TImage , class TFunction >
ImageType::PointType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin [protected, inherited]

The origin of the source image

Definition at line 238 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Region of the source image

Definition at line 247 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
ImageType::SpacingType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing [protected, inherited]

The spacing of the source image

Definition at line 241 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Stack used to hold the path of the iterator through the image

Definition at line 250 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Is the iterator at the end of its walk?

Definition at line 110 of file itkConditionalConstIterator.h.

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

Indicates whether or not an index is valid (inside an image)/

Definition at line 260 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Location vector used in the flood algorithm

Definition at line 253 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
NeighborhoodIteratorType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_NeighborhoodIterator [protected, inherited]

The neighborhood iterator

Definition at line 244 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Region type to iterate over.

Definition at line 107 of file itkConditionalConstIterator.h.

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

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

A list of locations to start the recursive fill

Definition at line 235 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
TTempImage::Pointer itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TempPtr [protected, inherited]

Definition at line 232 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<class TImage >
const unsigned int itk::ConditionalConstIterator< TImage >::NDimension = TImage::ImageDimension [static, inherited]

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.

template<class TImage , class TFunction >
const unsigned int itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::NDimensions = Superclass::NDimensions [static]

Dimension of the image the iterator walks. This constant is needed so 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 75 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

The documentation for this class was generated from the following file:
Generated at Tue Jul 13 2010 01:39:24 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000