mln::dpoints_fwd_pixter< I > Class Template Reference

A generic forward iterator on the pixels of a dpoint-based window or neighborhood. More...

#include <dpoints_pixter.hh>

Inheritance diagram for mln::dpoints_fwd_pixter< I >:

List of all members.

Public Member Functions
const I::value &	center_val () const
	The value around which this iterator moves.
template<typename Dps, typename Pref>
	dpoints_fwd_pixter (const Generalized_Pixel< Pref > &pxl_ref, const Dps &dps)
	Constructor (using a generalized pixel).
template<typename Dps, typename Pref>
	dpoints_fwd_pixter (I &image, const Dps &dps, const Pref &p_ref)
	Constructor (using an image).
void	next ()
	Go to the next element.
void	invalidate ()
	Invalidate the iterator.
bool	is_valid () const
	Test the iterator validity.
void	start ()
	Manipulation.
void	update ()
	Force this iterator to update its location to take into account that its center point may have moved.

---

Detailed Description

template<typename I>
class mln::dpoints_fwd_pixter< I >

A generic forward iterator on the pixels of a dpoint-based window or neighborhood.

Parameter I is the image type.

---

Constructor & Destructor Documentation

template<typename I>

template<typename Dps, typename Pref>

mln::dpoints_fwd_pixter< I >::dpoints_fwd_pixter	(	I &	image,
		const Dps &	dps,
		const Pref &	p_ref
	)			[inline]

Constructor (using an image).

Parameters:

[in]	image	The image to iterate over.
[in]	dps	An object (neighborhood or window) that can provide a set of delta-points.
[in]	p_ref	Center (resp. reference) point of the neighborhood (resp. window).

template<typename I>

template<typename Dps, typename Pref>

mln::dpoints_fwd_pixter< I >::dpoints_fwd_pixter	(	const Generalized_Pixel< Pref > &	pxl_ref,
		const Dps &	dps
	)			[inline]

Constructor (using a generalized pixel).

Parameters:

[in]	pxl_ref	Center (generalized) pixel to iterate around.
[in]	dps	An object (neighborhood or window) that can provide a set of delta-points.

---

Member Function Documentation

template<typename I>

const I::value & mln::dpoints_fwd_pixter< I >::center_val

(

)

const [inline]

The value around which this iterator moves.

template<typename I>

void mln::dpoints_fwd_pixter< I >::invalidate

(

)

[inline]

Invalidate the iterator.

template<typename I>

bool mln::dpoints_fwd_pixter< I >::is_valid

(

)

const [inline]

Test the iterator validity.

Referenced by mln::dpoints_fwd_pixter< I >::update().

template<typename E>

void mln::Iterator< E >::next

(

)

[inline, inherited]

Go to the next element.

Warning:

This is a final method; iterator classes should not re-defined this method. The actual "next" operation has to be defined through the next_ method.

Precondition:

The iterator is valid.

template<typename I>

void mln::dpoints_fwd_pixter< I >::start

(

)

[inline]

Manipulation.

Start an iteration.

References mln::dpoints_fwd_pixter< I >::update().

template<typename I>

void mln::dpoints_fwd_pixter< I >::update

(

)

[inline]

Force this iterator to update its location to take into account that its center point may have moved.

References mln::dpoints_fwd_pixter< I >::is_valid().

Referenced by mln::dpoints_fwd_pixter< I >::start().