#include <itkFloodFilledSpatialFunctionConditionalConstIterator.h>

Detailed Description

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

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

Definition at line 35 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

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

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

Public Types
using	FunctionInputType

using	FunctionType

using	ImageType

using	IndexType

using	InternalPixelType

using	PixelType

using	RegionType

using	SeedsContainerType

using	Self = FloodFilledSpatialFunctionConditionalConstIterator

using	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
	FloodFilledSpatialFunctionConditionalConstIterator (const ImageType imagePtr, FunctionType fnPtr)

	FloodFilledSpatialFunctionConditionalConstIterator (const ImageType imagePtr, FunctionType fnPtr, IndexType startIndex)

bool	IsPixelIncluded (const IndexType &index) const override

void	SetCenterInclusionStrategy ()

void	SetCompleteInclusionStrategy ()

void	SetIntersectInclusionStrategy ()

void	SetOriginInclusionStrategy ()

	~FloodFilledSpatialFunctionConditionalConstIterator () override=default

Public Member Functions inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
void	AddSeed (const IndexType &seed)

void	ClearSeeds ()

void	DoFloodStep ()

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)

const PixelType	Get () const override

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)

	~FloodFilledFunctionConditionalConstIterator () override=default

Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
	ConditionalConstIterator ()=default

Self &	operator= (const Self &it)=default

virtual	~ConditionalConstIterator ()=default

Protected Attributes
unsigned char	m_InclusionStrategy {}

Protected Attributes inherited from itk::FloodFilledFunctionConditionalConstIterator< 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 {}

SeedsContainerType	m_Seeds {}

TTempImage::Pointer	m_TemporaryPointer {}

Protected Attributes inherited from itk::ConditionalConstIterator< TImage >
ImageType::ConstWeakPointer	m_Image {}

bool	m_IsAtEnd { false }

RegionType	m_Region {}

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 ()

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

Protected Types inherited from itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
using	TTempImage = Image<unsigned char, Self::NDimensions>

Member Typedef Documentation

◆ FunctionInputType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType

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

Definition at line 49 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ FunctionType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionType

Type of function

Definition at line 46 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ ImageType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ImageType

Image type alias support.

Definition at line 64 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ IndexType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType

Index type alias support.

Definition at line 52 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ InternalPixelType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType

Internal Pixel Type

Definition at line 67 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ PixelType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::PixelType

External Pixel Type

Definition at line 70 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ RegionType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::RegionType

Region type alias support

Definition at line 61 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ SeedsContainerType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SeedsContainerType

Index ContainerType

Definition at line 55 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ Self

template<typename TImage, typename TFunction>

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

Standard class type aliases.

Definition at line 40 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

◆ SizeType

template<typename TImage, typename TFunction>

using itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SizeType

Size type alias support.

Definition at line 58 of file itkFloodFilledFunctionConditionalConstIterator.h.

◆ Superclass

template<typename TImage, typename TFunction>

using itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::Superclass = FloodFilledFunctionConditionalConstIterator<TImage, TFunction>

Definition at line 41 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

◆ FloodFilledSpatialFunctionConditionalConstIterator() [1/2]

template<typename TImage, typename TFunction>

itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledSpatialFunctionConditionalConstIterator	(	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"

◆ FloodFilledSpatialFunctionConditionalConstIterator() [2/2]

template<typename TImage, typename TFunction>

itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledSpatialFunctionConditionalConstIterator	(	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.

◆ ~FloodFilledSpatialFunctionConditionalConstIterator()

template<typename TImage, typename TFunction>

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

overridedefault

Default Destructor.

Member Function Documentation

◆ IsPixelIncluded()

template<typename TImage, typename TFunction>

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

overridevirtual

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

Implements itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

◆ SetCenterInclusionStrategy()

template<typename TImage, typename TFunction>

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::SetCenterInclusionStrategy ( )

inline

Set the inclusion strategy to center

Definition at line 97 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

References m_InclusionStrategy.

◆ SetCompleteInclusionStrategy()

template<typename TImage, typename TFunction>

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::SetCompleteInclusionStrategy ( )

inline

Set the inclusion strategy to complete

Definition at line 104 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

References m_InclusionStrategy.

◆ SetIntersectInclusionStrategy()

template<typename TImage, typename TFunction>

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::SetIntersectInclusionStrategy ( )

inline

Set the inclusion strategy to intersect

Definition at line 111 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

References m_InclusionStrategy.

◆ SetOriginInclusionStrategy()

template<typename TImage, typename TFunction>

void itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::SetOriginInclusionStrategy ( )

inline

Set the inclusion strategy to origin

Definition at line 90 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

References m_InclusionStrategy.

Member Data Documentation

◆ m_InclusionStrategy

template<typename TImage, typename TFunction>

unsigned char itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::m_InclusionStrategy {}

protected

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 128 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

Referenced by SetCenterInclusionStrategy(), SetCompleteInclusionStrategy(), SetIntersectInclusionStrategy(), and SetOriginInclusionStrategy().

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

itkFloodFilledSpatialFunctionConditionalConstIterator.h

Detailed Description

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ FunctionInputType

◆ FunctionType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ PixelType

◆ RegionType

◆ SeedsContainerType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ FloodFilledSpatialFunctionConditionalConstIterator() [1/2]

◆ FloodFilledSpatialFunctionConditionalConstIterator() [2/2]

◆ ~FloodFilledSpatialFunctionConditionalConstIterator()

Member Function Documentation

◆ IsPixelIncluded()

◆ SetCenterInclusionStrategy()

◆ SetCompleteInclusionStrategy()

◆ SetIntersectInclusionStrategy()

◆ SetOriginInclusionStrategy()

Member Data Documentation

◆ m_InclusionStrategy