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 PathIterator Self
typedef PathConstIterator<
TImage, TPath > 
Superclass
typedef Superclass::IndexType IndexType
typedef Superclass::IndexValueType IndexValueType
typedef Superclass::OffsetType OffsetType
typedef Superclass::OffsetValueType OffsetValueType
typedef Superclass::SizeType SizeType
typedef Superclass::SizeValueType SizeValueType
typedef Superclass::RegionType RegionType
typedef Superclass::ImageType ImageType
typedef Superclass::PixelContainer PixelContainer
typedef Superclass::PixelContainerPointer PixelContainerPointer
typedef Superclass::InternalPixelType InternalPixelType
typedef Superclass::PixelType PixelType
typedef Superclass::AccessorType AccessorType
typedef Superclass::PathType PathType
typedef Superclass::PathInputType PathInputType
typedef Superclass::PathOutputType PathOutputType

Public Member Functions

 itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
virtual const char * GetClassName () const
PixelTypeValue (void)
Selfoperator= (const Self &it)
 PathIterator (ImageType *imagePtr, const PathType *pathPtr)
virtual ~PathIterator ()
void Set (const PixelType &value)

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.

Definition at line 41 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 71 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 66 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 59 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 60 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 69 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 61 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 62 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 73 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 74 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 72 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 67 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 68 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 70 of file itkPathIterator.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 65 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 46 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 63 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 64 of file itkPathIterator.h.

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

Define the superclass Definition at line 56 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 109 of file itkPathIterator.h.


Member Function Documentation

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

Run-time type information (and related methods).

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

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 >.

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.

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

template<class TImage, class TPath>
void itk::PathIterator< TImage, TPath >::Set const PixelType value  )  [inline]
 

Set the pixel value Definition at line 82 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 96 of file itkPathIterator.h.


The documentation for this class was generated from the following file:
Generated at Sat Mar 31 02:59:01 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000