#include <itkReflectiveImageRegionIterator.h>

Detailed Description

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

Multi-dimensional image iterator which only walks a region.

ReflectiveImageRegionIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionIterator is templated over the image type ReflectiveImageRegionIterator is constrained to walk only within the specified region and along a line parallel to one of the coordinate axis.

Most of the functionality is inherited from the ReflectiveImageRegionConstIterator. The current class only adds write access to image pixels.

See also: ReflectiveImageRegionConstIterator

Definition at line 45 of file itkReflectiveImageRegionIterator.h.

Inheritance diagram for itk::ReflectiveImageRegionIterator< TImage >:

Collaboration diagram for itk::ReflectiveImageRegionIterator< TImage >:

Public Types
using	ImageType

using	IndexType

using	OffsetType

using	OffsetValueType

using	PixelContainer

using	PixelContainerPointer

using	RegionType

using	Self = ReflectiveImageRegionIterator

using	SizeType

using	SizeValueType

using	Superclass = ReflectiveImageRegionConstIterator<TImage>

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

using	IndexType = typename TImage::IndexType

using	OffsetType = typename TImage::OffsetType

using	OffsetValueType = typename OffsetType::OffsetValueType

using	PixelContainer = typename TImage::PixelContainer

using	PixelContainerPointer = typename PixelContainer::Pointer

using	RegionType = typename TImage::RegionType

using	Self = ReflectiveImageRegionConstIterator

using	SizeType = typename TImage::SizeType

using	SizeValueType = typename TImage::SizeValueType

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
	ReflectiveImageRegionIterator ()

	ReflectiveImageRegionIterator (const ImageIteratorWithIndex< TImage > &it)

	ReflectiveImageRegionIterator (ImageType *ptr, const RegionType &region)

void	Set (const PixelType &value) const

PixelType &	Value ()

Public Member Functions inherited from itk::ReflectiveImageRegionConstIterator< TImage >
void	FillOffsets (const OffsetValueType &value)

OffsetType	GetBeginOffset (const OffsetType &)

OffsetType	GetEndOffset (const OffsetType &)

void	GoToBegin ()

bool	IsAtBegin () const

bool	IsReflected (unsigned int) const

Self &	operator++ ()

Self &	operator= (const Self &it)

	ReflectiveImageRegionConstIterator ()

	ReflectiveImageRegionConstIterator (const ImageConstIteratorWithIndex< TImage > &it)

	ReflectiveImageRegionConstIterator (const Self &it)

	ReflectiveImageRegionConstIterator (TImage *ptr, const RegionType &region)

void	SetBeginOffset (const OffsetType &offset)

void	SetEndOffset (const OffsetType &offset)

	~ReflectiveImageRegionConstIterator () override=default

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
Self &	operator= (const ReflectiveImageRegionConstIterator< TImage > &it)

	ReflectiveImageRegionIterator (const ReflectiveImageRegionConstIterator< 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::ReflectiveImageRegionConstIterator< 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 Image back to itk::Image to that is it not confused with ImageIterator::Image.

Definition at line 72 of file itkReflectiveImageRegionConstIterator.h.

◆ IndexType

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< 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 to that is it not confused with ImageIterator::Index.

Definition at line 66 of file itkReflectiveImageRegionConstIterator.h.

◆ OffsetType

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::OffsetType

Type of the Offset taken from the image. These type alias are duplicated from the superclass for gcc support.

Definition at line 92 of file itkReflectiveImageRegionConstIterator.h.

◆ OffsetValueType

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::OffsetValueType

Definition at line 93 of file itkReflectiveImageRegionConstIterator.h.

◆ PixelContainer

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< 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 78 of file itkReflectiveImageRegionConstIterator.h.

◆ PixelContainerPointer

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainerPointer

Definition at line 79 of file itkReflectiveImageRegionConstIterator.h.

◆ RegionType

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< 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 is it not confused with ImageIterator::Index.

Definition at line 86 of file itkReflectiveImageRegionConstIterator.h.

◆ Self

template<typename TImage>

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

Standard class type aliases.

Definition at line 50 of file itkReflectiveImageRegionIterator.h.

◆ SizeType

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::SizeType

Definition at line 87 of file itkReflectiveImageRegionConstIterator.h.

◆ SizeValueType

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::SizeValueType

Definition at line 88 of file itkReflectiveImageRegionConstIterator.h.

◆ Superclass

template<typename TImage>

using itk::ReflectiveImageRegionIterator< TImage >::Superclass = ReflectiveImageRegionConstIterator<TImage>

Definition at line 51 of file itkReflectiveImageRegionIterator.h.

Constructor & Destructor Documentation

◆ ReflectiveImageRegionIterator() [1/4]

template<typename TImage>

itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( )

Default constructor. Needed since we provide a cast constructor.

◆ ReflectiveImageRegionIterator() [2/4]

template<typename TImage>

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

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

◆ ReflectiveImageRegionIterator() [3/4]

template<typename TImage>

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

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

◆ ReflectiveImageRegionIterator() [4/4]

template<typename TImage>

itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator ( const ReflectiveImageRegionConstIterator< TImage > & it )

protected

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

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

Member Function Documentation

◆ operator=()

template<typename TImage>

Self & itk::ReflectiveImageRegionIterator< TImage >::operator= ( const ReflectiveImageRegionConstIterator< TImage > & it )

protected

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

◆ Set()

template<typename TImage>

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

inline

Set the pixel value

Definition at line 85 of file itkReflectiveImageRegionIterator.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_PixelAccessor, and itk::ImageConstIteratorWithIndex< TImage >::m_Position.

◆ Value()

template<typename TImage>

PixelType & itk::ReflectiveImageRegionIterator< 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 94 of file itkReflectiveImageRegionIterator.h.

References itk::ImageConstIteratorWithIndex< TImage >::m_Position.

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

itkReflectiveImageRegionIterator.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ImageType

◆ IndexType

◆ OffsetType

◆ OffsetValueType

◆ PixelContainer

◆ PixelContainerPointer

◆ RegionType

◆ Self

◆ SizeType

◆ SizeValueType

◆ Superclass

Constructor & Destructor Documentation

◆ ReflectiveImageRegionIterator() [1/4]

◆ ReflectiveImageRegionIterator() [2/4]

◆ ReflectiveImageRegionIterator() [3/4]

◆ ReflectiveImageRegionIterator() [4/4]

Member Function Documentation

◆ operator=()

◆ Set()

◆ Value()