#include <itkImageScanlineConstIterator.h>

Detailed Description

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

A multi-dimensional iterator templated over image type that walks a region of pixels, scanline by scanline or in the direction of the fastest axis.

The itk::ImageScanlineConstIterator is optimized for iteration speed and is the first choice for pixel-wise operations on an image. This iterator is preferred over the older ImageRegionConstIterator even when knowledge of the current line state is not desired because of its speed.

The following is sample usage:

it = ImageScanlineConstIterator()
while ( !it.IsAtEnd() )
  {
  while ( !it.IsAtEndOfLine() )
    {
    *it += 100.0;
    ++it;
    }
   it.NextLine();
   }

Iterating beyond the end of a line results it undefined behavior.

See also: ImageScanlineIterator; ImageRegionConstIterator; ImageConstIterator

Definition at line 64 of file itkImageScanlineConstIterator.h.

Inheritance diagram for itk::ImageScanlineConstIterator< TImage >:

Collaboration diagram for itk::ImageScanlineConstIterator< TImage >:

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	RegionType = typename TImage::RegionType

using	Self = ImageScanlineConstIterator

using	SizeType = typename TImage::SizeType

using	Superclass = ImageConstIterator< TImage >

Public Types inherited from itk::ImageConstIterator< TImage >
using	AccessorFunctorType = typename TImage::AccessorFunctorType

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	RegionType = typename TImage::RegionType

using	Self = ImageConstIterator

using	SizeType = typename TImage::SizeType

Public Member Functions
const char *	GetNameOfClass () const override

void	GoToBegin ()

void	GoToBeginOfLine ()

void	GoToEnd ()

void	GoToEndOfLine ()

	ImageScanlineConstIterator (const ImageConstIterator< TImage > &it)

	ImageScanlineConstIterator (const ImageIterator< TImage > &it)

bool	IsAtEndOfLine () const

void	NextLine ()


	ImageScanlineConstIterator ()


	ImageScanlineConstIterator (const TImage *ptr, const RegionType &region)


void	SetIndex (const IndexType &ind) override


Self &	operator++ ()


Self &	operator-- ()

Public Member Functions inherited from itk::ImageConstIterator< TImage >
PixelType	Get () const

const ImageType *	GetImage () const

const IndexType	GetIndex () const

virtual const char *	GetNameOfClass () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToEnd ()

	ImageConstIterator (const Self &it)

bool	IsAtBegin () const

bool	IsAtEnd () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

bool	operator< (const Self &it) const

bool	operator<= (const Self &it) const

bool	operator== (const Self &it) const

bool	operator> (const Self &it) const

bool	operator>= (const Self &it) const

virtual void	SetIndex (const IndexType &ind)

virtual void	SetRegion (const RegionType &region)

const PixelType &	Value () const

virtual	~ImageConstIterator ()=default

	ImageConstIterator ()

	ImageConstIterator (const ImageType *ptr, const RegionType &region)

Self &	operator= (const Self &it)

Static Public Attributes
static constexpr unsigned int	ImageIteratorDimension = Superclass::ImageIteratorDimension

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

Protected Attributes
OffsetValueType	m_SpanBeginOffset {}

OffsetValueType	m_SpanEndOffset {}

Protected Attributes inherited from itk::ImageConstIterator< TImage >
OffsetValueType	m_BeginOffset {}

const InternalPixelType *	m_Buffer {}

OffsetValueType	m_EndOffset {}

TImage::ConstWeakPointer	m_Image {}

OffsetValueType	m_Offset {}

AccessorType	m_PixelAccessor {}

AccessorFunctorType	m_PixelAccessorFunctor {}

RegionType	m_Region {}

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIterator< TImage >
static unsigned int	GetImageIteratorDimension ()

Member Typedef Documentation

◆ AccessorType

template<typename TImage >

using itk::ImageConstIterator< TImage >::AccessorType = typename TImage::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 128 of file itkImageConstIterator.h.

◆ ImageType

template<typename TImage >

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

Image type alias support

Definition at line 112 of file itkImageConstIterator.h.

◆ IndexType

template<typename TImage >

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

Index type alias support

Definition at line 100 of file itkImageConstIterator.h.

◆ InternalPixelType

template<typename TImage >

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

Internal Pixel Type

Definition at line 121 of file itkImageConstIterator.h.

◆ OffsetType

template<typename TImage >

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

Offset type alias support

Definition at line 106 of file itkImageConstIterator.h.

◆ PixelContainer

template<typename TImage >

using itk::ImageConstIterator< TImage >::PixelContainer = typename TImage::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 117 of file itkImageConstIterator.h.

◆ PixelContainerPointer

template<typename TImage >

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

Definition at line 118 of file itkImageConstIterator.h.

◆ PixelType

template<typename TImage >

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

External Pixel Type

Definition at line 124 of file itkImageConstIterator.h.

◆ RegionType

template<typename TImage >

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

Region type alias support

Definition at line 109 of file itkImageConstIterator.h.

◆ Self

template<typename TImage >

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

Standard class type alias.

Definition at line 68 of file itkImageScanlineConstIterator.h.

◆ SizeType

template<typename TImage >

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

Size type alias support

Definition at line 103 of file itkImageConstIterator.h.

◆ Superclass

template<typename TImage >

using itk::ImageScanlineConstIterator< TImage >::Superclass = ImageConstIterator<TImage>

Definition at line 69 of file itkImageScanlineConstIterator.h.

Constructor & Destructor Documentation

◆ ImageScanlineConstIterator() [1/4]

template<typename TImage >

itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( )

inline

Default constructor. Needed since we provide a cast constructor.

Definition at line 98 of file itkImageScanlineConstIterator.h.

◆ ImageScanlineConstIterator() [2/4]

template<typename TImage >

itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator	(	const TImage *	ptr,
		const RegionType &	region
	)

inline

Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes the iterator at the begin of the region.

Definition at line 108 of file itkImageScanlineConstIterator.h.

◆ ImageScanlineConstIterator() [3/4]

template<typename TImage >

itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( const ImageIterator< TImage > & it )

inline

Constructor that can be used to cast from an ImageIterator to an ImageScanlineConstIterator. Many routines return an ImageIterator, but for a particular task, you may want an ImageScanlineConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageScanlineConstIterator.

Definition at line 122 of file itkImageScanlineConstIterator.h.

References itk::ImageConstIterator< TImage >::operator=().

◆ ImageScanlineConstIterator() [4/4]

template<typename TImage >

itk::ImageScanlineConstIterator< TImage >::ImageScanlineConstIterator ( const ImageConstIterator< TImage > & it )

inline

Constructor that can be used to cast from an ImageConstIterator to an ImageScanlineConstIterator. Many routines return an ImageIterator, but for a particular task, you may want an ImageScanlineConstIterator. Rather than provide overloaded APIs that return different types of Iterators, itk returns ImageIterators and uses constructors to cast from an ImageIterator to a ImageScanlineConstIterator.

Definition at line 138 of file itkImageScanlineConstIterator.h.

References itk::ImageConstIterator< TImage >::operator=().

Member Function Documentation

◆ GetNameOfClass()

template<typename TImage >

const char * itk::ImageScanlineConstIterator< TImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageConstIterator< TImage >.

◆ GoToBegin()

template<typename TImage >

void itk::ImageScanlineConstIterator< TImage >::GoToBegin ( )

inline

Move an iterator to the beginning of the region. "Begin" is defined as the first pixel in the region.

Definition at line 151 of file itkImageScanlineConstIterator.h.

◆ GoToBeginOfLine()

template<typename TImage >

void itk::ImageScanlineConstIterator< TImage >::GoToBeginOfLine ( )

inline

Go to the beginning pixel of the current line.

See also: operator++; operator--; NextLine; IsAtEndOfLine

Definition at line 183 of file itkImageScanlineConstIterator.h.

◆ GoToEnd()

template<typename TImage >

void itk::ImageScanlineConstIterator< TImage >::GoToEnd ( )

inline

Move an iterator to the end of the region.

"End" is defined as one pixel past the last pixel of the region.

Definition at line 166 of file itkImageScanlineConstIterator.h.

◆ GoToEndOfLine()

template<typename TImage >

void itk::ImageScanlineConstIterator< TImage >::GoToEndOfLine ( )

inline

Go to the past end pixel of the current line.

See also: GoToBeginOfLine; operator++; operator--; NextLine; IsAtEndOfLine

Definition at line 197 of file itkImageScanlineConstIterator.h.

◆ IsAtEndOfLine()

template<typename TImage >

bool itk::ImageScanlineConstIterator< TImage >::IsAtEndOfLine ( ) const

inline

Test if the index is at the end of line

Definition at line 205 of file itkImageScanlineConstIterator.h.

◆ NextLine()

template<typename TImage >

void itk::ImageScanlineConstIterator< TImage >::NextLine ( )

Go to the next line.

The iterator always moves to the beginning of the next line. If the iterator is on the last scanline then no action is performed.

See also: operator++; IsAtEndOfLine

◆ operator++()

template<typename TImage >

Self & itk::ImageScanlineConstIterator< TImage >::operator++ ( )

inline

Increment (prefix) along the scanline the iterator's index.

If the iterator is at the end of the scanline ( one past the last
valid element in the row ), then the results are undefined. Which
means is may assert in debug mode or result in an undefined
iterator which may have unknown consequences if used.

Definition at line 245 of file itkImageScanlineConstIterator.h.

◆ operator--()

template<typename TImage >

Self & itk::ImageScanlineConstIterator< TImage >::operator-- ( )

inline

decrement (prefix) along the scanline the iterator's index.

Definition at line 257 of file itkImageScanlineConstIterator.h.

◆ SetIndex()

template<typename TImage >

void itk::ImageScanlineConstIterator< TImage >::SetIndex ( const IndexType & ind )

inlineoverridevirtual

Set the index without bounds checking.

This is overridden from the parent because we have an extra ivar.
\sa GetIndex

Reimplemented from itk::ImageConstIterator< TImage >.

Definition at line 217 of file itkImageScanlineConstIterator.h.

Member Data Documentation

◆ ImageIteratorDimension

template<typename TImage >

constexpr unsigned int itk::ImageScanlineConstIterator< TImage >::ImageIteratorDimension = Superclass::ImageIteratorDimension

staticconstexpr

Dimension of the image that the iterator walks. This constant is needed so 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 75 of file itkImageScanlineConstIterator.h.

◆ m_SpanBeginOffset

template<typename TImage >

OffsetValueType itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset {}

protected

Definition at line 267 of file itkImageScanlineConstIterator.h.

◆ m_SpanEndOffset

template<typename TImage >

OffsetValueType itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset {}

protected

Definition at line 268 of file itkImageScanlineConstIterator.h.

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

itkImageScanlineConstIterator.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ AccessorType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ OffsetType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageScanlineConstIterator() [1/4]

◆ ImageScanlineConstIterator() [2/4]

◆ ImageScanlineConstIterator() [3/4]

◆ ImageScanlineConstIterator() [4/4]

Member Function Documentation

◆ GetNameOfClass()

◆ GoToBegin()

◆ GoToBeginOfLine()

◆ GoToEnd()

◆ GoToEndOfLine()

◆ IsAtEndOfLine()

◆ NextLine()

◆ operator++()

◆ operator--()

◆ SetIndex()

Member Data Documentation

◆ ImageIteratorDimension

◆ m_SpanBeginOffset

◆ m_SpanEndOffset