ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction > Class Template Reference

#include <itkShapedFloodFilledImageFunctionConditionalConstIterator.h>

+ Inheritance diagram for itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >:
+ Collaboration diagram for itk::ShapedFloodFilledImageFunctionConditionalConstIterator< 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 Self = ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >
 
using SizeType = typename Superclass::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 FullyConnectedOff ()
 
virtual void FullyConnectedOn ()
 
const PixelType Get () const override
 
bool GetFullyConnected () const
 
virtual SmartPointer< FunctionTypeGetFunction () const
 
const IndexType GetIndex () override
 
virtual const SeedsContainerTypeGetSeeds () const
 
void GoToBegin ()
 
void InitializeIterator ()
 
bool IsAtEnd () const override
 
void operator++ () override
 
Selfoperator= (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 > &startIndices)
 
 ~ShapedFloodFilledFunctionConditionalConstIterator () override=default
 
- Public Member Functions inherited from itk::ConditionalConstIterator< TImage >
 ConditionalConstIterator ()=default
 
Selfoperator= (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< FunctionTypem_Function
 
ImageType::PointType m_ImageOrigin
 
RegionType m_ImageRegion
 
ImageType::SpacingType m_ImageSpacing
 
std::queue< IndexTypem_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
 

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://hdl.handle.net/1926/1320

Definition at line 38 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

Member Typedef Documentation

◆ FunctionInputType

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

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

Definition at line 51 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ FunctionType

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

Type of function

Definition at line 48 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ ImageType

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

Image type alias support

Definition at line 63 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ IndexType

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

Index type alias support

Definition at line 54 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ InternalPixelType

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

Internal Pixel Type

Definition at line 66 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ PixelType

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

External Pixel Type

Definition at line 69 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ RegionType

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

Region type alias support

Definition at line 60 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.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::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::SizeType = typename Superclass::SizeType

Size type alias support

Definition at line 57 of file itkShapedFloodFilledImageFunctionConditionalConstIterator.h.

◆ Superclass

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

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: