itk::ReflectiveImageRegionIterator< TImage > Class Template Reference

#include <itkReflectiveImageRegionIterator.h>

Inheritance diagram for itk::ReflectiveImageRegionIterator< TImage >:

Collaboration diagram for itk::ReflectiveImageRegionIterator< TImage >:

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 44 of file itkReflectiveImageRegionIterator.h.

Public Types
using	AccessorType = typename Superclass::AccessorType
using	ImageType = typename Superclass::ImageType
using	IndexType = typename Superclass::IndexType
using	IndexValueType = typename Superclass::IndexValueType
using	InternalPixelType = typename Superclass::InternalPixelType
using	OffsetType = typename Superclass::OffsetType
using	OffsetValueType = typename Superclass::OffsetValueType
using	PixelContainer = typename Superclass::PixelContainer
using	PixelContainerPointer = typename Superclass::PixelContainerPointer
using	PixelType = typename Superclass::PixelType
using	RegionType = typename Superclass::RegionType
using	Self = ReflectiveImageRegionIterator
using	SizeType = typename Superclass::SizeType
using	SizeValueType = typename Superclass::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 (ImageType *ptr, const RegionType &region)
	ReflectiveImageRegionIterator (const ImageIteratorWithIndex< TImage > &it)
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 (TImage *ptr, const RegionType &region)
	ReflectiveImageRegionConstIterator (const Self &it)
	ReflectiveImageRegionConstIterator (const ImageConstIteratorWithIndex< TImage > &it)
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 ()
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
bool	IsAtEnd () const
bool	IsAtReverseEnd () const
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
bool	Remaining ()
const PixelType &	Value () const
virtual	~ImageConstIteratorWithIndex ()=default
void	SetIndex (const IndexType &ind)

Protected Member Functions
	ReflectiveImageRegionIterator (const ReflectiveImageRegionConstIterator< TImage > &it)
Self &	operator= (const ReflectiveImageRegionConstIterator< 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 >
const InternalPixelType *	m_Begin
IndexType	m_BeginIndex
const InternalPixelType *	m_End
IndexType	m_EndIndex
TImage::ConstWeakPointer	m_Image
OffsetValueType	m_OffsetTable [ImageDimension+1]
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor
const InternalPixelType *	m_Position
IndexType	m_PositionIndex
RegionType	m_Region
bool	m_Remaining

Member Typedef Documentation

template<typename TImage >

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

Definition at line 64 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 59 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Types inherited from the Superclass

Definition at line 52 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

using itk::ReflectiveImageRegionIterator< TImage >::IndexValueType = typename Superclass::IndexValueType

Definition at line 53 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 62 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 56 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

using itk::ReflectiveImageRegionIterator< TImage >::OffsetValueType = typename Superclass::OffsetValueType

Definition at line 57 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 60 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 61 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 63 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 58 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Standard class type aliases.

Definition at line 48 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 54 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

using itk::ReflectiveImageRegionIterator< TImage >::SizeValueType = typename Superclass::SizeValueType

Definition at line 55 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

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

Definition at line 49 of file itkReflectiveImageRegionIterator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ReflectiveImageRegionIterator< TImage >::ReflectiveImageRegionIterator

(

)

Default constructor. Needed since we provide a cast constructor.

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.

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.

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.

Member Function Documentation

template<typename TImage >

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

protected

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

template<typename TImage >

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

inline

Set the pixel value

Definition at line 82 of file itkReflectiveImageRegionIterator.h.

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 88 of file itkReflectiveImageRegionIterator.h.

---

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

• itkReflectiveImageRegionIterator.h