itk::PathIterator< TImage, TPath > Class Template Reference

#include <itkPathIterator.h>

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 https://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.

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

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

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

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

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::PathConstIterator< TImage, TPath >
static constexpr 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 SizeValueType *	m_ImageSize {}
SpacingType	m_ImageSpacing {}
bool	m_IsAtEnd {}
PathType::ConstPointer	m_Path {}
RegionType	m_Region {}
bool	m_VisitStartIndexAsLastIndexIfClosed {}
OffsetType	m_ZeroOffset {}

Member Typedef Documentation

AccessorType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 123 of file itkPathConstIterator.h.

ImageType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::ImageType

Image type alias support

Definition at line 107 of file itkPathConstIterator.h.

IndexType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::IndexType

Index type alias support

Definition at line 89 of file itkPathConstIterator.h.

InternalPixelType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::InternalPixelType

Internal Pixel Type

Definition at line 116 of file itkPathConstIterator.h.

OffsetType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::OffsetType

Offset type alias support

Definition at line 92 of file itkPathConstIterator.h.

PathInputType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::PathInputType

Path 1D Input Type

Definition at line 129 of file itkPathConstIterator.h.

PathOutputType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::PathOutputType

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

Definition at line 132 of file itkPathConstIterator.h.

PathType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::PathType

Path type alias support

Definition at line 126 of file itkPathConstIterator.h.

PixelContainer

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::PixelContainer

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

Definition at line 112 of file itkPathConstIterator.h.

PixelContainerPointer

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::PixelContainerPointer

Definition at line 113 of file itkPathConstIterator.h.

PixelType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::PixelType

External Pixel Type

Definition at line 119 of file itkPathConstIterator.h.

Self

template<typename TImage, typename TPath>

using itk::PathIterator< TImage, TPath >::Self = PathIterator

Standard class type aliases.

Definition at line 73 of file itkPathIterator.h.

SizeType

template<typename TImage, typename TPath>

using itk::PathConstIterator< TImage, TPath >::SizeType

Size type alias support

Definition at line 95 of file itkPathConstIterator.h.

Superclass

template<typename TImage, typename TPath>

using itk::PathIterator< TImage, TPath >::Superclass = PathConstIterator<TImage, TPath>

Define the superclass

Definition at line 82 of file itkPathIterator.h.

Constructor & Destructor Documentation

PathIterator()

template<typename TImage, typename TPath>

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

Constructor establishes an iterator to walk along a path

Referenced by GetNameOfClass().

~PathIterator()

template<typename TImage, typename TPath>

itk::PathIterator< TImage, TPath >::~PathIterator ( )

overridedefault

Default Destructor.

Member Function Documentation

GetNameOfClass()

template<typename TImage, typename TPath>

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

overridevirtual

See also

LightObject::GetNameOfClass()

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

References PathIterator().

operator=()

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.

Set()

template<typename TImage, typename TPath>

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

inline

Set the pixel value

Definition at line 103 of file itkPathIterator.h.

References itk::PathConstIterator< TImage, TPath >::m_CurrentImageIndex, and itk::PathConstIterator< TImage, TPath >::m_Image.

Value()

template<typename TImage, typename TPath>

PixelType & itk::PathIterator< TImage, TPath >::Value ( )

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

ImageIteratorDimension

template<typename TImage, typename TPath>

unsigned int itk::PathIterator< TImage, TPath >::ImageIteratorDimension = TImage::ImageDimension

staticconstexpr

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

---

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

• itkPathIterator.h