itk::ReflectiveImageRegionConstIterator< TImage > Class Template Reference

#include <itkReflectiveImageRegionConstIterator.h>

Inheritance diagram for itk::ReflectiveImageRegionConstIterator< TImage >:

Collaboration diagram for itk::ReflectiveImageRegionConstIterator< TImage >:

Detailed Description

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

Multi-dimensional image iterator which only walks a region.

ReflectiveImageRegionConstIterator is a templated class to represent a multi-dimensional iterator. ReflectiveImageRegionConstIterator is templated over the image type. ReflectiveImageRegionConstIterator is constrained to walk only within the specified region.

ReflectiveImageRegionConstIterator will perform two passes over the image along each dimension. It is useful for algorithms that require to go back and forth (once) over the data.

By setting the BeginOffset and EndOffset parameters, you can arrange for the starting point, when going forwards, to be different from the ending point, when going backwards. Along dimension d, when going forwards the iterator traverses the interval [BeginIndex[d]+BeginOffset[d], EndIndex[d]). When going back, it traverses the interval (EndIndex[d]-EndOffset[d], BeginIndex[d]]. Setting both offsets to (1, ..., 1) enables the DanielssonDistanceMapImageFilter to process the entire image, without encountering boundary conditions, rather than removing a one-pixel border.

See Also

DanielssonDistanceMapImageFilter

Definition at line 53 of file itkReflectiveImageRegionConstIterator.h.

Public Types
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
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)

Private Attributes
OffsetType	m_BeginOffset
OffsetType	m_EndOffset
bool	m_IsFirstPass [TImage::ImageDimension]

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::ReflectiveImageRegionConstIterator< TImage >::ImageType = TImage

Image type alias support While this was already typdef'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 70 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::IndexType = typename TImage::IndexType

Index type alias support While this was already typdef'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 64 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::OffsetType = typename TImage::OffsetType

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

Definition at line 90 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 91 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainer = typename TImage::PixelContainer

PixelContainer type alias support Used to refer to the container for the pixel data. While this was already typdef'ed in the superclass it needs to be redone here for this subclass to compile properly with gcc.

Definition at line 76 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::PixelContainerPointer = typename PixelContainer::Pointer

Definition at line 77 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::RegionType = typename TImage::RegionType

Region type alias support While this was already typdef'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 84 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

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

Standard class type aliases.

Definition at line 57 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::SizeType = typename TImage::SizeType

Definition at line 85 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

using itk::ReflectiveImageRegionConstIterator< TImage >::SizeValueType = typename TImage::SizeValueType

Definition at line 86 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

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

Definition at line 58 of file itkReflectiveImageRegionConstIterator.h.

Constructor & Destructor Documentation

template<typename TImage>

itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator

(

)

Default constructor. Needed since we provide a cast constructor.

template<typename TImage>

itk::ReflectiveImageRegionConstIterator< TImage >::~ReflectiveImageRegionConstIterator ( )

overridedefault

Default destructor.

template<typename TImage>

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

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

template<typename TImage>

itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator

(

const Self &

it

)

Copy Constructor. The copy constructor is provided to make sure the handle to the image is properly reference counted.

template<typename TImage>

itk::ReflectiveImageRegionConstIterator< TImage >::ReflectiveImageRegionConstIterator

(

const ImageConstIteratorWithIndex< TImage > &

it

)

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

Member Function Documentation

template<typename TImage>

void itk::ReflectiveImageRegionConstIterator< TImage >::FillOffsets

(

const OffsetValueType &

value

)

Fill both offsets with a single value.

template<typename TImage>

OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetBeginOffset ( const OffsetType &  )

inline

Get the begin offset. Forward iteration starts at this offset from the current region.

Definition at line 152 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::GetEndOffset ( const OffsetType &  )

inline

Get the end offset. Reverse iteration starts at this offset from the current region.

Definition at line 157 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

void itk::ReflectiveImageRegionConstIterator< TImage >::GoToBegin

(

)

Move an iterator to the beginning of the region.

template<typename TImage>

bool itk::ReflectiveImageRegionConstIterator< TImage >::IsAtBegin ( ) const

inline

Is the iterator at the beginning of the region?

Definition at line 135 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

bool itk::ReflectiveImageRegionConstIterator< TImage >::IsReflected

(

unsigned

int

)

const

template<typename TImage>

Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator++

(

)

Increment (prefix) the fastest moving dimension of the iterator's index. This operator will constrain the iterator within the region (i.e. the iterator will automatically wrap from the end of the row of the region to the beginning of the next row of the region) up until the iterator tries to moves past the last pixel of the region. Here, the iterator will be set to be one pixel past the end of the region.

See Also

operator++(int)

template<typename TImage>

Self& itk::ReflectiveImageRegionConstIterator< TImage >::operator=

(

const Self &

it

)

operator= is provided to make sure the handle to the image is properly reference counted.

template<typename TImage>

void itk::ReflectiveImageRegionConstIterator< TImage >::SetBeginOffset ( const OffsetType &  offset )

inline

Set the begin offset. Forward iteration starts at this offset from the current region.

Definition at line 142 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

void itk::ReflectiveImageRegionConstIterator< TImage >::SetEndOffset ( const OffsetType &  offset )

inline

Set the end offset. Reverse iteration starts at this offset from the current region.

Definition at line 147 of file itkReflectiveImageRegionConstIterator.h.

Member Data Documentation

template<typename TImage>

OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::m_BeginOffset

private

Definition at line 165 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

OffsetType itk::ReflectiveImageRegionConstIterator< TImage >::m_EndOffset

private

Definition at line 166 of file itkReflectiveImageRegionConstIterator.h.

template<typename TImage>

bool itk::ReflectiveImageRegionConstIterator< TImage >::m_IsFirstPass[TImage::ImageDimension]

private

Definition at line 164 of file itkReflectiveImageRegionConstIterator.h.

---

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

• itkReflectiveImageRegionConstIterator.h