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

#include <otbPolyLineImageIterator.h>

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

Collaboration diagram for otb::PolyLineImageIterator< 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 PolyLineImageIterator	Self
typedef TImage::SizeType	SizeType
typedef TImage::SizeValueType	SizeValueType
typedef TImage::SpacingType	SpacingType
typedef PolyLineImageConstIterator< TImage, TPath >	Superclass
typedef VertexListType::ConstIterator	VertexIteratorType
typedef PathType::VertexListType	VertexListType
typedef PathType::VertexType	VertexType
Public Types inherited from otb::PolyLineImageConstIterator< TImage, TPath >
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
void	Set (const PixelType &value)
PixelType &	Value (void)
Self &	operator= (const Self &it)
	PolyLineImageIterator (ImageType *imagePtr, PathType *pathPtr)
	~PolyLineImageIterator () override
Public Member Functions inherited from otb::PolyLineImageConstIterator< TImage, TPath >
const PixelType	Get (void) const
const IndexType	GetIndex ()
bool	IsAtEnd ()
virtual	~PolyLineImageConstIterator ()
void	GoToBegin ()
void	operator++ ()
Self &	operator= (const Self &it)
	PolyLineImageConstIterator (const ImageType *imagePtr, const PathType *pathPtr)

Static Public Attributes
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension
Static Public Attributes inherited from otb::PolyLineImageConstIterator< TImage, TPath >
static const unsigned int	ImageIteratorDimension = TImage::ImageDimension

Additional Inherited Members
Static Public Member Functions inherited from otb::PolyLineImageConstIterator< TImage, TPath >
static unsigned int	GetImageIteratorDimension ()
Protected Attributes inherited from otb::PolyLineImageConstIterator< TImage, TPath >
ImageType::ConstWeakPointer	m_Image
InternalImageIteratorType	m_InternalImageIterator
VertexIteratorType	m_InternalVertexIterator
PathType::ConstPointer	m_Path

Detailed Description

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

Uses the bresenham algorithm to iterate over a polyline on an image.

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

See also

PolyLineParametricPath

PolyLineParametricPathWithValue

LineIterator

LineConstIterator

PolyLineImageConstIterator

Definition at line 44 of file otbPolyLineImageIterator.h.

Member Typedef Documentation

AccessorType

template<class TImage , class TPath >

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

Definition at line 72 of file otbPolyLineImageIterator.h.

ImageType

template<class TImage , class TPath >

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

Definition at line 62 of file otbPolyLineImageIterator.h.

IndexType

template<class TImage , class TPath >

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

Definition at line 53 of file otbPolyLineImageIterator.h.

IndexValueType

template<class TImage , class TPath >

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

Definition at line 54 of file otbPolyLineImageIterator.h.

InternalImageIteratorType

template<class TImage , class TPath >

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

Definition at line 67 of file otbPolyLineImageIterator.h.

InternalPixelType

template<class TImage , class TPath >

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

Definition at line 70 of file otbPolyLineImageIterator.h.

OffsetType

template<class TImage , class TPath >

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

Definition at line 55 of file otbPolyLineImageIterator.h.

OffsetValueType

template<class TImage , class TPath >

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

Definition at line 56 of file otbPolyLineImageIterator.h.

PathType

template<class TImage , class TPath >

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

Definition at line 63 of file otbPolyLineImageIterator.h.

PixelContainer

template<class TImage , class TPath >

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

Definition at line 68 of file otbPolyLineImageIterator.h.

PixelContainerPointer

template<class TImage , class TPath >

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

Definition at line 69 of file otbPolyLineImageIterator.h.

PixelType

template<class TImage , class TPath >

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

Definition at line 71 of file otbPolyLineImageIterator.h.

PointType

template<class TImage , class TPath >

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

Definition at line 61 of file otbPolyLineImageIterator.h.

RegionType

template<class TImage , class TPath >

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

Definition at line 59 of file otbPolyLineImageIterator.h.

Self

template<class TImage , class TPath >

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

Standard typedefs

Definition at line 48 of file otbPolyLineImageIterator.h.

SizeType

template<class TImage , class TPath >

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

Definition at line 57 of file otbPolyLineImageIterator.h.

SizeValueType

template<class TImage , class TPath >

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

Definition at line 58 of file otbPolyLineImageIterator.h.

SpacingType

template<class TImage , class TPath >

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

Definition at line 60 of file otbPolyLineImageIterator.h.

Superclass

template<class TImage , class TPath >

typedef PolyLineImageConstIterator<TImage, TPath> otb::PolyLineImageIterator< TImage, TPath >::Superclass

Definition at line 49 of file otbPolyLineImageIterator.h.

VertexIteratorType

template<class TImage , class TPath >

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

Definition at line 66 of file otbPolyLineImageIterator.h.

VertexListType

template<class TImage , class TPath >

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

Definition at line 65 of file otbPolyLineImageIterator.h.

VertexType

template<class TImage , class TPath >

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

Definition at line 64 of file otbPolyLineImageIterator.h.

Constructor & Destructor Documentation

PolyLineImageIterator()

template<class TImage , class TPath >

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

inline

Constructor establishes an iterator to walk along a line

Definition at line 95 of file otbPolyLineImageIterator.h.

~PolyLineImageIterator()

template<class TImage , class TPath >

otb::PolyLineImageIterator< TImage, TPath >::~PolyLineImageIterator ( )

inlineoverride

Default Destructor.

Definition at line 98 of file otbPolyLineImageIterator.h.

Member Function Documentation

operator=()

template<class TImage , class TPath >

Self& otb::PolyLineImageIterator< TImage, TPath >::operator= ( const Self &  it )

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 87 of file otbPolyLineImageIterator.h.

Set()

template<class TImage , class TPath >

void otb::PolyLineImageIterator< TImage, TPath >::Set ( const PixelType &  value )

inline

Set the pixel value

Definition at line 75 of file otbPolyLineImageIterator.h.

Value()

template<class TImage , class TPath >

PixelType& otb::PolyLineImageIterator< TImage, TPath >::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 83 of file otbPolyLineImageIterator.h.

Member Data Documentation

ImageIteratorDimension

template<class TImage , class TPath >

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

static

Definition at line 51 of file otbPolyLineImageIterator.h.

---

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

• otbPolyLineImageIterator.h