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

itk::PathConstIterator< TImage, TPath > Class Template Reference
[Path Representation Objects, Image Iterators]

#include <itkPathConstIterator.h>

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

[legend]List of all members.

Detailed Description

template<class TImage, class TPath>
class itk::PathConstIterator< TImage, TPath >

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

This iterator visits only those indices of the image that are overlapped by a specified 1D 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. An exception to this rule is that if the path is closed, i.e. its starting and ending indicies are coincident. When starting and ending indicies are coincident, GoToBegin() will go to the second index, since the "first" index will be visited later as the "last" index. This is so that paths (especially parametric paths) can be properly closed, without double-visiting the starting/ending point. This behavior can be overridden by calling VisitStartIndexAsLastIndexIfClosed(false) before calling GoToBegin(). This class is the const version of the PathIterator, and for this reason it doesn't support the Set() method.

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

PathIterator

ShapedNeighborhoodIterator

SliceIterator

ImageConstIteratorWithIndex

Definition at line 73 of file itkPathConstIterator.h.

Public Types

typedef TImage::AccessorType AccessorType

typedef TImage ImageType

typedef TImage::IndexType IndexType

typedef TImage::IndexValueType IndexValueType

typedef TImage::InternalPixelType InternalPixelType

typedef TImage::OffsetType OffsetType

typedef TImage::OffsetValueType OffsetValueType

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::SizeValueType SizeValueType

typedef TImage::SpacingType SpacingType

Public Member Functions

const PixelType & Get (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++ ()

Self & operator= (const Self &it)

PathConstIterator (const ImageType *imagePtr, const PathType *pathPtr)

virtual void VisitStartIndexAsLastIndexIfClosed (bool flag)

virtual ~PathConstIterator ()

Static Public Member Functions

static unsigned int GetImageIteratorDimension ()

Protected Attributes

IndexType m_CurrentImageIndex

PathInputType m_CurrentPathPosition

ImageType::ConstWeakPointer m_Image

PointType m_ImageOrigin

const unsigned long int * m_ImageSize

SpacingType m_ImageSpacing

bool m_IsAtEnd

PathType::ConstPointer m_Path

RegionType m_Region

bool m_VisitStartIndexAsLastIndexIfClosed

OffsetType m_ZeroOffset