itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction > Class Template Reference
[Image Iterators]
#include <itkFloodFilledFunctionConditionalConstIterator.h>
Detailed Description
template<class TImage, class TFunction>
class itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >
Iterates over a flood-filled spatial function.
Definition at line 39 of file itkFloodFilledFunctionConditionalConstIterator.h.
Public Types | |
| typedef TFunction::InputType | FunctionInputType |
| typedef TFunction | FunctionType |
| typedef TImage | ImageType |
| typedef TImage::IndexType | IndexType |
| typedef TImage::InternalPixelType | InternalPixelType |
| typedef TImage::PixelType | PixelType |
| typedef TImage::RegionType | RegionType |
| typedef FloodFilledFunctionConditionalConstIterator | Self |
| typedef TImage::SizeType | SizeType |
Public Member Functions | |
| 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, std::vector< IndexType > &startIndices) | |
| FloodFilledFunctionConditionalConstIterator (const ImageType *imagePtr, FunctionType *fnPtr, IndexType startIndex) | |
| const PixelType & | Get (void) const |
| virtual SmartPointer < FunctionType > | GetFunction () const |
| const IndexType | GetIndex () |
| void | GoToBegin () |
| void | InitializeIterator () |
| bool | IsAtEnd () |
| virtual bool | IsPixelIncluded (const IndexType &index) const =0 |
| itkStaticConstMacro (NDimension, unsigned int, TImage::ImageDimension) | |
| itkStaticConstMacro (NDimensions, unsigned int, TImage::ImageDimension) | |
| void | operator++ () |
| Self & | operator= (const Self &it) |
| virtual | ~FloodFilledFunctionConditionalConstIterator () |
Static Public Member Functions | |
| static unsigned int | GetIteratorDimension () |
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 |
| 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 |
Member Typedef Documentation
| typedef TFunction::InputType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType |
Type of vector used to store location info in the spatial function
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 51 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TFunction itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionType |
Type of function
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 48 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ImageType |
Image typedef support.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 63 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::IndexType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType |
Index typedef support.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 54 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::InternalPixelType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 66 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::PixelType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::PixelType |
External Pixel Type
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 69 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::RegionType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::RegionType |
Region typedef support
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 60 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef FloodFilledFunctionConditionalConstIterator itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Self |
Standard class typedefs.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 45 of file itkFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::SizeType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SizeType |
Size typedef support.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, itk::FloodFilledSpatialFunctionConditionalConstIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 57 of file itkFloodFilledFunctionConditionalConstIterator.h.
typedef Image<unsigned char, itkGetStaticConstMacro(NDimensions)> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::TTempImage [protected] |
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 210 of file itkFloodFilledFunctionConditionalConstIterator.h.
Constructor & Destructor Documentation
| itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledFunctionConditionalConstIterator | ( | 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"
| itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledFunctionConditionalConstIterator | ( | const ImageType * | imagePtr, | |
| FunctionType * | fnPtr, | |||
| std::vector< IndexType > & | startIndices | |||
| ) |
Constructor establishes an iterator to walk a particular image and a particular region of that image. This version of the constructor uses a list of seed pixels for the flood fill
| itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FloodFilledFunctionConditionalConstIterator | ( | 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
| virtual itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::~FloodFilledFunctionConditionalConstIterator | ( | ) | [inline, virtual] |
Default Destructor.
Definition at line 110 of file itkFloodFilledFunctionConditionalConstIterator.h.
Member Function Documentation
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed | ( | const IndexType | seed | ) | [inline] |
Put more seeds on the list
Definition at line 144 of file itkFloodFilledFunctionConditionalConstIterator.h.
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds | ( | ) | [inline] |
Clear all the seeds
Definition at line 150 of file itkFloodFilledFunctionConditionalConstIterator.h.
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep | ( | ) |
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixel | ( | ) |
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.
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixels | ( | ) |
Automatically find all seed pixels.
| const PixelType& itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Get | ( | void | ) | const [inline, virtual] |
Get the pixel value
Implements itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::FloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::FloodFilledSpatialFunctionConditionalIterator< TImage, TFunction >.
Definition at line 136 of file itkFloodFilledFunctionConditionalConstIterator.h.
| virtual SmartPointer<FunctionType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction | ( | ) | const [inline, virtual] |
Definition at line 195 of file itkFloodFilledFunctionConditionalConstIterator.h.
| const IndexType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIndex | ( | void | ) | [inline, virtual] |
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 132 of file itkFloodFilledFunctionConditionalConstIterator.h.
| static unsigned int itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIteratorDimension | ( | ) | [inline, static] |
Get the dimension (size) of the index.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Definition at line 125 of file itkFloodFilledFunctionConditionalConstIterator.h.
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GoToBegin | ( | void | ) | [inline] |
Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.
Definition at line 157 of file itkFloodFilledFunctionConditionalConstIterator.h.
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator | ( | ) |
Initializes the iterator, called from constructor
| bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsAtEnd | ( | ) | [inline, virtual] |
Is the iterator at the end of the region?
Implements itk::ConditionalConstIterator< TImage >.
Definition at line 140 of file itkFloodFilledFunctionConditionalConstIterator.h.
| virtual bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsPixelIncluded | ( | const IndexType & | index | ) | const [pure virtual] |
Compute whether the index of interest should be included in the flood
Implements itk::ConditionalConstIterator< TImage >.
| itk::ConditionalConstIterator< TImage >::itkStaticConstMacro | ( | NDimension | , | |
| unsigned | int, | |||
| TImage::ImageDimension | ||||
| ) | [inherited] |
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.
| itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::itkStaticConstMacro | ( | NDimensions | , | |
| unsigned | int, | |||
| TImage::ImageDimension | ||||
| ) |
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.
| void itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++ | ( | ) | [inline, virtual] |
Walk forward one index
Implements itk::ConditionalConstIterator< TImage >.
Definition at line 190 of file itkFloodFilledFunctionConditionalConstIterator.h.
| Self& itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator= | ( | const Self & | it | ) | [inline] |
operator= is provided to make sure the handle to the image is properly reference counted.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Definition at line 117 of file itkFloodFilledFunctionConditionalConstIterator.h.
References itk::ConditionalConstIterator< TImage >::m_Image, and itk::ConditionalConstIterator< TImage >::m_Region.
Member Data Documentation
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FoundUncheckedNeighbor [protected] |
Indicates whether or not we've found a neighbor that needs to be checked.
Definition at line 233 of file itkFloodFilledFunctionConditionalConstIterator.h.
SmartPointer<FunctionType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function [protected] |
Smart pointer to the function we're evaluating
Definition at line 203 of file itkFloodFilledFunctionConditionalConstIterator.h.
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image [protected, inherited] |
Smart pointer to the source image.
Definition at line 104 of file itkConditionalConstIterator.h.
Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), and itk::ConditionalConstIterator< TImage >::operator=().
ImageType::PointType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin [protected] |
The origin of the source image
Definition at line 217 of file itkFloodFilledFunctionConditionalConstIterator.h.
RegionType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageRegion [protected] |
Region of the source image
Definition at line 223 of file itkFloodFilledFunctionConditionalConstIterator.h.
ImageType::SpacingType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing [protected] |
The spacing of the source image
Definition at line 220 of file itkFloodFilledFunctionConditionalConstIterator.h.
std::queue<IndexType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack [protected] |
Stack used to hold the path of the iterator through the image
Definition at line 226 of file itkFloodFilledFunctionConditionalConstIterator.h.
bool itk::ConditionalConstIterator< TImage >::m_IsAtEnd [protected, inherited] |
Is the iterator at the end of its walk?
Definition at line 110 of file itkConditionalConstIterator.h.
bool itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IsValidIndex [protected] |
Indicates whether or not an index is valid (inside an image)/
Definition at line 236 of file itkFloodFilledFunctionConditionalConstIterator.h.
FunctionInputType itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_LocationVector [protected] |
Location vector used in the flood algorithm
Definition at line 229 of file itkFloodFilledFunctionConditionalConstIterator.h.
RegionType itk::ConditionalConstIterator< TImage >::m_Region [protected, inherited] |
Region type to iterate over.
Definition at line 107 of file itkConditionalConstIterator.h.
Referenced by itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=(), itk::ConditionalConstIterator< TImage >::operator=(), and itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator=().
std::vector<IndexType> itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_StartIndices [protected] |
A list of locations to start the recursive fill
Definition at line 214 of file itkFloodFilledFunctionConditionalConstIterator.h.
TTempImage::Pointer itk::FloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TemporaryPointer [protected] |
Definition at line 211 of file itkFloodFilledFunctionConditionalConstIterator.h.
The documentation for this class was generated from the following file:
