itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction > Class Template Reference

#include <itkShapedFloodFilledFunctionConditionalConstIterator.h>

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

Collaboration diagram for itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >:

Detailed Description

template<typename TImage, typename TFunction>
class itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >

Iterates over a flood-filled spatial function with read-only access to pixels.

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

Definition at line 43 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Public Types
typedef TFunction::InputType	FunctionInputType
typedef TFunction	FunctionType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::InternalPixelType	InternalPixelType
typedef itk::ShapedNeighborhoodIterator < ImageType >	NeighborhoodIteratorType
typedef TImage::OffsetType	OffsetType
typedef TImage::PixelType	PixelType
typedef TImage::RegionType	RegionType
typedef std::vector< IndexType >	SeedsContainerType
typedef ShapedFloodFilledFunctionConditionalConstIterator	Self
typedef TImage::SizeType	SizeType
Public Types inherited from itk::ConditionalConstIterator< TImage >
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
void	AddSeed (const IndexType seed)
void	ClearSeeds ()
void	DoFloodStep ()
void	FindSeedPixel ()
void	FindSeedPixels ()
virtual void	FullyConnectedOff ()
virtual void	FullyConnectedOn ()
const PixelType	Get (void) const
bool	GetFullyConnected () const
virtual SmartPointer < FunctionType >	GetFunction () const
const IndexType	GetIndex ()
virtual const SeedsContainerType &	GetSeeds () const
void	GoToBegin ()
void	InitializeIterator ()
bool	IsAtEnd ()
virtual bool	IsPixelIncluded (const IndexType &index) const =0
void	operator++ ()
Self &	operator= (const Self &it)
void	SetFullyConnected (const bool _arg)
	ShapedFloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	ShapedFloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndices)
	ShapedFloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
virtual	~ShapedFloodFilledFunctionConditionalConstIterator ()
Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
	ConditionalConstIterator ()
Self &	operator= (const Self &it)
virtual	~ConditionalConstIterator ()

Static Public Member Functions
static unsigned int	GetIteratorDimension ()
Static Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
static unsigned int	GetIteratorDimension (void)

Static Public Attributes
static const unsigned int	NDimensions = TImage::ImageDimension
Static Public Attributes inherited from itk::ConditionalConstIterator< TImage >
static const unsigned int	NDimension = TImage::ImageDimension

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

Protected Attributes
bool	m_FoundUncheckedNeighbor
SmartPointer< FunctionType >	m_Function
ImageType::PointType	m_ImageOrigin
RegionType	m_ImageRegion
ImageType::SpacingType	m_ImageSpacing
std::queue< IndexType >	m_IndexStack
bool	m_IsValidIndex
FunctionInputType	m_LocationVector
NeighborhoodIteratorType	m_NeighborhoodIterator
SeedsContainerType	m_Seeds
TTempImage::Pointer	m_TempPtr
bool	m_FullyConnected
Protected Attributes inherited from itk::ConditionalConstIterator< TImage >
ImageType::ConstWeakPointer	m_Image
bool	m_IsAtEnd
RegionType	m_Region

Member Typedef Documentation

template<typename TImage , typename TFunction >

typedef TFunction::InputType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType

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

Definition at line 55 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TFunction itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionType

Type of function

Definition at line 52 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ImageType

Image typedef support.

Definition at line 73 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage::IndexType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType

Index typedef support.

Definition at line 58 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage::InternalPixelType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType

Internal Pixel Type

Definition at line 76 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef itk::ShapedNeighborhoodIterator< ImageType > itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::NeighborhoodIteratorType

Internal Neighborhood Iterator Type

Definition at line 82 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage::OffsetType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::OffsetType

Offset typedef support.

Definition at line 64 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage::PixelType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::PixelType

External Pixel Type

Definition at line 79 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage::RegionType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::RegionType

Region typedef support

Definition at line 70 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef std::vector< IndexType > itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SeedsContainerType

Index Container Type

Definition at line 61 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef ShapedFloodFilledFunctionConditionalConstIterator itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Self

Standard class typedefs.

Definition at line 49 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef TImage::SizeType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SizeType

Size typedef support.

Definition at line 67 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

typedef Image< unsigned char, itkGetStaticConstMacro(NDimensions) > itk::ShapedFloodFilledFunctionConditionalConstIterator< 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 237 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage , typename TFunction >

itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledFunctionConditionalConstIterator	(	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<typename TImage , typename TFunction >

itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledFunctionConditionalConstIterator	(	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<typename TImage , typename TFunction >

itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledFunctionConditionalConstIterator	(	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<typename TImage , typename TFunction >

virtual itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::~ShapedFloodFilledFunctionConditionalConstIterator ( )

inlinevirtual

Default Destructor.

Definition at line 123 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Member Function Documentation

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed ( const IndexType  seed )

inline

Put more seeds on the list

Definition at line 157 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Seeds.

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds ( )

inline

Clear all the seeds

Definition at line 163 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Seeds.

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep

(

)

Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++().

template<typename TImage , typename TFunction >

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

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixels

(

)

Automatically find all seed pixels.

template<typename TImage , typename TFunction >

virtual void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FullyConnectedOff ( )

virtual

template<typename TImage , typename TFunction >

virtual void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FullyConnectedOn ( )

virtual

template<typename TImage , typename TFunction >

const PixelType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Get ( void  ) const

inlinevirtual

Get the pixel value

Implements itk::ConditionalConstIterator< TImage >.

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

Definition at line 149 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ConditionalConstIterator< TImage >::m_Image, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack.

template<typename TImage , typename TFunction >

bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFullyConnected

(

)

const

template<typename TImage , typename TFunction >

virtual SmartPointer< FunctionType > itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction ( ) const

inlinevirtual

Definition at line 208 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function.

template<typename TImage , typename TFunction >

const IndexType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIndex ( void  )

inlinevirtual

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

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack.

template<typename TImage , typename TFunction >

static unsigned int itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIteratorDimension ( void  )

inlinestatic

Get the dimension (size) of the index.

Definition at line 138 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

virtual const SeedsContainerType& itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetSeeds ( ) const

inlinevirtual

Definition at line 223 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Seeds.

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin ( void  )

inline

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

Definition at line 170 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsPixelIncluded(), itk::ConditionalConstIterator< TImage >::m_Image, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack, itk::ConditionalConstIterator< TImage >::m_IsAtEnd, itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Seeds, and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TempPtr.

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator

(

)

Initializes the iterator, called from constructor

template<typename TImage , typename TFunction >

bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsAtEnd ( void  )

inlinevirtual

Is the iterator at the end of the region?

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 153 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

template<typename TImage , typename TFunction >

virtual bool itk::ShapedFloodFilledFunctionConditionalConstIterator< 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::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.

Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin().

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++ ( )

inlinevirtual

Walk forward one index

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 203 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

References itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep().

template<typename TImage , typename TFunction >

Self& itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator= ( const Self &  it )

inline

operator= is provided to make sure the handle to the image is properly reference counted.

Definition at line 130 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

template<typename TImage , typename TFunction >

void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SetFullyConnected

(

const bool

_arg

)

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<typename TImage , typename TFunction >

bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FoundUncheckedNeighbor

protected

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

Definition at line 264 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FullyConnected

protected

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

template<typename TImage , typename TFunction >

SmartPointer< FunctionType > itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function

protected

Smart pointer to the function we're evaluating

Definition at line 230 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction().

template<typename TImage , typename TFunction >

ImageType::PointType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin

protected

The origin of the source image

Definition at line 245 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

RegionType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageRegion

protected

Region of the source image

Definition at line 254 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

ImageType::SpacingType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing

protected

The spacing of the source image

Definition at line 248 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

std::queue< IndexType > itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack

protected

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

Definition at line 257 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Get(), itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Get(), itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIndex(), itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin(), and itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Set().

template<typename TImage , typename TFunction >

bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IsValidIndex

protected

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

Definition at line 267 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

FunctionInputType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_LocationVector

protected

Location vector used in the flood algorithm

Definition at line 260 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

NeighborhoodIteratorType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_NeighborhoodIterator

protected

The neighborhood iterator

Definition at line 251 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >

SeedsContainerType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Seeds

protected

A list of locations to start the recursive fill

Definition at line 242 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed(), itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds(), itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetSeeds(), and itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin().

template<typename TImage , typename TFunction >

TTempImage::Pointer itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TempPtr

protected

Definition at line 239 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin().

template<typename TImage , typename TFunction >

const unsigned int itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::NDimensions = 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 88 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

---

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

• itkShapedFloodFilledFunctionConditionalConstIterator.h