ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::PathIterator< TImage, TPath > Class Template Reference

#include <itkPathIterator.h>

+ Inheritance diagram for itk::PathIterator< TImage, TPath >:
+ Collaboration diagram for itk::PathIterator< TImage, TPath >:

Detailed Description

template<typename TImage, typename TPath>
class itk::PathIterator< TImage, TPath >

PathIterator iterates (traces) over a path through an image.

This iterator visits only those indices of the image which are overlapped by the path. All indices are visited in path order. If a path crosses itself at an index, that index of the image will be visited twice. This class add write-access to the functionality of the PathConstIterator.

MORE INFORMATION
For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from http://www.itk.org.
See Also
ImageConstIterator
ConditionalConstIterator
ConstNeighborhoodIterator
ConstShapedNeighborhoodIterator
ConstSliceIterator
CorrespondenceDataStructureIterator
FloodFilledFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalConstIterator
FloodFilledImageFunctionConditionalIterator
FloodFilledSpatialFunctionConditionalConstIterator
FloodFilledSpatialFunctionConditionalIterator
ImageConstIterator
ImageConstIteratorWithIndex
ImageIterator
ImageIteratorWithIndex
ImageLinearConstIteratorWithIndex
ImageLinearIteratorWithIndex
ImageRandomConstIteratorWithIndex
ImageRandomIteratorWithIndex
ImageRegionConstIterator
ImageRegionConstIteratorWithIndex
ImageRegionExclusionConstIteratorWithIndex
ImageRegionExclusionIteratorWithIndex
ImageRegionIterator
ImageRegionIteratorWithIndex
ImageRegionReverseConstIterator
ImageRegionReverseIterator
ImageReverseConstIterator
ImageReverseIterator
ImageSliceConstIteratorWithIndex
ImageSliceIteratorWithIndex
NeighborhoodIterator
PathConstIterator
ShapedNeighborhoodIterator
SliceIterator
ImageConstIteratorWithIndex

Definition at line 68 of file itkPathIterator.h.

Public Types

typedef Superclass::AccessorType AccessorType
 
typedef Superclass::ImageType ImageType
 
typedef Superclass::IndexType IndexType
 
typedef
Superclass::InternalPixelType 
InternalPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::PathInputType PathInputType
 
typedef Superclass::PathOutputType PathOutputType
 
typedef Superclass::PathType PathType
 
typedef Superclass::PixelContainer PixelContainer
 
typedef
Superclass::PixelContainerPointer 
PixelContainerPointer
 
typedef Superclass::PixelType PixelType
 
typedef PathIterator Self
 
typedef Superclass::SizeType SizeType
 
typedef PathConstIterator
< TImage, TPath > 
Superclass
 
- Public Types inherited from itk::PathConstIterator< TImage, TPath >
typedef TImage::AccessorType AccessorType
 
typedef TImage ImageType
 
typedef TImage::IndexType IndexType
 
typedef TImage::InternalPixelType InternalPixelType
 
typedef TImage::OffsetType OffsetType
 
typedef PathType::InputType PathInputType
 
typedef PathType::OutputType PathOutputType
 
typedef TPath PathType
 
typedef TImage::PixelContainer PixelContainer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef TImage::PixelType PixelType
 
typedef TImage::PointType PointType
 
typedef TImage::RegionType RegionType
 
typedef PathConstIterator Self
 
typedef TImage::SizeType SizeType
 
typedef TImage::SpacingType SpacingType
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
Selfoperator= (const Self &it)
 
 PathIterator (ImageType *imagePtr, const PathType *pathPtr)
 
PixelTypeValue (void)
 
virtual ~PathIterator ()
 
void Set (const PixelType &value)
 
- Public Member Functions inherited from itk::PathConstIterator< TImage, TPath >
const PixelTypeGet (void) const
 
const IndexType GetIndex ()
 
const PathInputType GetPathPosition ()
 
void GoToBegin ()
 
bool IsAtEnd ()
 
 itkTypeMacroNoParent (PathConstIterator)
 
void operator++ ()
 
Selfoperator= (const Self &it)
 
 PathConstIterator (const ImageType *imagePtr, const PathType *pathPtr)
 
virtual void VisitStartIndexAsLastIndexIfClosed (bool flag)
 
virtual ~PathConstIterator ()
 

Static Public Attributes

static const unsigned int ImageIteratorDimension = TImage::ImageDimension
 
- Static Public Attributes inherited from itk::PathConstIterator< TImage, TPath >
static const unsigned int ImageIteratorDimension = TImage::ImageDimension
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::PathConstIterator< TImage, TPath >
static unsigned int GetImageIteratorDimension ()
 
- Protected Attributes inherited from itk::PathConstIterator< TImage, TPath >
IndexType m_CurrentImageIndex
 
PathInputType m_CurrentPathPosition
 
ImageType::ConstWeakPointer m_Image
 
PointType m_ImageOrigin
 
const SizeValueTypem_ImageSize
 
SpacingType m_ImageSpacing
 
bool m_IsAtEnd
 
PathType::ConstPointer m_Path
 
RegionType m_Region
 
bool m_VisitStartIndexAsLastIndexIfClosed
 
OffsetType m_ZeroOffset
 

Member Typedef Documentation

template<typename TImage , typename TPath >
typedef Superclass::AccessorType itk::PathIterator< TImage, TPath >::AccessorType

Definition at line 94 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::ImageType itk::PathIterator< TImage, TPath >::ImageType

Definition at line 89 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::IndexType itk::PathIterator< TImage, TPath >::IndexType

Inherit types from the superclass

Definition at line 86 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::InternalPixelType itk::PathIterator< TImage, TPath >::InternalPixelType

Definition at line 92 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::OffsetType itk::PathIterator< TImage, TPath >::OffsetType

Definition at line 87 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::PathInputType itk::PathIterator< TImage, TPath >::PathInputType

Definition at line 96 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::PathOutputType itk::PathIterator< TImage, TPath >::PathOutputType

Definition at line 97 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::PathType itk::PathIterator< TImage, TPath >::PathType

Definition at line 95 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::PixelContainer itk::PathIterator< TImage, TPath >::PixelContainer

Definition at line 90 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::PixelContainerPointer itk::PathIterator< TImage, TPath >::PixelContainerPointer

Definition at line 91 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::PixelType itk::PathIterator< TImage, TPath >::PixelType

Definition at line 93 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef PathIterator itk::PathIterator< TImage, TPath >::Self

Standard class typedefs.

Definition at line 73 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef Superclass::SizeType itk::PathIterator< TImage, TPath >::SizeType

Definition at line 88 of file itkPathIterator.h.

template<typename TImage , typename TPath >
typedef PathConstIterator< TImage, TPath > itk::PathIterator< TImage, TPath >::Superclass

Define the superclass

Definition at line 83 of file itkPathIterator.h.

Constructor & Destructor Documentation

template<typename TImage , typename TPath >
itk::PathIterator< TImage, TPath >::PathIterator ( ImageType imagePtr,
const PathType pathPtr 
)

Constructor establishes an iterator to walk along a path

template<typename TImage , typename TPath >
virtual itk::PathIterator< TImage, TPath >::~PathIterator ( )
inlinevirtual

Default Destructor.

Definition at line 130 of file itkPathIterator.h.

Member Function Documentation

template<typename TImage , typename TPath >
virtual const char* itk::PathIterator< TImage, TPath >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

template<typename TImage , typename TPath >
Self& itk::PathIterator< TImage, TPath >::operator= ( const Self it)

operator= is provided to make sure the handles to the image and path are properly reference counted.

template<typename TImage , typename TPath >
void itk::PathIterator< TImage, TPath >::Set ( const PixelType value)
inline
template<typename TImage , typename TPath >
PixelType& itk::PathIterator< TImage, TPath >::Value ( void  )
inline

Return a reference to the pixel This method will provide the fastest access to pixel data, but it will NOT support ImageAdaptors.

Definition at line 117 of file itkPathIterator.h.

Member Data Documentation

template<typename TImage , typename TPath >
const unsigned int itk::PathIterator< TImage, TPath >::ImageIteratorDimension = TImage::ImageDimension
static

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 80 of file itkPathIterator.h.


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