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
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ReflectiveImageRegionIterator	Self
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef ReflectiveImageRegionConstIterator < TImage >	Superclass
Public Types inherited from itk::ReflectiveImageRegionConstIterator< TImage >
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::RegionType	RegionType
typedef ReflectiveImageRegionConstIterator	Self
typedef TImage::SizeType	SizeType
typedef TImage::SizeValueType	SizeValueType
typedef ImageConstIteratorWithIndex < TImage >	Superclass
Public Types inherited from itk::ImageConstIteratorWithIndex< TImage >
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef TImage::AccessorType	AccessorType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::PixelType	PixelType
typedef TImage::RegionType	RegionType
typedef ImageConstIteratorWithIndex	Self
typedef TImage::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType

Public Member Functions
	ReflectiveImageRegionIterator ()
	ReflectiveImageRegionIterator (ImageType *ptr, const RegionType &region)
	ReflectiveImageRegionIterator (const ImageIteratorWithIndex< TImage > &it)
void	Set (const PixelType &value) const
PixelType &	Value (void)
Public Member Functions inherited from itk::ReflectiveImageRegionConstIterator< TImage >
void	FillOffsets (const OffsetValueType &value)
OffsetType	GetBeginOffset (const OffsetType &)
OffsetType	GetEndOffset (const OffsetType &)
void	GoToBegin (void)
bool	IsAtBegin (void) 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 ()
Public Member Functions inherited from itk::ImageConstIteratorWithIndex< TImage >
PixelType	Get (void) const
const IndexType &	GetIndex () const
const RegionType &	GetRegion () const
void	GoToBegin (void)
void	GoToReverseBegin (void)
	ImageConstIteratorWithIndex ()
	ImageConstIteratorWithIndex (const Self &it)
	ImageConstIteratorWithIndex (const TImage *ptr, const RegionType &region)
bool	IsAtEnd (void) const
bool	IsAtReverseEnd (void) const
	itkLegacyMacro (Self Begin(void) const)
	itkLegacyMacro (Self End(void) 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 (void) const
virtual	~ImageConstIteratorWithIndex ()
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 const 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 >

typedef Superclass::AccessorType itk::ReflectiveImageRegionIterator< TImage >::AccessorType

Definition at line 64 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::ImageType itk::ReflectiveImageRegionIterator< TImage >::ImageType

Definition at line 59 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::IndexType itk::ReflectiveImageRegionIterator< TImage >::IndexType

Types inherited from the Superclass

Definition at line 52 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::IndexValueType itk::ReflectiveImageRegionIterator< TImage >::IndexValueType

Definition at line 53 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::InternalPixelType itk::ReflectiveImageRegionIterator< TImage >::InternalPixelType

Definition at line 62 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::OffsetType itk::ReflectiveImageRegionIterator< TImage >::OffsetType

Definition at line 56 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::OffsetValueType itk::ReflectiveImageRegionIterator< TImage >::OffsetValueType

Definition at line 57 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::PixelContainer itk::ReflectiveImageRegionIterator< TImage >::PixelContainer

Definition at line 60 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::PixelContainerPointer itk::ReflectiveImageRegionIterator< TImage >::PixelContainerPointer

Definition at line 61 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::PixelType itk::ReflectiveImageRegionIterator< TImage >::PixelType

Definition at line 63 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::RegionType itk::ReflectiveImageRegionIterator< TImage >::RegionType

Definition at line 58 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef ReflectiveImageRegionIterator itk::ReflectiveImageRegionIterator< TImage >::Self

Standard class typedefs.

Definition at line 48 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::SizeType itk::ReflectiveImageRegionIterator< TImage >::SizeType

Definition at line 54 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef Superclass::SizeValueType itk::ReflectiveImageRegionIterator< TImage >::SizeValueType

Definition at line 55 of file itkReflectiveImageRegionIterator.h.

template<typename TImage >

typedef ReflectiveImageRegionConstIterator< TImage > itk::ReflectiveImageRegionIterator< TImage >::Superclass

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.

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

template<typename TImage >

PixelType& itk::ReflectiveImageRegionIterator< TImage >::Value ( void  )

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.

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

---

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

• itkReflectiveImageRegionIterator.h