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

#include <itkPathIterator.h>

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

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

Public Types
using	AccessorType = typename Superclass::AccessorType
using	ImageType = typename Superclass::ImageType
using	IndexType = typename Superclass::IndexType
using	InternalPixelType = typename Superclass::InternalPixelType
using	OffsetType = typename Superclass::OffsetType
using	PathInputType = typename Superclass::PathInputType
using	PathOutputType = typename Superclass::PathOutputType
using	PathType = typename Superclass::PathType
using	PixelContainer = typename Superclass::PixelContainer
using	PixelContainerPointer = typename Superclass::PixelContainerPointer
using	PixelType = typename Superclass::PixelType
using	Self = PathIterator
using	SizeType = typename Superclass::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
virtual const char *	GetNameOfClass () const
void	Set (const PixelType &value)
PixelType &	Value ()
Self &	operator= (const Self &it)
	PathIterator (ImageType *imagePtr, const PathType *pathPtr)
	~PathIterator () override=default
Public Member Functions inherited from itk::PathConstIterator< TImage, TPath >
const PixelType &	Get () const
const IndexType	GetIndex ()
const PathInputType	GetPathPosition ()
void	GoToBegin ()
bool	IsAtEnd () const
	itkTypeMacroNoParent (PathConstIterator)
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

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.

Member Typedef Documentation

AccessorType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::AccessorType = typename Superclass::AccessorType

Definition at line 93 of file itkPathIterator.h.

ImageType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::ImageType = typename Superclass::ImageType

Definition at line 88 of file itkPathIterator.h.

IndexType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::IndexType = typename Superclass::IndexType

Inherit types from the superclass

Definition at line 85 of file itkPathIterator.h.

InternalPixelType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 91 of file itkPathIterator.h.

OffsetType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::OffsetType = typename Superclass::OffsetType

Definition at line 86 of file itkPathIterator.h.

PathInputType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::PathInputType = typename Superclass::PathInputType

Definition at line 95 of file itkPathIterator.h.

PathOutputType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::PathOutputType = typename Superclass::PathOutputType

Definition at line 96 of file itkPathIterator.h.

PathType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::PathType = typename Superclass::PathType

Definition at line 94 of file itkPathIterator.h.

PixelContainer

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::PixelContainer = typename Superclass::PixelContainer

Definition at line 89 of file itkPathIterator.h.

PixelContainerPointer

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 90 of file itkPathIterator.h.

PixelType

template<typename TImage , typename TPath >

using itk::PathIterator< TImage, TPath >::PixelType = typename Superclass::PixelType

Definition at line 92 of file itkPathIterator.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::PathIterator< TImage, TPath >::SizeType = typename Superclass::SizeType

Definition at line 87 of file itkPathIterator.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

~PathIterator()

template<typename TImage , typename TPath >

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

overridedefault

Default Destructor.

Member Function Documentation

GetNameOfClass()

template<typename TImage , typename TPath >

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

virtual

Run-time type information (and related methods).

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.

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 >

constexpr 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