itk::LineConstIterator< TImage > Class Template Reference

#include <itkLineConstIterator.h>

Inheritance diagram for itk::LineConstIterator< TImage >:

Detailed Description

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

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

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

Wiki Examples:

• All Examples
• Iterate over a line through an image without write access

Examples:

WikiExamples/Iterators/LineConstIterator.cxx.

Definition at line 56 of file itkLineConstIterator.h.

Public Types
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
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 Member Functions
static unsigned int	GetImageIteratorDimension ()

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = TImage::ImageDimension

Protected Attributes
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::LineConstIterator< TImage >::AccessorType = typename TImage::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 104 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::ImageType = TImage

Image type alias support

Definition at line 88 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::IndexType = typename TImage::IndexType

Index type alias support

Definition at line 70 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::InternalPixelType = typename TImage::InternalPixelType

Internal Pixel Type

Definition at line 97 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::OffsetType = typename TImage::OffsetType

Offset type alias support

Definition at line 73 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::PixelContainer = typename TImage::PixelContainer

PixelContainer type alias 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.

Definition at line 93 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 94 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::PixelType = typename TImage::PixelType

External Pixel Type

Definition at line 100 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::PointType = typename TImage::PointType

Origin type alias support

Definition at line 85 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::RegionType = typename TImage::RegionType

Region type alias support

Definition at line 79 of file itkLineConstIterator.h.

template<typename TImage>

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

Standard class type aliases.

Definition at line 61 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::SizeType = typename TImage::SizeType

Size type alias support

Definition at line 76 of file itkLineConstIterator.h.

template<typename TImage>

using itk::LineConstIterator< TImage >::SpacingType = typename TImage::SpacingType

Spacing type alias support

Definition at line 82 of file itkLineConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

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

Constructor establishes an iterator to walk along a line

template<typename TImage>

virtual itk::LineConstIterator< TImage >::~LineConstIterator ( )

virtualdefault

Default Destructor.

Member Function Documentation

template<typename TImage>

const PixelType itk::LineConstIterator< TImage >::Get ( ) const

inline

Get the pixel value

Definition at line 122 of file itkLineConstIterator.h.

template<typename TImage>

static unsigned int itk::LineConstIterator< TImage >::GetImageIteratorDimension ( )

inlinestatic

Get the dimension (size) of the index.

Definition at line 110 of file itkLineConstIterator.h.

template<typename TImage>

const IndexType itk::LineConstIterator< TImage >::GetIndex ( )

inline

Get the index. This provides a read only reference to the index.

Definition at line 116 of file itkLineConstIterator.h.

template<typename TImage>

void itk::LineConstIterator< TImage >::GoToBegin

(

)

Move an iterator to the beginning of the line.

template<typename TImage>

bool itk::LineConstIterator< TImage >::IsAtEnd ( ) const

inline

Is the iterator at the end of the line?

Definition at line 128 of file itkLineConstIterator.h.

template<typename TImage>

itk::LineConstIterator< TImage >::itkTypeMacroNoParent

(

LineConstIterator< TImage >

)

Run-time type information (and related methods).

template<typename TImage>

void itk::LineConstIterator< TImage >::operator++

(

)

Walk forward along the line to the next index in the image.

template<typename TImage>

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

(

const Self &

it

)

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

Member Data Documentation

template<typename TImage>

constexpr unsigned int itk::LineConstIterator< 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 itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_AccumulateError

protected

Definition at line 170 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_CurrentImageIndex

protected

Start, end and current ND index position in the image of the line

Definition at line 160 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_EndIndex

protected

Definition at line 163 of file itkLineConstIterator.h.

template<typename TImage>

ImageType::ConstWeakPointer itk::LineConstIterator< TImage >::m_Image

protected

Smart pointer to the source image.

Definition at line 151 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_IncrementError

protected

Definition at line 174 of file itkLineConstIterator.h.

template<typename TImage>

bool itk::LineConstIterator< TImage >::m_IsAtEnd

protected

Is the iterator at the end of its walk?

Definition at line 157 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_LastIndex

protected

Definition at line 162 of file itkLineConstIterator.h.

template<typename TImage>

unsigned int itk::LineConstIterator< TImage >::m_MainDirection

protected

Variables that drive the Bresenham-Algorithm

Definition at line 167 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_MaximalError

protected

Definition at line 178 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_OverflowIncrement

protected

Definition at line 181 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_ReduceErrorAfterIncrement

protected

Definition at line 185 of file itkLineConstIterator.h.

template<typename TImage>

RegionType itk::LineConstIterator< TImage >::m_Region

protected

Region type to iterate over.

Definition at line 154 of file itkLineConstIterator.h.

template<typename TImage>

IndexType itk::LineConstIterator< TImage >::m_StartIndex

protected

Definition at line 161 of file itkLineConstIterator.h.

---

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

• itkLineConstIterator.h