UntypedImgIterator Class Reference

Untyped image iterator, that allows to iterate over images or image regions pixel by pixel similar to iterators of containers. More...

#include <image/ImgIterator.h>

Inheritance diagram for UntypedImgIterator:

Public Types
typedef UntypedImgIteratorValue *	pointer
typedef UntypedImgIteratorValue &	reference
typedef UntypedImgIteratorValue	value_type
typedef int	difference_type
typedef std::bidirectional_iterator_tag	iterator_category

Public Member Functions
	UntypedImgIterator ()
	UntypedImgIterator (cv::Mat *m)
reference	operator* ()
	Dereferences to the Pixel. More...
pointer	operator-> ()
	Dereferences to the Pixel. More...
reference	operator* () const
pointer	operator-> () const
ImgIteratorBase &	operator+= (ptrdiff_t ofs)
	shifts the iterator forward by the specified number of elements More...
ImgIteratorBase &	operator-= (ptrdiff_t ofs)
	shifts the iterator backward by the specified number of elements More...
ImgIteratorBase &	operator-- ()
	move backward one element More...
ImgIteratorBase &	operator++ ()
	move forward one element More...
Point2i	pos () const
	returns the current iterator position More...
ptrdiff_t	lpos () const
void	seek (ptrdiff_t ofs, bool relative=false)

Public Attributes
const cv::Mat *	m
const uchar *	ptr
const uchar *	sliceStart
const uchar *	sliceEnd

Protected Member Functions
value_type *	getValue ()
const value_type *	getValue () const

Static Protected Member Functions
static std::size_t	total (const cv::Mat *m)
static std::size_t	step (const cv::Mat *m)

Detailed Description

Untyped image iterator, that allows to iterate over images or image regions pixel by pixel similar to iterators of containers.

Member Typedef Documentation

pointer

typedef UntypedImgIteratorValue* pointer

reference

typedef UntypedImgIteratorValue& reference

value_type

typedef UntypedImgIteratorValue value_type

inherited

difference_type

typedef int difference_type

inherited

iterator_category

typedef std::bidirectional_iterator_tag iterator_category

inherited

Constructor & Destructor Documentation

UntypedImgIterator() [1/2]

UntypedImgIterator ( )

inline

UntypedImgIterator() [2/2]

UntypedImgIterator ( cv::Mat *  m )

inline

Member Function Documentation

operator*() [1/2]

reference operator* ( )

inline

Dereferences to the Pixel.

operator->() [1/2]

pointer operator-> ( )

inline

Dereferences to the Pixel.

operator*() [2/2]

reference operator* ( ) const

inlineinherited

operator->() [2/2]

pointer operator-> ( ) const

inlineinherited

getValue() [1/2]

value_type* getValue ( )

inlineprotectedinherited

getValue() [2/2]

const value_type* getValue ( ) const

inlineprotectedinherited

operator+=()

ImgIteratorBase& operator+= ( ptrdiff_t  ofs )

inlineinherited

shifts the iterator forward by the specified number of elements

operator-=()

ImgIteratorBase& operator-= ( ptrdiff_t  ofs )

inlineinherited

shifts the iterator backward by the specified number of elements

operator--()

ImgIteratorBase& operator-- ( )

inlineinherited

move backward one element

operator++()

ImgIteratorBase& operator++ ( )

inlineinherited

move forward one element

pos()

Point2i pos ( ) const

inlineinherited

returns the current iterator position

lpos()

ptrdiff_t lpos ( ) const

inlineinherited

seek()

void seek ( ptrdiff_t  ofs, bool  relative = false  )

inlineinherited

total()

static std::size_t total ( const cv::Mat *  m )

inlinestaticprotectedinherited

step()

static std::size_t step ( const cv::Mat *  m )

inlinestaticprotectedinherited

Member Data Documentation

m

const cv::Mat* m

inherited

ptr

const uchar* ptr

inherited

sliceStart

const uchar* sliceStart

inherited

sliceEnd

const uchar* sliceEnd

inherited

---

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

• base/include/image/ImgIterator.h