itk::LineIterator< TImage > Class Template Reference

#include <itkLineIterator.h>

Inheritance diagram for itk::LineIterator< TImage >:

Collaboration diagram for itk::LineIterator< TImage >:

Detailed Description

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

An iterator that walks a Bresenham line through an ND image with write access to pixels.

LineIterator is an iterator that walks a Bresenham line through an image. The iterator is constructed similar to other image iterators, except instead of specifying a region to traverse, you specify two indices. The interval specified by the two indices is closed. So, a line iterator specified with the same start and end index will visit exactly one pixel.

* LineConstIterator<ImageType> it(image, I1, I2);
* while (!it.IsAtEnd())
* {
*    // visits at least 1 pixel
* }
* 

Author

Benjamin King, Experimentelle Radiologie, Medizinische Hochschule Hannover.

See Also

LineConstIterator

Wiki Examples:

• All Examples
• Iterate over a line through an image

Definition at line 56 of file itkLineIterator.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 LineIterator	Self
typedef Superclass::SizeType	SizeType
typedef LineConstIterator< TImage >	Superclass
Public Types inherited from itk::LineConstIterator< TImage >
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::PointType	PointType
typedef TImage::RegionType	RegionType
typedef LineConstIterator	Self
typedef TImage::SizeType	SizeType
typedef TImage::SpacingType	SpacingType

Public Member Functions
virtual const char *	GetNameOfClass () const
	LineIterator (ImageType *imagePtr, const IndexType &firstIndex, const IndexType &lastIndex)
Self &	operator= (const Self &it)
const PixelType &	Value (void)
virtual	~LineIterator ()
void	Set (const PixelType &value)
Public Member Functions inherited from itk::LineConstIterator< TImage >
const PixelType	Get (void) const
const IndexType	GetIndex ()
void	GoToBegin ()
bool	IsAtEnd ()
	LineConstIterator (const ImageType *imagePtr, const IndexType &firstIndex, const IndexType &lastIndex)
void	operator++ ()
Self &	operator= (const Self &it)
virtual	~LineConstIterator ()

Static Public Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::LineConstIterator< TImage >
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension

Additional Inherited Members
Static Public Member Functions inherited from itk::LineConstIterator< TImage >
static unsigned int	GetImageIteratorDimension ()
Protected Attributes inherited from itk::LineConstIterator< TImage >
IndexType	m_AccumulateError
IndexType	m_CurrentImageIndex
IndexType	m_EndIndex
ImageType::ConstWeakPointer	m_Image
IndexType	m_IncrementError
bool	m_IsAtEnd
IndexType	m_LastIndex
unsigned int	m_MainDirection
IndexType	m_MaximalError
IndexType	m_OverflowIncrement
IndexType	m_ReduceErrorAfterIncrement
RegionType	m_Region
IndexType	m_StartIndex

Member Typedef Documentation

template<typename TImage >

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

Definition at line 83 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 78 of file itkLineIterator.h.

template<typename TImage >

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

Inherit types from the superclass

Definition at line 74 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 81 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 75 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 79 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 80 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 82 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 77 of file itkLineIterator.h.

template<typename TImage >

typedef LineIterator itk::LineIterator< TImage >::Self

Standard class typedefs.

Definition at line 61 of file itkLineIterator.h.

template<typename TImage >

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

Definition at line 76 of file itkLineIterator.h.

template<typename TImage >

typedef LineConstIterator< TImage > itk::LineIterator< TImage >::Superclass

Define the superclass

Definition at line 71 of file itkLineIterator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::LineIterator< TImage >::LineIterator	(	ImageType *	imagePtr,
		const IndexType &	firstIndex,
		const IndexType &	lastIndex
	)

Constructor establishes an iterator to walk along a path

template<typename TImage >

virtual itk::LineIterator< TImage >::~LineIterator ( )

inlinevirtual

Default Destructor.

Definition at line 117 of file itkLineIterator.h.

Member Function Documentation

template<typename TImage >

virtual const char* itk::LineIterator< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LineConstIterator< TImage >.

template<typename TImage >

Self& itk::LineIterator< 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::LineIterator< TImage >::Set ( const PixelType &  value )

inline

Set the pixel value

Definition at line 89 of file itkLineIterator.h.

References itk::LineConstIterator< TImage >::m_CurrentImageIndex, and itk::LineConstIterator< TImage >::m_Image.

template<typename TImage >

const PixelType& itk::LineIterator< 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 103 of file itkLineIterator.h.

References itk::LineConstIterator< TImage >::m_Image.

Member Data Documentation

template<typename TImage >

const unsigned int itk::LineIterator< TImage >::ImageIteratorDimension = TImage::ImageDimension

static

Dimension of the image that the iterator walks. This constant is needed so that functions that are templated over image iterator type (as opposed to being templated over pixel type and dimension) can have compile time access to the dimension of the image that the iterator walks.

Definition at line 68 of file itkLineIterator.h.

---

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

• itkLineIterator.h