Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::dpoints_bkd_pixter< I > Class Template Reference

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

#include <dpoints_pixter.hh>

Inherits mln::Pixel_Iterator< dpoints_bkd_pixter< I > >, and mln::internal::pixel_impl_< I, dpoints_bkd_pixter< I > >.

Public Member Functions

const I::value & center_val () const
 The value around which this iterator moves.
 
template<typename Dps , typename Pref >
 dpoints_bkd_pixter (I &image, const Dps &dps, const Pref &p_ref)
 Constructor (using an image).
 
template<typename Dps , typename Pref >
 dpoints_bkd_pixter (const Generalized_Pixel< Pref > &pxl_ref, const Dps &dps)
 Constructor (using a generalized pixel).
 
void next ()
 Go to the next element.
 
void start ()
 Manipulation.
 
void invalidate ()
 Invalidate the iterator.
 
bool is_valid () const
 Test the iterator validity.
 
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_bkd_pixter< I >

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

Parameter I is the image type.

Definition at line 141 of file dpoints_pixter.hh.

Constructor & Destructor Documentation

template<typename I >
template<typename Dps , typename Pref >
mln::dpoints_bkd_pixter< I >::dpoints_bkd_pixter ( I &  image,
const Dps &  dps,
const Pref &  p_ref 
)
inline

Constructor (using an image).

Parameters
[in]imageThe image to iterate over.
[in]dpsAn object (neighborhood or window) that can provide a set of delta-points.
[in]p_refCenter (resp. reference) point of the neighborhood (resp. window).

Definition at line 339 of file dpoints_pixter.hh.

template<typename I >
template<typename Dps , typename Pref >
mln::dpoints_bkd_pixter< I >::dpoints_bkd_pixter ( const Generalized_Pixel< Pref > &  pxl_ref,
const Dps &  dps 
)
inline

Constructor (using a generalized pixel).

Parameters
[in]pxl_refCenter (generalized) pixel to iterate around.
[in]dpsAn object (neighborhood or window) that can provide a set of delta-points.

Definition at line 353 of file dpoints_pixter.hh.

Member Function Documentation

template<typename I >
const I::value & mln::dpoints_bkd_pixter< I >::center_val ( ) const
inline

The value around which this iterator moves.

Definition at line 368 of file dpoints_pixter.hh.

template<typename I >
void mln::dpoints_bkd_pixter< I >::invalidate ( )
inline

Invalidate the iterator.

Definition at line 437 of file dpoints_pixter.hh.

template<typename I >
bool mln::dpoints_bkd_pixter< I >::is_valid ( ) const
inline

Test the iterator validity.

Definition at line 429 of file dpoints_pixter.hh.

void mln::Iterator< dpoints_bkd_pixter< I > >::next ( )
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_bkd_pixter< I >::start ( )
inline

Manipulation.

Start an iteration.

Definition at line 410 of file dpoints_pixter.hh.

template<typename I >
void mln::dpoints_bkd_pixter< I >::update ( )
inline

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

Definition at line 396 of file dpoints_pixter.hh.