itk::LineIterator< TImage > Class Template Reference

Iterator that walks a Bresenham line through an ND image. More...

#include <itkLineIterator.h>

Inheritance diagram for itk::LineIterator< TImage >:

[legend]Collaboration diagram for itk::LineIterator< TImage >:

[legend]List of all members.

Public Types
typedef LineIterator	Self
typedef LineConstIterator< TImage >	Superclass
typedef Superclass::IndexType	IndexType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::OffsetType	OffsetType
typedef Superclass::OffsetValueType	OffsetValueType
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef Superclass::RegionType	RegionType
typedef Superclass::ImageType	ImageType
typedef Superclass::PixelContainer	PixelContainer
typedef Superclass::PixelContainerPointer	PixelContainerPointer
typedef Superclass::InternalPixelType	InternalPixelType
typedef Superclass::PixelType	PixelType
typedef Superclass::AccessorType	AccessorType
Public Member Functions
	itkStaticConstMacro (ImageIteratorDimension, unsigned int, TImage::ImageDimension)
virtual const char *	GetNameOfClass () const
PixelType &	Value (void)
Self &	operator= (const Self &it)
	LineIterator (ImageType *imagePtr, const IndexType &firstIndex, const IndexType &lastIndex)
virtual	~LineIterator ()
void	Set (const PixelType &value)

---

Detailed Description

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

Iterator that walks a Bresenham line through an ND image.

LineIterator is an iterator that walks a Bresenham line through an image. The iterator is constructed similar to other image iterators except for 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
 }

This class was contributed by Benjamin King, Experimentelle Radiologie, Medizinische Hochschule Hannover.

See also:

LineConstIterator

Definition at line 52 of file itkLineIterator.h.

---

Member Typedef Documentation

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

Accessor type that convert data between internal and external representations. Reimplemented from itk::LineConstIterator< TImage >. Definition at line 82 of file itkLineIterator.h.

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

Image typedef support. Reimplemented from itk::LineConstIterator< TImage >. Definition at line 77 of file itkLineIterator.h.

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

Inherit types from the superclass Reimplemented from itk::LineConstIterator< TImage >. Definition at line 70 of file itkLineIterator.h.

template<class TImage> typedef Superclass::IndexValueType itk::LineIterator< TImage >::IndexValueType

Reimplemented from itk::LineConstIterator< TImage >. Definition at line 71 of file itkLineIterator.h.

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

Internal Pixel Type Reimplemented from itk::LineConstIterator< TImage >. Definition at line 80 of file itkLineIterator.h.

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

Offset typedef support. Reimplemented from itk::LineConstIterator< TImage >. Definition at line 72 of file itkLineIterator.h.

template<class TImage> typedef Superclass::OffsetValueType itk::LineIterator< TImage >::OffsetValueType

Reimplemented from itk::LineConstIterator< TImage >. Definition at line 73 of file itkLineIterator.h.

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

PixelContainer typedef 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. Reimplemented from itk::LineConstIterator< TImage >. Definition at line 78 of file itkLineIterator.h.

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

Reimplemented from itk::LineConstIterator< TImage >. Definition at line 79 of file itkLineIterator.h.

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

External Pixel Type Reimplemented from itk::LineConstIterator< TImage >. Definition at line 81 of file itkLineIterator.h.

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

Region typedef support Reimplemented from itk::LineConstIterator< TImage >. Definition at line 76 of file itkLineIterator.h.

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

Standard class typedefs. Reimplemented from itk::LineConstIterator< TImage >. Definition at line 57 of file itkLineIterator.h.

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

Size typedef support. Reimplemented from itk::LineConstIterator< TImage >. Definition at line 74 of file itkLineIterator.h.

template<class TImage> typedef Superclass::SizeValueType itk::LineIterator< TImage >::SizeValueType

Reimplemented from itk::LineConstIterator< TImage >. Definition at line 75 of file itkLineIterator.h.

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

Define the superclass Definition at line 67 of file itkLineIterator.h.

---

Constructor & Destructor Documentation

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

Constructor establishes an iterator to walk along a path

template<class TImage> virtual itk::LineIterator< TImage >::~LineIterator (   )  [inline, virtual]

Default Destructor. Definition at line 116 of file itkLineIterator.h.

---

Member Function Documentation

template<class TImage> virtual const char* itk::LineIterator< TImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::LineConstIterator< TImage >.

template<class TImage> itk::LineIterator< TImage >::itkStaticConstMacro (  ImageIteratorDimension  , unsigned  int, TImage::ImageDimension  )

Dimension of the image 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. Reimplemented from itk::LineConstIterator< TImage >.

template<class TImage> Self& itk::LineIterator< TImage >::operator= (  const Self &  it  )

operator= is provided to make sure the handle to the image is properly reference counted. Reimplemented from itk::LineConstIterator< TImage >.

template<class TImage> void itk::LineIterator< TImage >::Set (  const PixelType &  value  )  [inline]

Set the pixel value Definition at line 88 of file itkLineIterator.h.

template<class TImage> 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 102 of file itkLineIterator.h.

---

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

• itkLineIterator.h

---