Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Attributes
itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction > Class Template Reference
Image Iterators

Iterates over a flood-filled spatial function. More...

#include <itkFloodFilledSpatialFunctionConditionalIterator.h>

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

List of all members.

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
FloodFilledSpatialFunctionConditionalIterator 		Self
typedef Superclass::SizeType SizeType
typedef
FloodFilledSpatialFunctionConditionalConstIterator
< TImage, TFunction > 		Superclass

Public Member Functions

 FloodFilledSpatialFunctionConditionalIterator (ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex)
 FloodFilledSpatialFunctionConditionalIterator (ImageType *imagePtr, FunctionType *fnPtr)
virtual ~FloodFilledSpatialFunctionConditionalIterator ()
void AddSeed (const IndexType seed)
void ClearSeeds ()
void DoFloodStep ()
void FindSeedPixel ()
void FindSeedPixels ()
const PixelType & Get (void) const
PixelType & Get (void)
virtual SmartPointer
< FunctionType > 		GetFunction () const
const IndexType GetIndex ()
void GoToBegin ()
void InitializeIterator ()
bool IsAtEnd ()
bool IsPixelIncluded (const IndexType &index) const
void operator++ ()
void Set (const PixelType &value)
void SetCenterInclusionStrategy ()
void SetCompleteInclusionStrategy ()
void SetIntersectInclusionStrategy ()
void SetOriginInclusionStrategy ()

Static Public Member Functions

static unsigned int GetIteratorDimension ()

Static Public Attributes

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

Protected Types

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

Protected Attributes

bool m_FoundUncheckedNeighbor
SmartPointer< FunctionType > m_Function
ImageType::ConstWeakPointer m_Image
ImageType::PointType m_ImageOrigin
RegionType m_ImageRegion
ImageType::SpacingType m_ImageSpacing
unsigned char m_InclusionStrategy
std::queue< IndexType > m_IndexStack
bool m_IsAtEnd
bool m_IsValidIndex
FunctionInputType m_LocationVector
RegionType m_Region
std::vector< IndexType > m_StartIndices
TTempImage::Pointer m_TemporaryPointer

Detailed Description

template<class TImage, class TFunction>
class itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >

Iterates over a flood-filled spatial function.

Definition at line 33 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

Member Typedef Documentation

template<class TImage, class TFunction>
typedef Superclass::FunctionInputType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::FunctionInputType

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

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

Definition at line 44 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::FunctionType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::FunctionType

Type of function

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

Definition at line 41 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::ImageType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::ImageType

Image typedef support.

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

Definition at line 56 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::IndexType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::IndexType

Index typedef support.

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

Definition at line 47 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::InternalPixelType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::InternalPixelType

Internal Pixel Type

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

Definition at line 59 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::PixelType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::PixelType

External Pixel Type

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

Definition at line 62 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::RegionType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::RegionType

Region typedef support

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

Definition at line 53 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef FloodFilledSpatialFunctionConditionalIterator itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Self

Standard class typedefs.

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

Definition at line 37 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef Superclass::SizeType itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::SizeType

Size typedef support.

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

Definition at line 50 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
typedef FloodFilledSpatialFunctionConditionalConstIterator<TImage, TFunction> itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Superclass

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

Definition at line 38 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage , class 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 209 of file itkFloodFilledFunctionConditionalConstIterator.h.

Constructor & Destructor Documentation

template<class TImage, class TFunction>
itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::FloodFilledSpatialFunctionConditionalIterator ( 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 67 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::FloodFilledSpatialFunctionConditionalIterator ( 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 74 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
virtual itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::~FloodFilledSpatialFunctionConditionalIterator ( )
inlinevirtual

Default Destructor.

Definition at line 90 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

Member Function Documentation

template<class TImage , class TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed ( const IndexType  seed)
inlineinherited

Put more seeds on the list

Definition at line 143 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds ( )
inlineinherited

Clear all the seeds

Definition at line 149 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep ( )
inherited

Definition at line 162 of file itkFloodFilledFunctionConditionalConstIterator.txx.

template<class TImage , class 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 108 of file itkFloodFilledFunctionConditionalConstIterator.txx.

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

Automatically find all seed pixels.

Definition at line 134 of file itkFloodFilledFunctionConditionalConstIterator.txx.

template<class TImage, class TFunction>
const PixelType& itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Get ( void  ) const
inlinevirtual

Get the pixel value, const version to avoid overload warnings

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

Definition at line 78 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage, class TFunction>
PixelType& itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Get ( void  )
inline

Get the pixel value, non-const version is sometimes useful.

Definition at line 82 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

template<class TImage , class TFunction >
virtual SmartPointer<FunctionType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction ( void  ) const
inlinevirtualinherited

Definition at line 194 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class 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 131 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

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

Get the dimension (size) of the index.

Reimplemented from itk::ConditionalConstIterator< TImage >.

Definition at line 124 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin ( void  )
inlineinherited

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Definition at line 156 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

template<class TImage , class TFunction >
void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator ( )
inherited

Initializes the iterator, called from constructor

Definition at line 72 of file itkFloodFilledFunctionConditionalConstIterator.txx.

template<class TImage , class TFunction >
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsAtEnd ( void  )
inlinevirtualinherited

Is the iterator at the end of the region?

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 139 of file itkFloodFilledFunctionConditionalConstIterator.h.

Referenced by itk::FlatStructuringElement< VDimension >::Ball(), itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::CreateStructuringElement(), and itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Update().

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

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

Implements itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >.

Definition at line 47 of file itkFloodFilledSpatialFunctionConditionalConstIterator.txx.

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

Walk forward one index

Implements itk::ConditionalConstIterator< TImage >.

Definition at line 189 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage, class TFunction>
void itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >::Set ( const PixelType &  value)
inline

Set the pixel value

Definition at line 86 of file itkFloodFilledSpatialFunctionConditionalIterator.h.

Referenced by itk::FlatStructuringElement< VDimension >::Ball(), and itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::CreateStructuringElement().

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

Set the inclusion strategy to center

Definition at line 86 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

Referenced by itk::FlatStructuringElement< VDimension >::Ball(), and itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::CreateStructuringElement().

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

Set the inclusion strategy to complete

Definition at line 89 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

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

Set the inclusion strategy to intersect

Definition at line 92 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

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

Set the inclusion strategy to origin

Definition at line 83 of file itkFloodFilledSpatialFunctionConditionalConstIterator.h.

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

Member Data Documentation

template<class TImage , class 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 232 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
SmartPointer<FunctionType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function
protectedinherited

Smart pointer to the function we're evaluating

Definition at line 202 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage >
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image
protectedinherited

Smart pointer to the source image.

Definition at line 104 of file itkConditionalConstIterator.h.

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

template<class TImage , class TFunction >
ImageType::PointType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin
protectedinherited

The origin of the source image

Definition at line 216 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
RegionType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageRegion
protectedinherited

Region of the source image

Definition at line 222 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
ImageType::SpacingType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing
protectedinherited

The spacing of the source image

Definition at line 219 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
unsigned char itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >::m_InclusionStrategy
protectedinherited

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

template<class TImage , class TFunction >
std::queue<IndexType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack
protectedinherited

Stack used to hold the path of the iterator through the image

Definition at line 225 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage >
bool itk::ConditionalConstIterator< TImage >::m_IsAtEnd
protectedinherited

Is the iterator at the end of its walk?

Definition at line 110 of file itkConditionalConstIterator.h.

template<class TImage , class TFunction >
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IsValidIndex
protectedinherited

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

Definition at line 235 of file itkFloodFilledFunctionConditionalConstIterator.h.

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

Location vector used in the flood algorithm

Definition at line 228 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage >
RegionType itk::ConditionalConstIterator< TImage >::m_Region
protectedinherited

Region type to iterate over.

Definition at line 107 of file itkConditionalConstIterator.h.

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

template<class TImage , class TFunction >
std::vector<IndexType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_StartIndices
protectedinherited

A list of locations to start the recursive fill

Definition at line 213 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class TImage , class TFunction >
TTempImage::Pointer itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TemporaryPointer
protectedinherited

Definition at line 210 of file itkFloodFilledFunctionConditionalConstIterator.h.

template<class 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 47 of file itkConditionalConstIterator.h.

template<class TImage , class TFunction >
const unsigned int itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::NDimensions = 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.

Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >.

Definition at line 74 of file itkFloodFilledFunctionConditionalConstIterator.h.

The documentation for this class was generated from the following file:
Generated at Sun Feb 3 2013 01:43:12 for Orfeo Toolbox with doxygen 1.8.1.1