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

#include <itkShapedFloodFilledImageFunctionConditionalConstIterator.h>

Detailed Description

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

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

Contributed as a paper to the Insight Journal: https://doi.org/10.54294/iei8xt

Definition at line 38 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

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

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

Public Types
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	Self = ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
using	SizeType = typename TImage::SizeType
using	Superclass = ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
Public Types inherited from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
using	FunctionInputType = typename TFunction::InputType
using	FunctionType = TFunction
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	NeighborhoodIteratorType = typename itk::ShapedNeighborhoodIterator< ImageType >
using	OffsetType = typename TImage::OffsetType
using	PixelType = typename TImage::PixelType
using	RegionType = typename TImage::RegionType
using	SeedsContainerType = typename std::vector< IndexType >
using	Self = ShapedFloodFilledFunctionConditionalConstIterator
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
bool	IsPixelIncluded (const IndexType &index) const override
	ShapedFloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
	ShapedFloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	ShapedFloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
	~ShapedFloodFilledImageFunctionConditionalConstIterator () override=default
Public Member Functions inherited from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
void	AddSeed (const IndexType seed)
void	ClearSeeds ()
void	DoFloodStep ()
void	FindSeedPixel ()
void	FindSeedPixels ()
virtual void	FullyConnectedOn ()
const PixelType	Get () const override
bool	GetFullyConnected () const
virtual SmartPointer< FunctionType >	GetFunction () const
const IndexType	GetIndex () override
virtual const SeedsContainerType &	GetSeeds () const
void	GoToBegin ()
void	InitializeIterator ()
bool	IsAtEnd () const override
void	operator++ () override
Self &	operator= (const Self &it)
void	SetFullyConnected (const bool _arg)
	ShapedFloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
	ShapedFloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
	ShapedFloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
	~ShapedFloodFilledFunctionConditionalConstIterator () override=default
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::ShapedFloodFilledFunctionConditionalConstIterator< 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
static unsigned int	GetIteratorDimension ()
Static Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
static unsigned int	GetIteratorDimension ()
Protected Types inherited from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
using	TTempImage = Image< unsigned char, Self::NDimensions >
Protected Attributes inherited from itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
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 { false }
RegionType	m_Region {}

Member Typedef Documentation

FunctionInputType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType = typename TFunction::InputType

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

Definition at line 54 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

FunctionType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionType = TFunction

Type of function

Definition at line 51 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

ImageType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ImageType = TImage

Image type alias support

Definition at line 72 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

IndexType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 57 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

InternalPixelType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 75 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

PixelType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 78 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

RegionType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 69 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Self

template<typename TImage , typename TFunction >

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

Standard class type aliases.

Definition at line 44 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

SizeType

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 66 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.

Superclass

template<typename TImage , typename TFunction >

using itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::Superclass = ShapedFloodFilledFunctionConditionalConstIterator<TImage, TFunction>

Definition at line 45 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

ShapedFloodFilledImageFunctionConditionalConstIterator() [1/3]

template<typename TImage , typename 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.

ShapedFloodFilledImageFunctionConditionalConstIterator() [2/3]

template<typename TImage , typename 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 89 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

ShapedFloodFilledImageFunctionConditionalConstIterator() [3/3]

template<typename TImage , typename 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 98 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

~ShapedFloodFilledImageFunctionConditionalConstIterator()

template<typename TImage , typename TFunction >

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

overridedefault

Default Destructor.

Member Function Documentation

IsPixelIncluded()

template<typename TImage , typename TFunction >

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

overridevirtual

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

Implements itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Member Data Documentation

NDimensions

template<typename TImage , typename TFunction >

constexpr unsigned int itk::ShapedFloodFilledImageFunctionConditionalConstIterator< 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 75 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

---

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

• itkShapedFloodFilledImageFunctionConditionalConstIterator.h