itk::ImageLinearIteratorWithIndex< TImage > Class Template Reference

#include <itkImageLinearIteratorWithIndex.h>

Inheritance diagram for itk::ImageLinearIteratorWithIndex< TImage >:

Collaboration diagram for itk::ImageLinearIteratorWithIndex< TImage >:

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 = ImageLinearIteratorWithIndex
using	SizeType = typename Superclass::SizeType
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 >
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)
unsigned int	GetDirection ()
Self &	operator++ ()
Self &	operator-- ()
Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
const IndexType &	GetIndex () const
const RegionType &	GetRegion () const
	ImageConstIteratorWithIndex ()
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
bool	operator!= (const Self &it) const
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
virtual	~ImageConstIteratorWithIndex ()=default
void	SetIndex (const IndexType &ind)
PixelType	Get () const
const PixelType &	Value () const
void	GoToBegin ()
void	GoToReverseBegin ()
bool	IsAtReverseEnd () const
bool	IsAtEnd () const
bool	Remaining ()

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 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 >
TImage::ConstWeakPointer	m_Image
IndexType	m_PositionIndex
IndexType	m_BeginIndex
IndexType	m_EndIndex
RegionType	m_Region
OffsetValueType	m_OffsetTable [ImageDimension+1]
const InternalPixelType *	m_Position
const InternalPixelType *	m_Begin
const InternalPixelType *	m_End
bool	m_Remaining
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor

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.

Member Typedef Documentation

AccessorType

template<typename TImage>

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

Definition at line 84 of file itkImageLinearIteratorWithIndex.h.

ImageType

template<typename TImage>

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

Definition at line 79 of file itkImageLinearIteratorWithIndex.h.

IndexType

template<typename TImage>

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

Types inherited from the Superclass

Definition at line 75 of file itkImageLinearIteratorWithIndex.h.

InternalPixelType

template<typename TImage>

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

Definition at line 82 of file itkImageLinearIteratorWithIndex.h.

OffsetType

template<typename TImage>

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

Definition at line 77 of file itkImageLinearIteratorWithIndex.h.

PixelContainer

template<typename TImage>

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

Definition at line 80 of file itkImageLinearIteratorWithIndex.h.

PixelContainerPointer

template<typename TImage>

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

Definition at line 81 of file itkImageLinearIteratorWithIndex.h.

PixelType

template<typename TImage>

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

Definition at line 83 of file itkImageLinearIteratorWithIndex.h.

RegionType

template<typename TImage>

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

Definition at line 78 of file itkImageLinearIteratorWithIndex.h.

Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 71 of file itkImageLinearIteratorWithIndex.h.

SizeType

template<typename TImage>

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

Definition at line 76 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.

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