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

typedef Image<unsigned char, itkGetStaticConstMacro(NDimensions)> itk::FloodFilledFunctionConditionalConstIterator< 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 210 of file itkFloodFilledFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

template<class TImage , class TFunction >

itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::FloodFilledSpatialFunctionConditionalIterator	(	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 68 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage , class TFunction >

itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::FloodFilledSpatialFunctionConditionalIterator	(	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 75 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage , class TFunction >

virtual itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::~FloodFilledSpatialFunctionConditionalIterator ( ) [inline, virtual]

Default Destructor.

Definition at line 91 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

Member Function Documentation

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

Put more seeds on the list

Definition at line 144 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Clear all the seeds

Definition at line 150 of file itkFloodFilledFunctionConditionalConstIterator.h.

void itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::DoFloodStep ( ) [inherited]

void itk::FloodFilledFunctionConditionalConstIterator< 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.

void itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::FindSeedPixels ( ) [inherited]

Automatically find all seed pixels.

template<class TImage , class TFunction >

PixelType& itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Get ( void ) [inline]

Get the pixel value, non-const version is sometimes useful.

Definition at line 83 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage , class TFunction >

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

Get the pixel value, const version to avoid overload warnings

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

Definition at line 79 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

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

Definition at line 195 of file itkFloodFilledFunctionConditionalConstIterator.h.

const IndexType itk::FloodFilledFunctionConditionalConstIterator< 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 132 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Get the dimension (size) of the index.

Reimplemented from itk::ConditionalConstIterator< TImage >.

Definition at line 125 of file itkFloodFilledFunctionConditionalConstIterator.h.

void itk::FloodFilledFunctionConditionalConstIterator< 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 157 of file itkFloodFilledFunctionConditionalConstIterator.h.

void itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::InitializeIterator ( ) [inherited]

Initializes the iterator, called from constructor

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

Is the iterator at the end of the region?

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 140 of file itkFloodFilledFunctionConditionalConstIterator.h.

bool itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage , TFunction >::IsPixelIncluded ( const IndexType & index ) const [virtual, inherited]

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

Implements itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

itk::ConditionalConstIterator< TImage >::itkStaticConstMacro	(	NDimension	,
		unsigned	int,
		TImage ::ImageDimension
	)			`[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.

itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::itkStaticConstMacro	(	NDimensions	,
		unsigned	int,
		TImage ::ImageDimension
	)			`[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.

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

Walk forward one index

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 190 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >

void itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Set ( const PixelType & value ) [inline]

Set the pixel value

Definition at line 87 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage , TFunction >::SetCenterInclusionStrategy ( ) [inline, inherited]

Set the inclusion strategy to center

Definition at line 88 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage , TFunction >::SetCompleteInclusionStrategy ( ) [inline, inherited]

Set the inclusion strategy to complete

Definition at line 91 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage , TFunction >::SetIntersectInclusionStrategy ( ) [inline, inherited]

Set the inclusion strategy to intersect

Definition at line 94 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage , TFunction >::SetOriginInclusionStrategy ( ) [inline, inherited]

Set the inclusion strategy to origin

Definition at line 85 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

Member Data Documentation

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

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

Definition at line 233 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Smart pointer to the function we're evaluating

Definition at line 203 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Smart pointer to the source image.

Definition at line 104 of file itkConditionalConstIterator.h.

ImageType::PointType itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::m_ImageOrigin [protected, inherited]

The origin of the source image

Definition at line 217 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Region of the source image

Definition at line 223 of file itkFloodFilledFunctionConditionalConstIterator.h.

ImageType::SpacingType itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::m_ImageSpacing [protected, inherited]

The spacing of the source image

Definition at line 220 of file itkFloodFilledFunctionConditionalConstIterator.h.

unsigned char itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage , TFunction >::m_InclusionStrategy [protected, inherited]

How the pixel (index) is examined in order to decide whether or not it's included. The strategies are: 0) Origin: if the origin of the pixel in physical space is inside the function, then the pixel is inside the function 1) Center: if the center of a pixel, in physical space, is inside the function, then the pixel is inside the function 2) Complete: if all of the corners of the pixel in physical space are inside the function, then the pixel is inside the function 3) Intersect: if any of the corners of the pixel in physical space are inside the function, then the pixel is inside the function

Definition at line 109 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

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

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

Definition at line 226 of file itkFloodFilledFunctionConditionalConstIterator.h.

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.

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

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

Definition at line 236 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Location vector used in the flood algorithm

Definition at line 229 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Region type to iterate over.

Definition at line 107 of file itkConditionalConstIterator.h.

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

A list of locations to start the recursive fill

Definition at line 214 of file itkFloodFilledFunctionConditionalConstIterator.h.

TTempImage::Pointer itk::FloodFilledFunctionConditionalConstIterator< TImage , TFunction >::m_TemporaryPointer [protected, inherited]

Definition at line 211 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

itkFloodFilledSpatialFunctionConditionalIterator.h


Public Types
typedef Superclass::FunctionInputType	FunctionInputType
typedef Superclass::FunctionType	FunctionType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef FloodFilledSpatialFunctionConditionalIterator	Self
typedef Superclass::SizeType	SizeType
typedef FloodFilledSpatialFunctionConditionalConstIterator < TImage, TFunction >	Superclass
Public Member Functions
void	AddSeed (const IndexType seed)
void	ClearSeeds ()
void	DoFloodStep ()
void	FindSeedPixel ()
void	FindSeedPixels ()
	FloodFilledSpatialFunctionConditionalIterator (ImageType imagePtr, FunctionType fnPtr)
	FloodFilledSpatialFunctionConditionalIterator (ImageType imagePtr, FunctionType fnPtr, IndexType startIndex)
PixelType &	Get (void)
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
	itkStaticConstMacro (NDimension, unsigned int, TImage::ImageDimension)
	itkStaticConstMacro (NDimensions, unsigned int, TImage::ImageDimension)
void	operator++ ()
void	Set (const PixelType &value)
void	SetCenterInclusionStrategy ()
void	SetCompleteInclusionStrategy ()
void	SetIntersectInclusionStrategy ()
void	SetOriginInclusionStrategy ()
virtual	~FloodFilledSpatialFunctionConditionalIterator ()
Static Public Member Functions
static unsigned int	GetIteratorDimension ()
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
unsigned char	m_InclusionStrategy
std::queue< IndexType >	m_IndexStack
bool	m_IsAtEnd
bool	m_IsValidIndex
FunctionInputType	m_LocationVector
RegionType	m_Region
std::vector< IndexType >	m_StartIndices
TTempImage::Pointer	m_TemporaryPointer

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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

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