OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
otb::PolyLineImageConstIterator< TImage, TPath > Class Template Reference
Data Access Objects » IteratorsGroup Core » | Module OTBPath

#include <otbPolyLineImageConstIterator.h>

+ Inheritance 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

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 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 46 of file otbPolyLineImageConstIterator.h.

Member Typedef Documentation

◆ AccessorType

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

Definition at line 73 of file otbPolyLineImageConstIterator.h.

◆ ImageType

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

Definition at line 63 of file otbPolyLineImageConstIterator.h.

◆ IndexType

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

Definition at line 54 of file otbPolyLineImageConstIterator.h.

◆ IndexValueType

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

Definition at line 55 of file otbPolyLineImageConstIterator.h.

◆ InternalImageIteratorType

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

Definition at line 68 of file otbPolyLineImageConstIterator.h.

◆ InternalPixelType

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

Definition at line 71 of file otbPolyLineImageConstIterator.h.

◆ OffsetType

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

Definition at line 56 of file otbPolyLineImageConstIterator.h.

◆ OffsetValueType

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

Definition at line 57 of file otbPolyLineImageConstIterator.h.

◆ PathType

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

Definition at line 64 of file otbPolyLineImageConstIterator.h.

◆ PixelContainer

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

Definition at line 69 of file otbPolyLineImageConstIterator.h.

◆ PixelContainerPointer

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

Definition at line 70 of file otbPolyLineImageConstIterator.h.

◆ PixelType

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

Definition at line 72 of file otbPolyLineImageConstIterator.h.

◆ PointType

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

Definition at line 62 of file otbPolyLineImageConstIterator.h.

◆ RegionType

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

Definition at line 60 of file otbPolyLineImageConstIterator.h.

◆ Self

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

Standard typedefs

Definition at line 50 of file otbPolyLineImageConstIterator.h.

◆ SizeType

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

Definition at line 58 of file otbPolyLineImageConstIterator.h.

◆ SizeValueType

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

Definition at line 59 of file otbPolyLineImageConstIterator.h.

◆ SpacingType

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

Definition at line 61 of file otbPolyLineImageConstIterator.h.

◆ VertexIteratorType

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

Definition at line 67 of file otbPolyLineImageConstIterator.h.

◆ VertexListType

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

Definition at line 66 of file otbPolyLineImageConstIterator.h.

◆ VertexType

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

Definition at line 65 of file otbPolyLineImageConstIterator.h.

Constructor & Destructor Documentation

◆ PolyLineImageConstIterator()

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 33 of file otbPolyLineImageConstIterator.hxx.

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.

◆ ~PolyLineImageConstIterator()

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

Default Destructor.

Definition at line 113 of file otbPolyLineImageConstIterator.h.

Member Function Documentation

◆ Get()

template<class TImage , class TPath >
const PixelType otb::PolyLineImageConstIterator< TImage, TPath >::Get ( void  ) const
inline

Get the pixel value

Definition at line 88 of file otbPolyLineImageConstIterator.h.

◆ GetImageIteratorDimension()

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

Get the dimension (size) of the index.

Definition at line 76 of file otbPolyLineImageConstIterator.h.

◆ GetIndex()

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

Get the index

Definition at line 82 of file otbPolyLineImageConstIterator.h.

◆ GoToBegin()

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

Move an iterator to the beginning of the line.

Definition at line 71 of file otbPolyLineImageConstIterator.hxx.

◆ IsAtEnd()

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

Is the iterator at the end of the line?

Definition at line 94 of file otbPolyLineImageConstIterator.h.

◆ operator++()

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 96 of file otbPolyLineImageConstIterator.hxx.

◆ operator=()

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 62 of file otbPolyLineImageConstIterator.hxx.

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

◆ ImageIteratorDimension

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

Definition at line 52 of file otbPolyLineImageConstIterator.h.

◆ m_Image

template<class TImage , class TPath >
ImageType::ConstWeakPointer otb::PolyLineImageConstIterator< TImage, TPath >::m_Image
protected

Smart pointer to the source image.

Definition at line 119 of file otbPolyLineImageConstIterator.h.

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

◆ m_InternalImageIterator

template<class TImage , class TPath >
InternalImageIteratorType otb::PolyLineImageConstIterator< TImage, TPath >::m_InternalImageIterator
protected

Definition at line 123 of file otbPolyLineImageConstIterator.h.

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

◆ m_InternalVertexIterator

template<class TImage , class TPath >
VertexIteratorType otb::PolyLineImageConstIterator< TImage, TPath >::m_InternalVertexIterator
protected

Definition at line 124 of file otbPolyLineImageConstIterator.h.

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

◆ m_Path

template<class TImage , class TPath >
PathType::ConstPointer otb::PolyLineImageConstIterator< TImage, TPath >::m_Path
protected

Smart pointer to the path

Definition at line 122 of file otbPolyLineImageConstIterator.h.

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

The documentation for this class was generated from the following files:
Generated at Wed Feb 28 2024 15:25:23 for OTB with   doxygen 1.8.17