#include <itkImageLinearIteratorWithIndex.h>

Detailed Description

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

A multi-dimensional image iterator that visits image pixels within a region in a "scan-line" order.

This iterator is a subclass of itk::ImageLinearConstIteratorWithIndex that adds write-access functionality. Please see itk::ImageLinearConstIteratorWithIndex for more information.

MORE INFORMATION: For a complete description of the ITK Image Iterators and their API, please see the Iterators chapter in the ITK Software Guide. The ITK Software Guide is available in print and as a free .pdf download from https://www.itk.org.

See also: ImageConstIterator; ConditionalConstIterator; ConstNeighborhoodIterator; ConstShapedNeighborhoodIterator; ConstSliceIterator; CorrespondenceDataStructureIterator; FloodFilledFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalConstIterator; FloodFilledImageFunctionConditionalIterator; FloodFilledSpatialFunctionConditionalConstIterator; FloodFilledSpatialFunctionConditionalIterator; ImageConstIterator; ImageConstIteratorWithIndex; ImageIterator; ImageIteratorWithIndex; ImageLinearConstIteratorWithIndex; ImageLinearIteratorWithIndex; ImageRandomConstIteratorWithIndex; ImageRandomIteratorWithIndex; ImageRegionConstIterator; ImageRegionConstIteratorWithIndex; ImageRegionExclusionConstIteratorWithIndex; ImageRegionExclusionIteratorWithIndex; ImageRegionIterator; ImageRegionIteratorWithIndex; ImageRegionReverseConstIterator; ImageRegionReverseIterator; ImageReverseConstIterator; ImageReverseIterator; ImageSliceConstIteratorWithIndex; ImageSliceIteratorWithIndex; NeighborhoodIterator; PathConstIterator; PathIterator; ShapedNeighborhoodIterator; SliceIterator; ImageConstIteratorWithIndex

Examples: Examples/Iterators/ImageLinearIteratorWithIndex.cxx, and Examples/Iterators/ImageSliceIteratorWithIndex.cxx.

Definition at line 67 of file itkImageLinearIteratorWithIndex.h.

Inheritance diagram for itk::ImageLinearIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageLinearIteratorWithIndex< TImage >:

Public Types
using	ImageType

using	IndexType

using	PixelContainer

using	PixelContainerPointer

using	RegionType

using	Self = ImageLinearIteratorWithIndex

using	Superclass = ImageLinearConstIteratorWithIndex<TImage>

Public Types inherited from itk::ImageLinearConstIteratorWithIndex< TImage >
using	ImageType = TImage

using	IndexType = typename TImage::IndexType

using	PixelContainer = typename TImage::PixelContainer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	RegionType = typename TImage::RegionType

using	Self = ImageLinearConstIteratorWithIndex

using	Superclass = ImageConstIteratorWithIndex<TImage>

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

using	AccessorType = typename TImage::AccessorType

using	ImageType = TImage

using	IndexType = typename TImage::IndexType

using	IndexValueType = typename IndexType::IndexValueType

using	InternalPixelType = typename TImage::InternalPixelType

using	OffsetType = typename TImage::OffsetType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelContainer = typename TImage::PixelContainer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	PixelType = typename TImage::PixelType

using	RegionType = typename TImage::RegionType

using	Self = ImageConstIteratorWithIndex

using	SizeType = typename TImage::SizeType

using	SizeValueType = typename SizeType::SizeValueType

Public Member Functions
	ImageLinearIteratorWithIndex ()=default

	ImageLinearIteratorWithIndex (const ImageIteratorWithIndex< TImage > &it)

	ImageLinearIteratorWithIndex (ImageType *ptr, const RegionType &region)

void	Set (const PixelType &value) const

PixelType &	Value ()

Public Member Functions inherited from itk::ImageLinearConstIteratorWithIndex< TImage >
unsigned int	GetDirection ()

void	GoToBeginOfLine ()

void	GoToEndOfLine ()

void	GoToReverseBeginOfLine ()

	ImageLinearConstIteratorWithIndex ()

	ImageLinearConstIteratorWithIndex (const ImageConstIteratorWithIndex< TImage > &it)

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

bool	IsAtEndOfLine () const

bool	IsAtReverseEndOfLine () const

void	NextLine ()

void	PreviousLine ()

void	SetDirection (unsigned int direction)

Self &	operator++ ()

Self &	operator-- ()

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

const IndexType &	GetIndex () const

const RegionType &	GetRegion () const

void	GoToBegin ()

void	GoToReverseBegin ()

	ImageConstIteratorWithIndex ()=default

	ImageConstIteratorWithIndex (const Self &it)

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

bool	IsAtEnd () const

bool	IsAtReverseEnd () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)

bool	operator< (const Self &it) const

bool	operator<= (const Self &it) const

Self &	operator= (const Self &it)

bool	operator== (const Self &it) const

bool	operator> (const Self &it) const

bool	operator>= (const Self &it) const

bool	Remaining ()

const PixelType &	Value () const

virtual	~ImageConstIteratorWithIndex ()=default

void	SetIndex (const IndexType &ind)

Protected Member Functions

	ImageLinearIteratorWithIndex (const ImageLinearConstIteratorWithIndex< TImage > &it)

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

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
static constexpr unsigned int	GetImageDimension ()

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

Protected Attributes inherited from itk::ImageConstIteratorWithIndex< TImage >
const InternalPixelType *	m_Begin { nullptr }

IndexType	m_BeginIndex { { 0 } }

const InternalPixelType *	m_End { nullptr }

IndexType	m_EndIndex { { 0 } }

TImage::ConstWeakPointer	m_Image {}

OffsetValueType	m_OffsetTable [ImageDimension+1] {}

AccessorType	m_PixelAccessor {}

AccessorFunctorType	m_PixelAccessorFunctor {}

const InternalPixelType *	m_Position { nullptr }

IndexType	m_PositionIndex { { 0 } }

RegionType	m_Region {}

bool	m_Remaining { false }

Member Typedef Documentation

◆ ImageType

template<typename TImage>

using itk::ImageLinearConstIteratorWithIndex< TImage >::ImageType

Image type alias support While this was already typedef'ed in the superclass, it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index so that it is not confused with ImageIterator::Index.

Definition at line 124 of file itkImageLinearConstIteratorWithIndex.h.

◆ IndexType

template<typename TImage>

using itk::ImageLinearConstIteratorWithIndex< TImage >::IndexType

Index type alias support While this was already typedef'ed in the superclass, it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Index back to itk::Index so that it is not confused with ImageIterator::Index.

Definition at line 112 of file itkImageLinearConstIteratorWithIndex.h.

◆ PixelContainer

template<typename TImage>

using itk::ImageLinearConstIteratorWithIndex< 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 129 of file itkImageLinearConstIteratorWithIndex.h.

◆ PixelContainerPointer

template<typename TImage>

using itk::ImageLinearConstIteratorWithIndex< TImage >::PixelContainerPointer

Definition at line 130 of file itkImageLinearConstIteratorWithIndex.h.

◆ RegionType

template<typename TImage>

using itk::ImageLinearConstIteratorWithIndex< TImage >::RegionType

Region type alias support While this was already typedef'ed in the superclass, it needs to be redone here for this subclass to compile properly with gcc. Note that we have to rescope Region back to itk::ImageRegion so that it is not confused with ImageIterator::Index.

Definition at line 118 of file itkImageLinearConstIteratorWithIndex.h.

◆ Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 71 of file itkImageLinearIteratorWithIndex.h.

◆ Superclass

template<typename TImage>

using itk::ImageLinearIteratorWithIndex< TImage >::Superclass = ImageLinearConstIteratorWithIndex<TImage>

Definition at line 72 of file itkImageLinearIteratorWithIndex.h.

Constructor & Destructor Documentation

◆ ImageLinearIteratorWithIndex() [1/4]

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( )

default

Default constructor. Needed since we provide a cast constructor.

◆ ImageLinearIteratorWithIndex() [2/4]

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex	(	ImageType *	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.

◆ ImageLinearIteratorWithIndex() [3/4]

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( const ImageIteratorWithIndex< TImage > & it )

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

◆ ImageLinearIteratorWithIndex() [4/4]

template<typename TImage>

itk::ImageLinearIteratorWithIndex< TImage >::ImageLinearIteratorWithIndex ( const ImageLinearConstIteratorWithIndex< TImage > & it )

protected

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

Member Function Documentation

◆ operator=()

template<typename TImage>

Self & itk::ImageLinearIteratorWithIndex< TImage >::operator= ( const ImageLinearConstIteratorWithIndex< TImage > & it )

protected

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

◆ Set()

template<typename TImage>

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

inline

Set the pixel value

Definition at line 103 of file itkImageLinearIteratorWithIndex.h.

◆ Value()

template<typename TImage>

PixelType & itk::ImageLinearIteratorWithIndex< 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 112 of file itkImageLinearIteratorWithIndex.h.

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

itkImageLinearIteratorWithIndex.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ImageType

◆ IndexType

◆ PixelContainer

◆ PixelContainerPointer

◆ RegionType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ImageLinearIteratorWithIndex() [1/4]

◆ ImageLinearIteratorWithIndex() [2/4]

◆ ImageLinearIteratorWithIndex() [3/4]

◆ ImageLinearIteratorWithIndex() [4/4]

Member Function Documentation

◆ operator=()

◆ Set()

◆ Value()