#include <itkImageScanlineIterator.h>

Detailed Description

template<typename TImage>
class itk::ImageScanlineIterator< 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::ImageScanlineIterator is optimized for iteration speed and is the first choice for pixel-wise operations on an image. This iterator is preferred over the older ImageRegionIterator even when knowledge of the current line state is not desired because of its speed.

See also: ImageScanlineConstIterator; ImageRegionIterator

Definition at line 42 of file itkImageScanlineIterator.h.

Inheritance diagram for itk::ImageScanlineIterator< TImage >:

Collaboration diagram for itk::ImageScanlineIterator< TImage >:

Public Types
using	AccessorType

using	ImageType

using	IndexType

using	InternalPixelType

using	OffsetType

using	PixelContainer

using	PixelContainerPointer

using	PixelType

using	RegionType

using	Self = ImageScanlineIterator

using	SizeType

using	Superclass = ImageScanlineConstIterator<TImage>

Public Types inherited from itk::ImageScanlineConstIterator< TImage >
using	AccessorType

using	ImageType

using	IndexType

using	InternalPixelType

using	OffsetType

using	PixelContainer

using	PixelContainerPointer

using	PixelType

using	RegionType

using	Self = ImageScanlineConstIterator

using	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
	ImageScanlineIterator ()=default

	ImageScanlineIterator (const ImageIterator< TImage > &it)

	ImageScanlineIterator (TImage *ptr, const RegionType &region)

void	Set (const PixelType &value) const

PixelType &	Value ()

Public Member Functions inherited from itk::ImageScanlineConstIterator< TImage >
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

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	SetRegion (const RegionType &region)

const PixelType &	Value () const

virtual	~ImageConstIterator ()=default

	ImageConstIterator ()

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

Self &	operator= (const Self &it)

Protected Member Functions

	ImageScanlineIterator (const ImageScanlineConstIterator< TImage > &it)

Self &	operator= (const ImageScanlineConstIterator< TImage > &it)

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

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

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

Protected Attributes inherited from itk::ImageScanlineConstIterator< TImage >
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 {}

Member Typedef Documentation

◆ AccessorType

template<typename TImage>

using itk::ImageConstIterator< TImage >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 92 of file itkImageConstIterator.h.

◆ ImageType

template<typename TImage>

using itk::ImageConstIterator< TImage >::ImageType

Image type alias support

Definition at line 87 of file itkImageConstIterator.h.

◆ IndexType

template<typename TImage>

using itk::ImageConstIterator< TImage >::IndexType

Index type alias support

Definition at line 83 of file itkImageConstIterator.h.

◆ InternalPixelType

template<typename TImage>

using itk::ImageConstIterator< TImage >::InternalPixelType

Internal Pixel Type

Definition at line 90 of file itkImageConstIterator.h.

◆ OffsetType

template<typename TImage>

using itk::ImageConstIterator< TImage >::OffsetType

Offset type alias support

Definition at line 85 of file itkImageConstIterator.h.

◆ PixelContainer

template<typename TImage>

using itk::ImageConstIterator< 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 88 of file itkImageConstIterator.h.

◆ PixelContainerPointer

template<typename TImage>

using itk::ImageConstIterator< TImage >::PixelContainerPointer

Definition at line 89 of file itkImageConstIterator.h.

◆ PixelType

template<typename TImage>

using itk::ImageConstIterator< TImage >::PixelType

External Pixel Type

Definition at line 91 of file itkImageConstIterator.h.

◆ RegionType

template<typename TImage>

using itk::ImageConstIterator< TImage >::RegionType

Region type alias support

Definition at line 86 of file itkImageConstIterator.h.

◆ Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 46 of file itkImageScanlineIterator.h.

◆ SizeType

template<typename TImage>

using itk::ImageConstIterator< TImage >::SizeType

Size type alias support

Definition at line 84 of file itkImageConstIterator.h.

◆ Superclass

template<typename TImage>

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

Definition at line 47 of file itkImageScanlineIterator.h.

Constructor & Destructor Documentation

◆ ImageScanlineIterator() [1/4]

template<typename TImage>

itk::ImageScanlineIterator< TImage >::ImageScanlineIterator ( )

default

Default constructor. Needed since we provide a cast constructor.

◆ ImageScanlineIterator() [2/4]

template<typename TImage>

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

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.

◆ ImageScanlineIterator() [3/4]

template<typename TImage>

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

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

◆ ImageScanlineIterator() [4/4]

template<typename TImage>

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

protected

the construction from a const iterator is declared protected in order to enforce const correctness.

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

Member Function Documentation

◆ operator=()

template<typename TImage>

Self & itk::ImageScanlineIterator< TImage >::operator= ( const ImageScanlineConstIterator< TImage > & it )

protected

the construction from a const iterator is declared protected in order to enforce const correctness.

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

◆ Set()

template<typename TImage>

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

inline

Set the pixel value

Definition at line 78 of file itkImageScanlineIterator.h.

References itk::ImageConstIterator< TImage >::m_Buffer, itk::ImageConstIterator< TImage >::m_Offset, and itk::ImageConstIterator< TImage >::m_PixelAccessorFunctor.

◆ Value()

template<typename TImage>

PixelType & itk::ImageScanlineIterator< 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 87 of file itkImageScanlineIterator.h.

References itk::ImageConstIterator< TImage >::m_Buffer, and itk::ImageConstIterator< TImage >::m_Offset.

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

itkImageScanlineIterator.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ AccessorType

◆ ImageType

◆ IndexType

◆ InternalPixelType

◆ OffsetType

◆ PixelContainer

◆ PixelContainerPointer

◆ PixelType

◆ RegionType

◆ Self

◆ SizeType

◆ Superclass

Constructor & Destructor Documentation

◆ ImageScanlineIterator() [1/4]

◆ ImageScanlineIterator() [2/4]

◆ ImageScanlineIterator() [3/4]

◆ ImageScanlineIterator() [4/4]

Member Function Documentation

◆ operator=()

◆ Set()

◆ Value()