itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction > Class Template Reference
[Image Iterators]
Iterates over a flood-filled spatial function.
More...
#include <itkShapedFloodFilledFunctionConditionalConstIterator.h>
Detailed Description
template<class TImage, class TFunction>
class itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >
Iterates over a flood-filled spatial function.
Contributed as a paper to the Insight Journal: http://hdl.handle.net/1926/1320
Definition at line 44 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
Member Typedef Documentation
| typedef TFunction::InputType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionInputType |
Type of vector used to store location info in the spatial function
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 56 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TFunction itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FunctionType |
Type of function
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 53 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ImageType |
Image typedef support.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 71 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::IndexType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IndexType |
Index typedef support.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 59 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::InternalPixelType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InternalPixelType |
Internal Pixel Type
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 74 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef itk::ShapedNeighborhoodIterator<ImageType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::NeighborhoodIteratorType |
Internal Neighborhood Iterator Type
Definition at line 80 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::OffsetType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::OffsetType |
Offset typedef support.
Definition at line 62 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::PixelType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::PixelType |
External Pixel Type
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 77 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::RegionType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::RegionType |
Region typedef support
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 68 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef ShapedFloodFilledFunctionConditionalConstIterator itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Self |
Standard class typedefs.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 50 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| typedef TImage::SizeType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SizeType |
Size typedef support.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >, itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >, and itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
Definition at line 65 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
typedef Image<unsigned char, itkGetStaticConstMacro(NDimensions)> itk::ShapedFloodFilledFunctionConditionalConstIterator< 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 230 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
Constructor & Destructor Documentation
| itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledFunctionConditionalConstIterator | ( | 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledFunctionConditionalConstIterator | ( | 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ShapedFloodFilledFunctionConditionalConstIterator | ( | 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::~ShapedFloodFilledFunctionConditionalConstIterator | ( | ) | [inline, virtual] |
Default Destructor.
Definition at line 121 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
Member Function Documentation
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::AddSeed | ( | const IndexType | seed | ) | [inline] |
Put more seeds on the list
Definition at line 155 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::ClearSeeds | ( | ) | [inline] |
Clear all the seeds
Definition at line 161 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::DoFloodStep | ( | ) |
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FindSeedPixels | ( | ) |
Automatically find all seed pixels.
| virtual void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FullyConnectedOff | ( | ) | [virtual] |
When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.
| virtual void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::FullyConnectedOn | ( | ) | [virtual] |
When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.
| const PixelType& itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::Get | ( | void | ) | const [inline, virtual] |
Get the pixel value
Implements itk::ConditionalConstIterator< TImage >.
Reimplemented in itk::ShapedFloodFilledImageFunctionConditionalIterator< TImage, TFunction >.
Definition at line 147 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFullyConnected | ( | ) | const |
When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.
| virtual SmartPointer<FunctionType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetFunction | ( | ) | const [inline, virtual] |
Definition at line 206 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| const IndexType itk::ShapedFloodFilledFunctionConditionalConstIterator< 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 143 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| static unsigned int itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::GetIteratorDimension | ( | ) | [inline, static] |
Get the dimension (size) of the index.
Reimplemented from itk::ConditionalConstIterator< TImage >.
Definition at line 136 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< 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 168 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::InitializeIterator | ( | ) |
Initializes the iterator, called from constructor
| bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::IsAtEnd | ( | void | ) | [inline, virtual] |
Is the iterator at the end of the region?
Implements itk::ConditionalConstIterator< TImage >.
Definition at line 151 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| virtual bool itk::ShapedFloodFilledFunctionConditionalConstIterator< 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 >.
Implemented in itk::ShapedFloodFilledImageFunctionConditionalConstIterator< TImage, TFunction >.
| 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::ShapedFloodFilledFunctionConditionalConstIterator< 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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator++ | ( | ) | [inline, virtual] |
Walk forward one index
Implements itk::ConditionalConstIterator< TImage >.
Definition at line 201 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| Self& itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::operator= | ( | const Self & | it | ) | [inline] |
operator= is provided to make sure the handle to the image is properly reference counted.
Definition at line 128 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
| void itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::SetFullyConnected | ( | const bool | _arg | ) |
When m_FullyConnected is set to true, the neighborhood iterator will inspect an 8 respectively 26 neighborhood. When the value is set to false, the neighborhood will be 4 in 2D and 6 in 3D.
Member Data Documentation
bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FoundUncheckedNeighbor [protected] |
Indicates whether or not we've found a neighbor that needs to be checked.
Definition at line 257 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
bool itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_FullyConnected [protected] |
Defines the connectivity of the neighborhood iterator. In case of 2D the default connectivity is 4 (6 in 3D) and when m_FullyConnected is set to true the connectivity is 8 (26 in 3D).
Definition at line 267 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
SmartPointer<FunctionType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_Function [protected] |
Smart pointer to the function we're evaluating
Definition at line 217 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
ImageType::ConstWeakPointer itk::ConditionalConstIterator< TImage >::m_Image [protected, inherited] |
Smart pointer to the source image.
Definition at line 104 of file itkConditionalConstIterator.h.
ImageType::PointType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageOrigin [protected] |
The origin of the source image
Definition at line 238 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
RegionType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageRegion [protected] |
Region of the source image
Definition at line 247 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
ImageType::SpacingType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_ImageSpacing [protected] |
The spacing of the source image
Definition at line 241 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
std::queue<IndexType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IndexStack [protected] |
Stack used to hold the path of the iterator through the image
Definition at line 250 of file itkShapedFloodFilledFunctionConditionalConstIterator.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::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_IsValidIndex [protected] |
Indicates whether or not an index is valid (inside an image)/
Definition at line 260 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
FunctionInputType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_LocationVector [protected] |
Location vector used in the flood algorithm
Definition at line 253 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
NeighborhoodIteratorType itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_NeighborhoodIterator [protected] |
The neighborhood iterator
Definition at line 244 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
RegionType itk::ConditionalConstIterator< TImage >::m_Region [protected, inherited] |
Region type to iterate over.
Definition at line 107 of file itkConditionalConstIterator.h.
std::vector<IndexType> itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_StartIndices [protected] |
A list of locations to start the recursive fill
Definition at line 235 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
TTempImage::Pointer itk::ShapedFloodFilledFunctionConditionalConstIterator< TImage, TFunction >::m_TempPtr [protected] |
Definition at line 232 of file itkShapedFloodFilledFunctionConditionalConstIterator.h.
The documentation for this class was generated from the following file:
