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

#include <itkFloodFilledImageFunctionConditionalIterator.h>

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

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

Public Types
using	FunctionInputType = typename Superclass::FunctionInputType
using	FunctionType = typename Superclass::FunctionType
using	ImageType = typename Superclass::ImageType
using	IndexType = typename Superclass::IndexType
using	InternalPixelType = typename Superclass::InternalPixelType
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	SeedsContainerType = typename Superclass::SeedsContainerType
using	Self = FloodFilledImageFunctionConditionalIterator
using	SizeType = typename Superclass::SizeType
using	Superclass = FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
Public Types inherited from itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
using	FunctionInputType = typename Superclass::FunctionInputType
using	FunctionType = typename Superclass::FunctionType
using	ImageType = typename Superclass::ImageType
using	IndexType = typename Superclass::IndexType
using	InternalPixelType = typename Superclass::InternalPixelType
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	SeedsContainerType = typename Superclass::SeedsContainerType
using	Self = FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
using	SizeType = typename Superclass::SizeType
using	Superclass = FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
Public Types inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
using	FunctionInputType = typename TFunction::InputType
using	FunctionType = TFunction
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	SeedsContainerType = typename std::vector< IndexType >
using	Self = FloodFilledFunctionConditionalConstIterator
using	SizeType = typename TImage::SizeType
Public Types inherited from itk::ConditionalConstIterator< TImage >
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	Self = ConditionalConstIterator
using	SizeType = typename TImage::SizeType

Public Member Functions
	FloodFilledImageFunctionConditionalIterator (ImageType *imagePtr, FunctionType *fnPtr)
	FloodFilledImageFunctionConditionalIterator (ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	FloodFilledImageFunctionConditionalIterator (ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
const PixelType	Get () const override
void	Set (const PixelType &value)
	~FloodFilledImageFunctionConditionalIterator () override=default
Public Member Functions inherited from itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
	FloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
	FloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	FloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
bool	IsPixelIncluded (const IndexType &index) const override
	~FloodFilledImageFunctionConditionalConstIterator () override=default
Public Member Functions inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
void	FindSeedPixel ()
void	FindSeedPixels ()
	FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
	FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
void	InitializeIterator ()
	~FloodFilledFunctionConditionalConstIterator () override=default
Self &	operator= (const Self &it)
const IndexType	GetIndex () override
bool	IsAtEnd () const override
void	AddSeed (const IndexType &seed)
virtual const SeedsContainerType &	GetSeeds () const
void	ClearSeeds ()
void	GoToBegin ()
void	operator++ () override
void	DoFloodStep ()
virtual SmartPointer< FunctionType >	GetFunction () const
Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
	ConditionalConstIterator ()=default
Self &	operator= (const Self &it)
virtual	~ConditionalConstIterator ()=default

Static Public Attributes
static constexpr unsigned int	NDimensions = Superclass::NDimensions
Static Public Attributes inherited from itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
static constexpr unsigned int	NDimensions = Superclass::NDimensions
Static Public Attributes inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
static constexpr unsigned int	NDimensions = TImage::ImageDimension
Static Public Attributes inherited from itk::ConditionalConstIterator< TImage >
static constexpr unsigned int	NDimension = TImage::ImageDimension

Additional Inherited Members
Static Public Member Functions inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
static unsigned int	GetIteratorDimension ()
Static Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
static unsigned int	GetIteratorDimension ()
Protected Types inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
using	TTempImage = Image< unsigned char, Self::NDimensions >
Protected Attributes inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
SmartPointer< FunctionType >	m_Function
TTempImage::Pointer	m_TemporaryPointer
SeedsContainerType	m_Seeds
ImageType::PointType	m_ImageOrigin
ImageType::SpacingType	m_ImageSpacing
RegionType	m_ImageRegion
std::queue< IndexType >	m_IndexStack
FunctionInputType	m_LocationVector
bool	m_FoundUncheckedNeighbor
bool	m_IsValidIndex
Protected Attributes inherited from itk::ConditionalConstIterator< TImage >
ImageType::ConstWeakPointer	m_Image
bool	m_IsAtEnd { false }
RegionType	m_Region

Detailed Description

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

Iterates over a flood-filled image function with write access to pixels.

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Iterate Image Starting At Seed

Examples

SphinxExamples/src/Core/Common/IterateImageStartingAtSeed/Code.cxx.

Definition at line 38 of file itkFloodFilledImageFunctionConditionalIterator.h.

Member Typedef Documentation

FunctionInputType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::FunctionInputType = typename Superclass::FunctionInputType

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

Definition at line 51 of file itkFloodFilledImageFunctionConditionalIterator.h.

FunctionType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::FunctionType = typename Superclass::FunctionType

Type of function

Definition at line 48 of file itkFloodFilledImageFunctionConditionalIterator.h.

ImageType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::ImageType = typename Superclass::ImageType

Image type alias support.

Definition at line 66 of file itkFloodFilledImageFunctionConditionalIterator.h.

IndexType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::IndexType = typename Superclass::IndexType

Index type alias support.

Definition at line 54 of file itkFloodFilledImageFunctionConditionalIterator.h.

InternalPixelType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::InternalPixelType = typename Superclass::InternalPixelType

Internal Pixel Type

Definition at line 69 of file itkFloodFilledImageFunctionConditionalIterator.h.

PixelType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::PixelType = typename Superclass::PixelType

External Pixel Type

Definition at line 72 of file itkFloodFilledImageFunctionConditionalIterator.h.

RegionType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::RegionType = typename Superclass::RegionType

Region type alias support

Definition at line 63 of file itkFloodFilledImageFunctionConditionalIterator.h.

SeedsContainerType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::SeedsContainerType = typename Superclass::SeedsContainerType

Index ContainerType.

Definition at line 57 of file itkFloodFilledImageFunctionConditionalIterator.h.

Self

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Self = FloodFilledImageFunctionConditionalIterator

Standard class type aliases.

Definition at line 44 of file itkFloodFilledImageFunctionConditionalIterator.h.

SizeType

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::SizeType = typename Superclass::SizeType

Size type alias support.

Definition at line 60 of file itkFloodFilledImageFunctionConditionalIterator.h.

Superclass

template<typename TImage , typename TFunction >

using itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Superclass = FloodFilledImageFunctionConditionalConstIterator<TImage, TFunction>

Definition at line 45 of file itkFloodFilledImageFunctionConditionalIterator.h.

Constructor & Destructor Documentation

FloodFilledImageFunctionConditionalIterator() [1/3]

template<typename TImage , typename TFunction >

itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::FloodFilledImageFunctionConditionalIterator ( 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 83 of file itkFloodFilledImageFunctionConditionalIterator.h.

FloodFilledImageFunctionConditionalIterator() [2/3]

template<typename TImage , typename TFunction >

itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::FloodFilledImageFunctionConditionalIterator ( 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 itkFloodFilledImageFunctionConditionalIterator.h.

FloodFilledImageFunctionConditionalIterator() [3/3]

template<typename TImage , typename TFunction >

itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::FloodFilledImageFunctionConditionalIterator ( 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 99 of file itkFloodFilledImageFunctionConditionalIterator.h.

~FloodFilledImageFunctionConditionalIterator()

template<typename TImage , typename TFunction >

itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::~FloodFilledImageFunctionConditionalIterator ( )

overridedefault

Default Destructor.

Member Function Documentation

Get()

template<typename TImage , typename TFunction >

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

inlineoverridevirtual

Get the pixel value

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

Definition at line 105 of file itkFloodFilledImageFunctionConditionalIterator.h.

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

Set()

template<typename TImage , typename TFunction >

void itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::Set ( const PixelType &  value )

inline

Set the pixel value

Definition at line 112 of file itkFloodFilledImageFunctionConditionalIterator.h.

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

Member Data Documentation

NDimensions

template<typename TImage , typename TFunction >

constexpr unsigned int itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >::NDimensions = Superclass::NDimensions

staticconstexpr

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.

Definition at line 78 of file itkFloodFilledImageFunctionConditionalIterator.h.

---

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

• itkFloodFilledImageFunctionConditionalIterator.h