Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::PathIterator< TImage, TPath > Class Template Reference
[Image IteratorsPath Representation Objects]

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

#include <itkPathIterator.h>

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

Inheritance graph
[legend]
Collaboration diagram for itk::PathIterator< TImage, TPath >:

Collaboration graph
[legend]

List of all members.

Public Types

typedef Superclass::AccessorType AccessorType
typedef Superclass::ImageType ImageType
typedef Superclass::IndexType IndexType
typedef Superclass::IndexValueType IndexValueType
typedef
Superclass::InternalPixelType 
InternalPixelType
typedef Superclass::OffsetType OffsetType
typedef Superclass::OffsetValueType OffsetValueType
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 TImage::PointType PointType
typedef Superclass::RegionType RegionType
typedef PathIterator Self
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef TImage::SpacingType SpacingType
typedef PathConstIterator
< TImage, TPath > 
Superclass

Public Member Functions

const PixelTypeGet (void) const
const IndexType GetIndex ()
virtual const char * GetNameOfClass () const
const PathInputType GetPathPosition ()
void GoToBegin ()
bool IsAtEnd ()
 itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
void operator++ ()
Selfoperator= (const Self &it)
 PathIterator (ImageType *imagePtr, const PathType *pathPtr)
PixelTypeValue (void)
virtual void VisitStartIndexAsLastIndexIfClosed (bool flag)
virtual ~PathIterator ()
void Set (const PixelType &value)

Static Public Member Functions

static unsigned int GetImageIteratorDimension ()

Protected Attributes

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


Detailed Description

template<class TImage, class 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 indicies 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 69 of file itkPathIterator.h.


Member Typedef Documentation

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

Accessor type that convert data between internal and external representations.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 99 of file itkPathIterator.h.

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

Image typedef support.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 94 of file itkPathIterator.h.

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

Inherit types from the superclass

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 87 of file itkPathIterator.h.

template<class TImage , class TPath >
typedef Superclass::IndexValueType itk::PathIterator< TImage, TPath >::IndexValueType

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 88 of file itkPathIterator.h.

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

Internal Pixel Type

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 97 of file itkPathIterator.h.

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

Offset typedef support.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 89 of file itkPathIterator.h.

template<class TImage , class TPath >
typedef Superclass::OffsetValueType itk::PathIterator< TImage, TPath >::OffsetValueType

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 90 of file itkPathIterator.h.

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

Path 1D Input Type

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 101 of file itkPathIterator.h.

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

Path ND Output Type, which is not necessarily an index type

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 102 of file itkPathIterator.h.

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

Path typedef support

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 100 of file itkPathIterator.h.

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

PixelContainer typedef support. Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 95 of file itkPathIterator.h.

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

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 96 of file itkPathIterator.h.

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

External Pixel Type

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 98 of file itkPathIterator.h.

typedef TImage ::PointType itk::PathConstIterator< TImage , TPath >::PointType [inherited]

Origin typedef support

Definition at line 106 of file itkPathConstIterator.h.

template<class TImage , class TPath >
typedef Superclass::RegionType itk::PathIterator< TImage, TPath >::RegionType

Region typedef support

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 93 of file itkPathIterator.h.

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

Standard class typedefs.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 74 of file itkPathIterator.h.

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

Size typedef support.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 91 of file itkPathIterator.h.

template<class TImage , class TPath >
typedef Superclass::SizeValueType itk::PathIterator< TImage, TPath >::SizeValueType

Reimplemented from itk::PathConstIterator< TImage, TPath >.

Definition at line 92 of file itkPathIterator.h.

typedef TImage ::SpacingType itk::PathConstIterator< TImage , TPath >::SpacingType [inherited]

Spacing typedef support

Definition at line 103 of file itkPathConstIterator.h.

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

Define the superclass

Definition at line 84 of file itkPathIterator.h.


Constructor & Destructor Documentation

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

Constructor establishes an iterator to walk along a path

template<class TImage , class TPath >
virtual itk::PathIterator< TImage, TPath >::~PathIterator (  )  [inline, virtual]

Default Destructor.

Definition at line 137 of file itkPathIterator.h.


Member Function Documentation

const PixelType& itk::PathConstIterator< TImage , TPath >::Get ( void   )  const [inline, inherited]

Get the pixel value

Definition at line 158 of file itkPathConstIterator.h.

static unsigned int itk::PathConstIterator< TImage , TPath >::GetImageIteratorDimension (  )  [inline, static, inherited]

Get the dimension (size) of the index.

Definition at line 140 of file itkPathConstIterator.h.

const IndexType itk::PathConstIterator< TImage , TPath >::GetIndex ( void   )  [inline, inherited]

Get the index. This provides a read only reference to the index.

Definition at line 152 of file itkPathConstIterator.h.

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

Run-time type information (and related methods).

Reimplemented from itk::PathConstIterator< TImage, TPath >.

const PathInputType itk::PathConstIterator< TImage , TPath >::GetPathPosition (  )  [inline, inherited]

Get the input. This provides a read only reference to the input.

Definition at line 146 of file itkPathConstIterator.h.

void itk::PathConstIterator< TImage , TPath >::GoToBegin ( void   )  [inherited]

Move an iterator to the beginning of the path. If the starting and ending indicies of the path are coincident, then move to the 2'nd index of the path, since the 1'st index will be visited later as the last index. However, if m_VisitStartIndexAsLastIndexIfClosed is false, then GoToBegin() will always move to the 1'st index.

bool itk::PathConstIterator< TImage , TPath >::IsAtEnd ( void   )  [inline, inherited]

Is the iterator at the end of the path? Note that for a closed path, it may be possible to increment back to the start of the path.

Definition at line 166 of file itkPathConstIterator.h.

template<class TImage , class TPath >
itk::PathIterator< TImage, TPath >::itkStaticConstMacro ( ImageIteratorDimension  ,
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.

Reimplemented from itk::PathConstIterator< TImage, TPath >.

void itk::PathConstIterator< TImage , TPath >::operator++ (  )  [inherited]

Walk forward along the path to the next index in the image.

template<class TImage , class 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<class TImage , class TPath >
void itk::PathIterator< TImage, TPath >::Set ( const PixelType value  )  [inline]

Set the pixel value

Definition at line 110 of file itkPathIterator.h.

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

virtual void itk::PathConstIterator< TImage , TPath >::VisitStartIndexAsLastIndexIfClosed ( bool  flag  )  [inline, virtual, inherited]

Should GoToBegin() initially skip the first index of a closed path so that the first index will only be visited once--at the end of the path? If set to false, then GoToBegin() will always move to the 1'st index. The constructor presets m_VisitStartIndexAsLastIndexIfClosed to true.

Definition at line 175 of file itkPathConstIterator.h.


Member Data Documentation

IndexType itk::PathConstIterator< TImage , TPath >::m_CurrentImageIndex [protected, inherited]

Current ND index position in the image of the path

Definition at line 235 of file itkPathConstIterator.h.

PathInputType itk::PathConstIterator< TImage , TPath >::m_CurrentPathPosition [protected, inherited]

Current 1D position along the path, such as time or arc length

Definition at line 232 of file itkPathConstIterator.h.

ImageType::ConstWeakPointer itk::PathConstIterator< TImage , TPath >::m_Image [protected, inherited]

Smart pointer to the source image.

Definition at line 205 of file itkPathConstIterator.h.

PointType itk::PathConstIterator< TImage , TPath >::m_ImageOrigin [protected, inherited]

The origin of the source image

Definition at line 214 of file itkPathConstIterator.h.

const SizeValueType* itk::PathConstIterator< TImage , TPath >::m_ImageSize [protected, inherited]

Size of the source image

Definition at line 220 of file itkPathConstIterator.h.

SpacingType itk::PathConstIterator< TImage , TPath >::m_ImageSpacing [protected, inherited]

The spacing of the source image

Definition at line 217 of file itkPathConstIterator.h.

bool itk::PathConstIterator< TImage , TPath >::m_IsAtEnd [protected, inherited]

Is the iterator at the end of its walk?

Definition at line 229 of file itkPathConstIterator.h.

PathType::ConstPointer itk::PathConstIterator< TImage , TPath >::m_Path [protected, inherited]

Smart pointer to the path we're following

Definition at line 208 of file itkPathConstIterator.h.

RegionType itk::PathConstIterator< TImage , TPath >::m_Region [protected, inherited]

Region type to iterate over.

Definition at line 211 of file itkPathConstIterator.h.

bool itk::PathConstIterator< TImage , TPath >::m_VisitStartIndexAsLastIndexIfClosed [protected, inherited]

Should GoToBegin() initially skip the first index of a closed path so that the first index will only be visited once--at the end of the path? If false, then GoToBegin() will always move to the 1'st index. The default value is true, which is set the constructor.

Definition at line 226 of file itkPathConstIterator.h.

OffsetType itk::PathConstIterator< TImage , TPath >::m_ZeroOffset [protected, inherited]

Definition at line 198 of file itkPathConstIterator.h.


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

Generated at Tue Sep 15 11:43:08 2009 for ITK by doxygen 1.5.8 written by Dimitri van Heesch, © 1997-2000