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

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::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::ShapedFloodFilledImageFunctionConditionalIterator	(	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 77 of file itkShapedFloodFilledImageFunctionConditionalIterator.h.

template<class TImage , class TFunction >

itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::ShapedFloodFilledImageFunctionConditionalIterator	(	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 84 of file itkShapedFloodFilledImageFunctionConditionalIterator.h.

template<class TImage , class TFunction >

itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::ShapedFloodFilledImageFunctionConditionalIterator	(	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 91 of file itkShapedFloodFilledImageFunctionConditionalIterator.h.

template<class TImage , class TFunction >

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

Default Destructor.

Definition at line 103 of file itkShapedFloodFilledImageFunctionConditionalIterator.h.

Member Function Documentation

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.

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

Clear all the seeds

Definition at line 161 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

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.

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

Automatically find all seed pixels.

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.

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::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Get ( void ) const [inline, virtual]

Get the pixel value

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

Definition at line 95 of file itkShapedFloodFilledImageFunctionConditionalIterator.h.

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.

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

Definition at line 206 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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.

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.

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.

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

Initializes the iterator, called from constructor

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.

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

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

Implements itk::ShapedFloodFilledFunctionConditionalConstIterator< 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::ShapedFloodFilledFunctionConditionalConstIterator< 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.

template<class TImage , class TFunction >

itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::itkStaticConstMacro	(	NDimensions	,
		unsigned	int,
		Superclass::NDimensions
	)

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::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, 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::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Set ( const PixelType & value ) [inline]

Set the pixel value

Definition at line 99 of file itkShapedFloodFilledImageFunctionConditionalIterator.h.

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

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.

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.

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.

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::ShapedFloodFilledFunctionConditionalConstIterator< TImage , TFunction >::m_ImageOrigin [protected, inherited]

The origin of the source image

Definition at line 238 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Region of the source image

Definition at line 247 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

The spacing of the source image

Definition at line 241 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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.

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::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.

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

Location vector used in the flood algorithm

Definition at line 253 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

The neighborhood iterator

Definition at line 244 of file itkShapedFloodFilledFunctionConditionalConstIterator.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::ShapedFloodFilledFunctionConditionalConstIterator< TImage , TFunction >::m_StartIndices [protected, inherited]

A list of locations to start the recursive fill

Definition at line 235 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

Definition at line 232 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

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

itkShapedFloodFilledImageFunctionConditionalIterator.h


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 ShapedFloodFilledImageFunctionConditionalIterator	Self
typedef Superclass::SizeType	SizeType
typedef ShapedFloodFilledImageFunctionConditionalConstIterator < 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
	itkStaticConstMacro (NDimension, unsigned int, TImage::ImageDimension)
	itkStaticConstMacro (NDimensions, unsigned int, TImage::ImageDimension)
	itkStaticConstMacro (NDimensions, unsigned int, Superclass::NDimensions)
void	operator++ ()
void	Set (const PixelType &value)
	ShapedFloodFilledImageFunctionConditionalIterator (ImageType imagePtr, FunctionType fnPtr)
	ShapedFloodFilledImageFunctionConditionalIterator (ImageType imagePtr, FunctionType fnPtr, std::vector< IndexType > &startIndex)
	ShapedFloodFilledImageFunctionConditionalIterator (ImageType imagePtr, FunctionType fnPtr, IndexType startIndex)
virtual	~ShapedFloodFilledImageFunctionConditionalIterator ()

virtual void	FullyConnectedOff ()
virtual void	FullyConnectedOn ()
bool	GetFullyConnected () const
void	SetFullyConnected (const bool _arg)
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
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

itk::ShapedFloodFilledImageFunctionConditionalIterator< 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::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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

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