otb::PolyLineImageConstIterator< TImage, TPath > Class Template Reference

Uses the bresenham algorithm to iterate over a polyline on an image (const version). More...

#include <otbPolyLineImageConstIterator.h>

Inheritance diagram for otb::PolyLineImageConstIterator< TImage, TPath >:

Collaboration diagram for otb::PolyLineImageConstIterator< TImage, TPath >:

Public Types
typedef TImage::AccessorType	AccessorType
typedef TImage	ImageType
typedef TImage::IndexType	IndexType
typedef TImage::IndexValueType	IndexValueType
typedef itk::LineIterator < ImageType >	InternalImageIteratorType
typedef TImage::InternalPixelType	InternalPixelType
typedef TImage::OffsetType	OffsetType
typedef TImage::OffsetValueType	OffsetValueType
typedef TPath	PathType
typedef TImage::PixelContainer	PixelContainer
typedef PixelContainer::Pointer	PixelContainerPointer
typedef TImage::PixelType	PixelType
typedef TImage::PointType	PointType
typedef TImage::RegionType	RegionType
typedef PolyLineImageConstIterator	Self
typedef TImage::SizeType	SizeType
typedef TImage::SizeValueType	SizeValueType
typedef TImage::SpacingType	SpacingType
typedef VertexListType::ConstIterator	VertexIteratorType
typedef PathType::VertexListType	VertexListType
typedef PathType::VertexType	VertexType

Public Member Functions
	PolyLineImageConstIterator (const ImageType *imagePtr, const PathType *pathPtr)
virtual	~PolyLineImageConstIterator ()
const PixelType &	Get (void) const
const IndexType	GetIndex ()
virtual const char *	GetNameOfClass () const
void	GoToBegin ()
bool	IsAtEnd ()
void	operator++ ()
Self &	operator= (const Self &it)

Static Public Member Functions
static unsigned int	GetImageIteratorDimension ()

Static Public Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension

Protected Attributes
ImageType::ConstWeakPointer	m_Image
InternalImageIteratorType	m_InternalImageIterator
VertexIteratorType	m_InternalVertexIterator
PathType::ConstPointer	m_Path

Detailed Description

template<class TImage, class TPath>
class otb::PolyLineImageConstIterator< TImage, TPath >

Uses the bresenham algorithm to iterate over a polyline on an image (const version).

This iterator encapsulates the itk::LineIterator along with the VectorContainer iterator on the vertex list of the polyline.

See Also

PolyLineParametricPath

PolyLineParametricPathWithValue

LineIterator

LineConstIterator

PolyLineImageIterator

Definition at line 41 of file otbPolyLineImageConstIterator.h.

Member Typedef Documentation

template<class TImage , class TPath >

typedef TImage::AccessorType otb::PolyLineImageConstIterator< TImage, TPath >::AccessorType

Definition at line 69 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage otb::PolyLineImageConstIterator< TImage, TPath >::ImageType

Definition at line 59 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::IndexType otb::PolyLineImageConstIterator< TImage, TPath >::IndexType

Definition at line 50 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::IndexValueType otb::PolyLineImageConstIterator< TImage, TPath >::IndexValueType

Definition at line 51 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef itk::LineIterator<ImageType> otb::PolyLineImageConstIterator< TImage, TPath >::InternalImageIteratorType

Definition at line 64 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::InternalPixelType otb::PolyLineImageConstIterator< TImage, TPath >::InternalPixelType

Definition at line 67 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::OffsetType otb::PolyLineImageConstIterator< TImage, TPath >::OffsetType

Definition at line 52 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::OffsetValueType otb::PolyLineImageConstIterator< TImage, TPath >::OffsetValueType

Definition at line 53 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TPath otb::PolyLineImageConstIterator< TImage, TPath >::PathType

Definition at line 60 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::PixelContainer otb::PolyLineImageConstIterator< TImage, TPath >::PixelContainer

Definition at line 65 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef PixelContainer::Pointer otb::PolyLineImageConstIterator< TImage, TPath >::PixelContainerPointer

Definition at line 66 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::PixelType otb::PolyLineImageConstIterator< TImage, TPath >::PixelType

Definition at line 68 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::PointType otb::PolyLineImageConstIterator< TImage, TPath >::PointType

Definition at line 58 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::RegionType otb::PolyLineImageConstIterator< TImage, TPath >::RegionType

Definition at line 56 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef PolyLineImageConstIterator otb::PolyLineImageConstIterator< TImage, TPath >::Self

Standard typedefs

Definition at line 45 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::SizeType otb::PolyLineImageConstIterator< TImage, TPath >::SizeType

Definition at line 54 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::SizeValueType otb::PolyLineImageConstIterator< TImage, TPath >::SizeValueType

Definition at line 55 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef TImage::SpacingType otb::PolyLineImageConstIterator< TImage, TPath >::SpacingType

Definition at line 57 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef VertexListType::ConstIterator otb::PolyLineImageConstIterator< TImage, TPath >::VertexIteratorType

Definition at line 63 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef PathType::VertexListType otb::PolyLineImageConstIterator< TImage, TPath >::VertexListType

Definition at line 62 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

typedef PathType::VertexType otb::PolyLineImageConstIterator< TImage, TPath >::VertexType

Definition at line 61 of file otbPolyLineImageConstIterator.h.

Constructor & Destructor Documentation

template<class TImage , class TPath >

otb::PolyLineImageConstIterator< TImage, TPath >::PolyLineImageConstIterator	(	const ImageType *	imagePtr,
		const PathType *	pathPtr
	)

Constructor establishes an iterator to walk along a line

Constructor

Definition at line 31 of file otbPolyLineImageConstIterator.txx.

template<class TImage , class TPath >

virtual otb::PolyLineImageConstIterator< TImage, TPath >::~PolyLineImageConstIterator ( )

inlinevirtual

Default Destructor.

Definition at line 105 of file otbPolyLineImageConstIterator.h.

Member Function Documentation

template<class TImage , class TPath >

const PixelType& otb::PolyLineImageConstIterator< TImage, TPath >::Get ( void  ) const

inline

Get the pixel value

Definition at line 85 of file otbPolyLineImageConstIterator.h.

Referenced by otb::LikelihoodPathListFilter< TPath, TImage >::GenerateData().

template<class TImage , class TPath >

static unsigned int otb::PolyLineImageConstIterator< TImage, TPath >::GetImageIteratorDimension ( )

inlinestatic

Get the dimension (size) of the index.

Definition at line 75 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

const IndexType otb::PolyLineImageConstIterator< TImage, TPath >::GetIndex ( )

inline

Get the index. This provides a read only reference to the index.

Definition at line 80 of file otbPolyLineImageConstIterator.h.

Referenced by otb::ParserConditionDataNodeFeatureFunction< TImage, TCoordRep, TPrecision >::Evaluate(), and otb::NDVIDataNodeFeatureFunction< TImage, TCoordRep, TPrecision >::Evaluate().

template<class TImage , class TPath >

virtual const char* otb::PolyLineImageConstIterator< TImage, TPath >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented in otb::PolyLineImageIterator< TImage, TPath >.

template<class TImage , class TPath >

void otb::PolyLineImageConstIterator< TImage, TPath >::GoToBegin

(

void

)

Move an iterator to the beginning of the line.

Definition at line 75 of file otbPolyLineImageConstIterator.txx.

Referenced by otb::ParserConditionDataNodeFeatureFunction< TImage, TCoordRep, TPrecision >::Evaluate(), and otb::NDVIDataNodeFeatureFunction< TImage, TCoordRep, TPrecision >::Evaluate().

template<class TImage , class TPath >

bool otb::PolyLineImageConstIterator< TImage, TPath >::IsAtEnd ( )

inline

Is the iterator at the end of the line?

Definition at line 90 of file otbPolyLineImageConstIterator.h.

Referenced by otb::ParserConditionDataNodeFeatureFunction< TImage, TCoordRep, TPrecision >::Evaluate(), and otb::NDVIDataNodeFeatureFunction< TImage, TCoordRep, TPrecision >::Evaluate().

template<class TImage , class TPath >

void otb::PolyLineImageConstIterator< TImage, TPath >::operator++

(

)

Walk forward along the line to the next index in the image.

Definition at line 102 of file otbPolyLineImageConstIterator.txx.

template<class TImage , class TPath >

PolyLineImageConstIterator< TImage, TPath >::Self & otb::PolyLineImageConstIterator< TImage, TPath >::operator=

(

const Self &

it

)

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

Definition at line 64 of file otbPolyLineImageConstIterator.txx.

References otb::PolyLineImageConstIterator< TImage, TPath >::m_Image, otb::PolyLineImageConstIterator< TImage, TPath >::m_InternalImageIterator, otb::PolyLineImageConstIterator< TImage, TPath >::m_InternalVertexIterator, and otb::PolyLineImageConstIterator< TImage, TPath >::m_Path.

Member Data Documentation

template<class TImage , class TPath >

const unsigned int otb::PolyLineImageConstIterator< TImage, TPath >::ImageIteratorDimension = TImage::ImageDimension

static

Definition at line 48 of file otbPolyLineImageConstIterator.h.

template<class TImage , class TPath >

ImageType::ConstWeakPointer otb::PolyLineImageConstIterator< TImage, TPath >::m_Image

protected

Smart pointer to the source image.

Definition at line 110 of file otbPolyLineImageConstIterator.h.

Referenced by otb::PolyLineImageConstIterator< TImage, TPath >::operator=().

template<class TImage , class TPath >

InternalImageIteratorType otb::PolyLineImageConstIterator< TImage, TPath >::m_InternalImageIterator

protected

Definition at line 114 of file otbPolyLineImageConstIterator.h.

Referenced by otb::PolyLineImageConstIterator< TImage, TPath >::operator=().

template<class TImage , class TPath >

VertexIteratorType otb::PolyLineImageConstIterator< TImage, TPath >::m_InternalVertexIterator

protected

Definition at line 115 of file otbPolyLineImageConstIterator.h.

Referenced by otb::PolyLineImageConstIterator< TImage, TPath >::operator=().

template<class TImage , class TPath >

PathType::ConstPointer otb::PolyLineImageConstIterator< TImage, TPath >::m_Path

protected

Smart pointer to the path

Definition at line 113 of file otbPolyLineImageConstIterator.h.

Referenced by otb::PolyLineImageConstIterator< TImage, TPath >::operator=().

---

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

• otbPolyLineImageConstIterator.h
• otbPolyLineImageConstIterator.txx