itk::ImageScanlineIterator< TImage > Class Template Reference

#include <itkImageScanlineIterator.h>

Inheritance diagram for itk::ImageScanlineIterator< TImage >:

Collaboration diagram for itk::ImageScanlineIterator< TImage >:

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.

Public Types
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageScanlineIterator	Self
typedef Superclass::SizeType	SizeType
typedef ImageScanlineConstIterator < TImage >	Superclass
Public Types inherited from itk::ImageScanlineConstIterator< TImage >
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageScanlineConstIterator	Self
typedef Superclass::SizeType	SizeType
typedef ImageConstIterator < TImage >	Superclass
Public Types inherited from itk::ImageConstIterator< TImage >
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef TImage::AccessorType	AccessorType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::OffsetType	OffsetType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::PixelType	PixelType
typedef TImage::RegionType	RegionType
typedef ImageConstIterator	Self
typedef TImage::SizeType	SizeType

Public Member Functions
	ImageScanlineIterator ()
	ImageScanlineIterator (ImageType *ptr, const RegionType &region)
	ImageScanlineIterator (const ImageIterator< TImage > &it)
void	Set (const PixelType &value) const
PixelType &	Value (void)
Public Member Functions inherited from itk::ImageScanlineConstIterator< TImage >
virtual const char *	GetNameOfClass () const
void	GoToBegin ()
void	GoToBeginOfLine (void)
void	GoToEnd ()
void	GoToEndOfLine (void)
	ImageScanlineConstIterator (const ImageIterator< TImage > &it)
	ImageScanlineConstIterator (const ImageConstIterator< TImage > &it)
bool	IsAtEndOfLine (void)
	ImageScanlineConstIterator ()
	ImageScanlineConstIterator (const ImageType *ptr, const RegionType &region)
void	SetIndex (const IndexType &ind) override
void	NextLine (void)
Self &	operator++ ()
Self &	operator-- ()
Public Member Functions inherited from itk::ImageConstIterator< TImage >
	ImageConstIterator (const Self &it)
	itkTypeMacroNoParent (ImageConstIterator)
virtual	~ImageConstIterator ()
	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 (void) const
const PixelType &	Value (void) const
	itkLegacyMacro (Self Begin(void) const)
void	GoToBegin ()
	itkLegacyMacro (Self End(void) const)
void	GoToEnd ()
bool	IsAtBegin (void) const
bool	IsAtEnd (void) const

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 const unsigned int	ImageIteratorDimension = Superclass::ImageIteratorDimension
Static Public Attributes inherited from itk::ImageConstIterator< TImage >
static const 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 >
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

Member Typedef Documentation

template<typename TImage >

typedef Superclass::AccessorType itk::ImageScanlineIterator< TImage >::AccessorType

Definition at line 59 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::ImageType itk::ImageScanlineIterator< TImage >::ImageType

Definition at line 54 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::IndexType itk::ImageScanlineIterator< TImage >::IndexType

Types inherited from the Superclass

Definition at line 50 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::InternalPixelType itk::ImageScanlineIterator< TImage >::InternalPixelType

Definition at line 57 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::OffsetType itk::ImageScanlineIterator< TImage >::OffsetType

Definition at line 52 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::PixelContainer itk::ImageScanlineIterator< TImage >::PixelContainer

Definition at line 55 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::PixelContainerPointer itk::ImageScanlineIterator< TImage >::PixelContainerPointer

Definition at line 56 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::PixelType itk::ImageScanlineIterator< TImage >::PixelType

Definition at line 58 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::RegionType itk::ImageScanlineIterator< TImage >::RegionType

Definition at line 53 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef ImageScanlineIterator itk::ImageScanlineIterator< TImage >::Self

Standard class typedefs.

Definition at line 46 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef Superclass::SizeType itk::ImageScanlineIterator< TImage >::SizeType

Definition at line 51 of file itkImageScanlineIterator.h.

template<typename TImage >

typedef ImageScanlineConstIterator< TImage > itk::ImageScanlineIterator< TImage >::Superclass

Definition at line 47 of file itkImageScanlineIterator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageScanlineIterator< TImage >::ImageScanlineIterator

(

)

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >

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

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

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.

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.

Member Function Documentation

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.

template<typename TImage >

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

inline

Set the pixel value

Definition at line 77 of file itkImageScanlineIterator.h.

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

template<typename TImage >

PixelType& itk::ImageScanlineIterator< TImage >::Value ( void  )

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 86 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