itk::LineIterator< TImage > Class Template Reference

#include <itkLineIterator.h>

Inheritance diagram for itk::LineIterator< TImage >:

Collaboration diagram for itk::LineIterator< TImage >:

Detailed Description

template<typename TImage>
class itk::LineIterator< TImage >

An iterator that walks a Bresenham line through an ND image with write access to pixels.

LineIterator is an iterator that walks a Bresenham line through an image. The iterator is constructed similar to other image iterators, except instead of specifying a region to traverse, you specify two indices. The interval specified by the two indices is closed. So, a line iterator specified with the same start and end index will visit exactly one pixel.

LineConstIterator<ImageType> it(image, I1, I2);
while (!it.IsAtEnd())
{
   // visits at least 1 pixel
}

Author

Benjamin King, Experimentelle Radiologie, Medizinische Hochschule Hannover.

See Also

LineConstIterator

Wiki Examples:

• All Examples
• Iterate over a line through an image

Examples:

WikiExamples/Iterators/LineIterator.cxx.

Definition at line 56 of file itkLineIterator.h.

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	PixelContainer = typename Superclass::PixelContainer
using	PixelContainerPointer = typename Superclass::PixelContainerPointer
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	Self = LineIterator
using	SizeType = typename Superclass::SizeType
using	Superclass = LineConstIterator< TImage >
Public Types inherited from itk::LineConstIterator< TImage >
using	AccessorType = typename TImage::AccessorType
using	ImageType = TImage
using	IndexType = typename TImage::IndexType
using	InternalPixelType = typename TImage::InternalPixelType
using	OffsetType = typename TImage::OffsetType
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 = LineConstIterator
using	SizeType = typename TImage::SizeType
using	SpacingType = typename TImage::SpacingType

Public Member Functions
virtual const char *	GetNameOfClass () const
	LineIterator (ImageType *imagePtr, const IndexType &firstIndex, const IndexType &lastIndex)
Self &	operator= (const Self &it)
const PixelType &	Value ()
	~LineIterator () override=default
void	Set (const PixelType &value)
Public Member Functions inherited from itk::LineConstIterator< TImage >
const PixelType	Get () const
const IndexType	GetIndex ()
void	GoToBegin ()
bool	IsAtEnd () const
	itkTypeMacroNoParent (LineConstIterator)
	LineConstIterator (const ImageType *imagePtr, const IndexType &firstIndex, const IndexType &lastIndex)
void	operator++ ()
Self &	operator= (const Self &it)
virtual	~LineConstIterator ()=default

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::LineConstIterator< TImage >
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension

Additional Inherited Members
Static Public Member Functions inherited from itk::LineConstIterator< TImage >
static unsigned int	GetImageIteratorDimension ()
Protected Attributes inherited from itk::LineConstIterator< TImage >
IndexType	m_AccumulateError
IndexType	m_CurrentImageIndex
IndexType	m_EndIndex
ImageType::ConstWeakPointer	m_Image
IndexType	m_IncrementError
bool	m_IsAtEnd
IndexType	m_LastIndex
unsigned int	m_MainDirection
IndexType	m_MaximalError
IndexType	m_OverflowIncrement
IndexType	m_ReduceErrorAfterIncrement
RegionType	m_Region
IndexType	m_StartIndex

Member Typedef Documentation

template<typename TImage>

using itk::LineIterator< TImage >::AccessorType = typename Superclass::AccessorType

Definition at line 82 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::ImageType = typename Superclass::ImageType

Definition at line 77 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::IndexType = typename Superclass::IndexType

Inherit types from the superclass

Definition at line 73 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::InternalPixelType = typename Superclass::InternalPixelType

Definition at line 80 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::OffsetType = typename Superclass::OffsetType

Definition at line 74 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::PixelContainer = typename Superclass::PixelContainer

Definition at line 78 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 79 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::PixelType = typename Superclass::PixelType

Definition at line 81 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::RegionType = typename Superclass::RegionType

Definition at line 76 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::Self = LineIterator

Standard class type aliases.

Definition at line 61 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::SizeType = typename Superclass::SizeType

Definition at line 75 of file itkLineIterator.h.

template<typename TImage>

using itk::LineIterator< TImage >::Superclass = LineConstIterator< TImage >

Define the superclass

Definition at line 70 of file itkLineIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

itk::LineIterator< TImage >::LineIterator	(	ImageType *	imagePtr,
		const IndexType &	firstIndex,
		const IndexType &	lastIndex
	)

Constructor establishes an iterator to walk along a path

template<typename TImage>

itk::LineIterator< TImage >::~LineIterator ( )

overridedefault

Default Destructor.

Member Function Documentation

template<typename TImage>

virtual const char* itk::LineIterator< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

template<typename TImage>

Self& itk::LineIterator< TImage >::operator=

(

const Self &

it

)

operator= is provided to make sure the handle to the image is properly reference counted.

template<typename TImage>

void itk::LineIterator< TImage >::Set ( const PixelType &  value )

inline

Set the pixel value

Definition at line 88 of file itkLineIterator.h.

template<typename TImage>

const PixelType& itk::LineIterator< TImage >::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 102 of file itkLineIterator.h.

Member Data Documentation

template<typename TImage>

constexpr unsigned int itk::LineIterator< TImage >::ImageIteratorDimension = TImage::ImageDimension

static

Dimension of the image that 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 67 of file itkLineIterator.h.

---

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

• itkLineIterator.h