itk::ImageRegionReverseIterator< TImage > Class Template Reference

#include <itkImageRegionReverseIterator.h>

Inheritance diagram for itk::ImageRegionReverseIterator< TImage >:

Collaboration diagram for itk::ImageRegionReverseIterator< TImage >:

Detailed Description

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

A multi-dimensional image iterator which only walks a region.

ImageRegionReverseIterator is a templated class to represent a multi-dimensional iterator. ImageRegionReverseIterator is templated over the image type ImageRegionReverseIterator 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 ImageRegionReverseConstIterator. The current class only adds write access to image pixels.

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 http://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

Definition at line 69 of file itkImageRegionReverseIterator.h.

Public Types
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageRegionReverseIterator	Self
typedef Superclass::SizeType	SizeType
typedef ImageRegionReverseConstIterator < TImage >	Superclass
Public Types inherited from itk::ImageRegionReverseConstIterator< TImage >
enum	{ ImageIteratorDimension = Superclass::ImageIteratorDimension }
typedef Superclass::AccessorType	AccessorType
typedef Superclass::ImageType	ImageType
typedef Superclass::IndexType	IndexType
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef Superclass::PixelType	PixelType
typedef Superclass::RegionType	RegionType
typedef ImageRegionReverseConstIterator	Self
typedef Superclass::SizeType	SizeType
typedef ImageReverseConstIterator < TImage >	Superclass
Public Types inherited from itk::ImageReverseConstIterator< TImage >
typedef TImage::AccessorFunctorType	AccessorFunctorType
typedef TImage::AccessorType	AccessorType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::OffsetType	OffsetType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::PixelType	PixelType
typedef TImage::RegionType	RegionType
typedef ImageReverseConstIterator	Self
typedef TImage::SizeType	SizeType

Public Member Functions
	ImageRegionReverseIterator ()
	ImageRegionReverseIterator (ImageType *ptr, const RegionType &region)
	ImageRegionReverseIterator (const ImageConstIterator< TImage > &it)
	itkLegacyMacro (Self Begin(void) const)
	itkLegacyMacro (Self End(void) const)
void	Set (const PixelType &value) const
PixelType &	Value (void)
Public Member Functions inherited from itk::ImageRegionReverseConstIterator< TImage >
virtual const char *	GetNameOfClass () const
void	GoToBegin ()
void	GoToEnd ()
	ImageRegionReverseConstIterator ()
	ImageRegionReverseConstIterator (const ImageConstIterator< TImage > &it)
	ImageRegionReverseConstIterator (const ImageReverseConstIterator< TImage > &it)
	ImageRegionReverseConstIterator (const ImageRegionIterator< TImage > &it)
	itkLegacyMacro (Self Begin(void) const)
	itkLegacyMacro (Self End(void) const)
Self &	operator++ ()
Self &	operator-- ()
	ImageRegionReverseConstIterator (const ImageType *ptr, const RegionType &region)
void	SetIndex (const IndexType &ind)
Public Member Functions inherited from itk::ImageReverseConstIterator< TImage >
	ImageReverseConstIterator (const Self &it)
	ImageReverseConstIterator (const ImageType *ptr, const RegionType &region)
virtual	~ImageReverseConstIterator ()
	ImageReverseConstIterator ()
	ImageReverseConstIterator (const ImageConstIterator< TImage > &it)
Self &	operator= (const Self &it)
Self &	operator= (const ImageConstIterator< TImage > &it)
bool	operator!= (const Self &it) const
bool	operator== (const Self &it) const
const IndexType	GetIndex ()
const RegionType &	GetRegion () const
const PixelType	Get (void) const
void	Set (const PixelType &value) const
const PixelType &	Value (void) const
const PixelType &	Value (void)
	itkLegacyMacro (Self Begin() const)
void	GoToBegin ()
	itkLegacyMacro (Self End() const)
void	GoToEnd ()
bool	IsAtBegin ()
bool	IsAtEnd ()

Protected Member Functions
	ImageRegionReverseIterator (const ImageRegionReverseConstIterator< TImage > &it)
Self &	operator= (const ImageRegionReverseConstIterator< TImage > &it)

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageReverseConstIterator< TImage >
static unsigned int	GetImageIteratorDimension ()
Static Public Attributes inherited from itk::ImageReverseConstIterator< TImage >
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension
Protected Attributes inherited from itk::ImageRegionReverseConstIterator< TImage >
SizeValueType	m_SpanBeginOffset
SizeValueType	m_SpanEndOffset
Protected Attributes inherited from itk::ImageReverseConstIterator< TImage >
ImageType::ConstWeakPointer	m_Image
RegionType	m_Region
SizeValueType	m_Offset
SizeValueType	m_BeginOffset
SizeValueType	m_EndOffset
const InternalPixelType *	m_Buffer
AccessorType	m_PixelAccessor
AccessorFunctorType	m_PixelAccessorFunctor

Member Typedef Documentation

template<typename TImage >

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

Definition at line 86 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 81 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Types inherited from the Superclass

Definition at line 77 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 84 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 79 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 82 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 83 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 85 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 80 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef ImageRegionReverseIterator itk::ImageRegionReverseIterator< TImage >::Self

Standard class typedefs.

Definition at line 73 of file itkImageRegionReverseIterator.h.

template<typename TImage >

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

Definition at line 78 of file itkImageRegionReverseIterator.h.

template<typename TImage >

typedef ImageRegionReverseConstIterator< TImage > itk::ImageRegionReverseIterator< TImage >::Superclass

Definition at line 74 of file itkImageRegionReverseIterator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator

(

)

Default constructor. Needed since we provide a cast constructor.

template<typename TImage >

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator	(	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::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator

(

const ImageConstIterator< TImage > &

it

)

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

template<typename TImage >

itk::ImageRegionReverseIterator< TImage >::ImageRegionReverseIterator ( const ImageRegionReverseConstIterator< TImage > &  it )

protected

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

Member Function Documentation

template<typename TImage >

itk::ImageRegionReverseIterator< TImage >::itkLegacyMacro

(

Self Begin(void)

const

)

Return an iterator for the beginning of the region. "Begin" is defined as the first pixel in the region.

Deprecated:

Use GoToBegin() instead

template<typename TImage >

itk::ImageRegionReverseIterator< TImage >::itkLegacyMacro

(

Self End(void)

const

)

Return an iterator for the end of the region. "End" is defined as one pixel past the last pixel of the region.

Deprecated:

Use GoToEnd() instead

template<typename TImage >

Self& itk::ImageRegionReverseIterator< TImage >::operator= ( const ImageRegionReverseConstIterator< TImage > &  it )

protected

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

template<typename TImage >

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

inline

Set the pixel value

Definition at line 104 of file itkImageRegionReverseIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_Buffer, itk::ImageReverseConstIterator< TImage >::m_Offset, and itk::ImageReverseConstIterator< TImage >::m_PixelAccessor.

template<typename TImage >

PixelType& itk::ImageRegionReverseIterator< 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 110 of file itkImageRegionReverseIterator.h.

References itk::ImageReverseConstIterator< TImage >::m_Buffer, and itk::ImageReverseConstIterator< TImage >::m_Offset.

---

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

• itkImageRegionReverseIterator.h