#include <itkImageScanlineConstIterator.h>

Inheritance diagram for itk::ImageScanlineConstIterator< TImage >:

Collaboration diagram for itk::ImageScanlineConstIterator< TImage >:

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.

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. Specialized for RLEImage.

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 63 of file itkImageScanlineConstIterator.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 = ImageScanlineConstIterator

using	SizeType = typename Superclass::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
virtual const char *	GetNameOfClass () const

void	GoToBegin ()

void	GoToBeginOfLine ()

void	GoToEnd ()

void	GoToEndOfLine ()

	ImageScanlineConstIterator (const ImageIterator< TImage > &it)

	ImageScanlineConstIterator (const ImageConstIterator< TImage > &it)

bool	IsAtEndOfLine () const


	ImageScanlineConstIterator ()


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


void	SetIndex (const IndexType &ind) override


void	NextLine ()


Self &	operator++ ()


Self &	operator-- ()

Public Member Functions inherited from itk::ImageConstIterator< TImage >
	ImageConstIterator (const Self &it)

	itkTypeMacroNoParent (ImageConstIterator)

virtual	~ImageConstIterator ()=default

	ImageConstIterator ()

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

Self &	operator= (const Self &it)

virtual void	SetRegion (const RegionType &region)

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

bool	operator> (const Self &it) const

const IndexType	GetIndex () const

const RegionType &	GetRegion () const

const ImageType *	GetImage () const

PixelType	Get () const

const PixelType &	Value () const

void	GoToBegin ()

void	GoToEnd ()

bool	IsAtBegin () const

bool	IsAtEnd () const

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 >
TImage::ConstWeakPointer	m_Image

RegionType	m_Region

OffsetValueType	m_Offset

OffsetValueType	m_BeginOffset

OffsetValueType	m_EndOffset

const InternalPixelType *	m_Buffer

AccessorType	m_PixelAccessor

AccessorFunctorType	m_PixelAccessorFunctor

Private Member Functions
void	Increment ()

Member Typedef Documentation

template<typename TImage>

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

Definition at line 92 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 87 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Index type alias support While these were already typdef'ed in the superclass, they need to be redone here for this subclass to compile properly with gcc.Types inherited from the Superclass

Definition at line 83 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 90 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 85 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 88 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 89 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 91 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 86 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Standard class type alias.

Definition at line 68 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 84 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

Definition at line 69 of file itkImageScanlineConstIterator.h.

Constructor & Destructor Documentation

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.

template<typename TImage>

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

inline

Constructor establishes an iterator to walk a particular image and a particular region of that image.

Definition at line 108 of file itkImageScanlineConstIterator.h.

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=().

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 139 of file itkImageScanlineConstIterator.h.

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

Member Function Documentation

template<typename TImage>

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

virtual

Run-time type information (and related methods).

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 152 of file itkImageScanlineConstIterator.h.

Referenced by itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::DynamicThreadedGenerateData().

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 182 of file itkImageScanlineConstIterator.h.

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.

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 195 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

private

template<typename TImage>

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

inline

Test if the index is at the end of line

Definition at line 202 of file itkImageScanlineConstIterator.h.

Referenced by itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::DynamicThreadedGenerateData(), and itk::ImageScanlineConstIterator< RLEImage< TPixel, VImageDimension, CounterType > >::operator++().

template<typename TImage>

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

inline

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.

\sa operator++
\sa IsAtEndOfLine

Definition at line 230 of file itkImageScanlineConstIterator.h.

Referenced by itk::UnaryFunctorWithIndexImageFilter< TInputImage, TOutputImage, TFunctor >::DynamicThreadedGenerateData().

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 243 of file itkImageScanlineConstIterator.h.

template<typename TImage>

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

inline

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

Definition at line 254 of file itkImageScanlineConstIterator.h.

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 213 of file itkImageScanlineConstIterator.h.

Member Data Documentation

template<typename TImage>

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

static

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.

template<typename TImage>

OffsetValueType itk::ImageScanlineConstIterator< TImage >::m_SpanBeginOffset

protected

Definition at line 264 of file itkImageScanlineConstIterator.h.

template<typename TImage>

OffsetValueType itk::ImageScanlineConstIterator< TImage >::m_SpanEndOffset

protected

Definition at line 265 of file itkImageScanlineConstIterator.h.

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