Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Attributes | List of all members
itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction > Class Template Reference

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

#include <itkFloodFilledImageFunctionConditionalConstIterator.h>

+ Inheritance diagram for itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >:
+ Collaboration diagram for itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >:

Public Types

typedef
Superclass::FunctionInputType 
FunctionInputType
 
typedef Superclass::FunctionType FunctionType
 
typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef
Superclass::SeedsContainerType 
SeedsContainerType
 
typedef
FloodFilledImageFunctionConditionalConstIterator 
Self
 
typedef Superclass::SizeType SizeType
 
typedef
FloodFilledFunctionConditionalConstIterator
< TImage, TFunction > 
Superclass
 

Public Member Functions

 FloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
 
 FloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, std::vector< IndexType > &startIndex)
 
 FloodFilledImageFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr)
 
virtual ~FloodFilledImageFunctionConditionalConstIterator ()
 
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 ()
 
virtual const SeedsContainerTypeGetSeeds () const
 
void GoToBegin ()
 
void InitializeIterator ()
 
bool IsAtEnd ()
 
bool IsPixelIncluded (const IndexType &index) const
 
void operator++ ()
 

Static Public Member Functions

static unsigned int GetIteratorDimension ()
 

Static Public Attributes

static const unsigned int NDimension = TImage::ImageDimension
 
static const unsigned int NDimensions = Superclass::NDimensions
 

Protected Types

typedef Image< unsigned char,
itkGetStaticConstMacro(NDimensions) > 
TTempImage
 

Protected Attributes

bool m_FoundUncheckedNeighbor
 
SmartPointer< FunctionTypem_Function
 
ImageType::ConstWeakPointer m_Image
 
ImageType::PointType m_ImageOrigin
 
RegionType m_ImageRegion
 
ImageType::SpacingType m_ImageSpacing
 
std::queue< IndexTypem_IndexStack
 
bool m_IsAtEnd
 
bool m_IsValidIndex
 
FunctionInputType m_LocationVector
 
RegionType m_Region
 
SeedsContainerType m_Seeds
 
TTempImage::Pointer m_TemporaryPointer
 

Detailed Description

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

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

Definition at line 35 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

Member Typedef Documentation

template<typename TImage , typename TFunction >
typedef Superclass::FunctionInputType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType

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

Definition at line 49 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::FunctionType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FunctionType

Type of function

Definition at line 46 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::ImageType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::ImageType

Image typedef support.

Definition at line 64 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::IndexType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::IndexType

Index typedef support.

Definition at line 52 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::InternalPixelType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType

Internal Pixel Type

Definition at line 67 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::PixelType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::PixelType

External Pixel Type

Definition at line 70 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::RegionType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::RegionType

Region typedef support

Definition at line 61 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::SeedsContainerType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::SeedsContainerType

Index ContainerType.

Definition at line 55 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef FloodFilledImageFunctionConditionalConstIterator itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::Self

Standard class typedefs.

Definition at line 41 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef Superclass::SizeType itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::SizeType

Size typedef support.

Definition at line 58 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
typedef FloodFilledFunctionConditionalConstIterator< TImage, TFunction > itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::Superclass
template<typename TImage , typename TFunction >
typedef Image< unsigned char, itkGetStaticConstMacro(NDimensions) > itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::TTempImage
protectedinherited

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 itkFloodFilledFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage , typename TFunction >
itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledImageFunctionConditionalConstIterator ( 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 81 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledImageFunctionConditionalConstIterator ( 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 91 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledImageFunctionConditionalConstIterator ( 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 101 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
virtual itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::~FloodFilledImageFunctionConditionalConstIterator ( )
inlinevirtual

Default Destructor.

Definition at line 106 of file itkFloodFilledImageFunctionConditionalConstIterator.h.

Member Function Documentation

template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed ( const IndexType seed)
inlineinherited
template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds ( )
inlineinherited
template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep ( )
inherited
template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< 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.

Definition at line 109 of file itkFloodFilledFunctionConditionalConstIterator.hxx.

template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixels ( )
inherited

Automatically find all seed pixels.

Definition at line 135 of file itkFloodFilledFunctionConditionalConstIterator.hxx.

template<typename TImage , typename TFunction >
const PixelType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Get ( void  ) const
inlinevirtualinherited
template<typename TImage , typename TFunction >
virtual SmartPointer< FunctionType > itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction ( void  ) const
inlinevirtualinherited
template<typename TImage , typename TFunction >
const IndexType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIndex ( void  )
inlinevirtualinherited

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 147 of file itkFloodFilledFunctionConditionalConstIterator.h.

References itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack.

Referenced by itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Update().

template<typename TImage , typename TFunction >
static unsigned int itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIteratorDimension ( void  )
inlinestaticinherited

Get the dimension (size) of the index.

Definition at line 140 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<typename TImage , typename TFunction >
virtual const SeedsContainerType& itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetSeeds ( ) const
inlinevirtualinherited
template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin ( void  )
inlineinherited
template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator ( )
inherited

Initializes the iterator, called from constructor

Definition at line 73 of file itkFloodFilledFunctionConditionalConstIterator.hxx.

template<typename TImage , typename TFunction >
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsAtEnd ( void  )
inlinevirtualinherited
template<typename TImage , typename TFunction >
bool itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::IsPixelIncluded ( const IndexType index) const
virtual

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

Implements itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Definition at line 28 of file itkFloodFilledImageFunctionConditionalConstIterator.hxx.

template<typename TImage , typename TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++ ( )
inlinevirtualinherited

Member Data Documentation

template<typename TImage , typename TFunction >
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FoundUncheckedNeighbor
protectedinherited

Indicates whether or not we've found a neighbor that needs to be checked.

Definition at line 253 of file itkFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=().

template<typename TImage , typename TFunction >
SmartPointer< FunctionType > itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function
protectedinherited
template<typename TImage >
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image
protectedinherited
template<typename TImage , typename TFunction >
ImageType::PointType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin
protectedinherited
template<typename TImage , typename TFunction >
RegionType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageRegion
protectedinherited
template<typename TImage , typename TFunction >
ImageType::SpacingType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing
protectedinherited
template<typename TImage , typename TFunction >
std::queue< IndexType > itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack
protectedinherited
template<typename TImage >
bool itk::ConditionalConstIterator< TImage >::m_IsAtEnd
protectedinherited
template<typename TImage , typename TFunction >
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IsValidIndex
protectedinherited

Indicates whether or not an index is valid (inside an image)/

Definition at line 256 of file itkFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=().

template<typename TImage , typename TFunction >
FunctionInputType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_LocationVector
protectedinherited

Location vector used in the flood algorithm

Definition at line 249 of file itkFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=().

template<typename TImage >
RegionType itk::ConditionalConstIterator< TImage >::m_Region
protectedinherited
template<typename TImage , typename TFunction >
SeedsContainerType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Seeds
protectedinherited
template<typename TImage , typename TFunction >
TTempImage::Pointer itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TemporaryPointer
protectedinherited
template<typename TImage >
const unsigned int itk::ConditionalConstIterator< TImage >::NDimension = TImage::ImageDimension
staticinherited

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.

Definition at line 48 of file itkConditionalConstIterator.h.

Referenced by itk::ConditionalConstIterator< TImage >::GetIteratorDimension().

template<typename TImage , typename TFunction >
const unsigned int itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >::NDimensions = Superclass::NDimensions
static

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 76 of file itkFloodFilledImageFunctionConditionalConstIterator.h.


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

Generated at Sat Mar 8 2014 17:02:02 for Orfeo Toolbox with doxygen 1.8.3.1