$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::static_dpoints_fwd_pixter< I, W > Class Template Reference

#include <apps/bench/static_dpoints_pixter.hh>

Public Member Functions

template<typename Dps , typename Pref >
 static_dpoints_fwd_pixter (I &image, const Dps &dps, const Pref &p_ref)
template<typename Dps , typename Pref >
 static_dpoints_fwd_pixter (const Generalized_Pixel< Pref > &pxl_ref, const Dps &dps)
value ** address_ () const
const I::value & center_val () const
I & ima () const
void next ()
 operator unsigned () const
lvalue val ()
rvalue val () const
void start ()
void next_ ()
void invalidate ()
bool is_valid () const
void update ()

Public Types

typedef Object< void > category
typedef
static_dpoints_fwd_pixter< I,
W > 
exact_t
typedef I image
typedef I::lvalue lvalue
typedef I::rvalue rvalue
typedef I::value value

Detailed Description

template<typename I, typename W>
class mln::static_dpoints_fwd_pixter< I, W >

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

Parameter I is the image type.

Definition at line 61 of file static_dpoints_pixter.hh.

Constructor & Destructor Documentation

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

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).
template<typename I , typename W >
template<typename Dps , typename Pref >
mln::static_dpoints_fwd_pixter< I, W >::static_dpoints_fwd_pixter ( const Generalized_Pixel< Pref > &  pxl_ref,
const Dps &  dps 
)

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.

Member Function Documentation

value** mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::address_ ( ) const
inherited

Address of the current iterator value/pixel.

template<typename I , typename W >
const I ::value& mln::static_dpoints_fwd_pixter< I, W >::center_val ( ) const

The value around which this iterator moves.

I& mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::ima ( ) const
inherited

Give the pixel image.

template<typename I , typename W >
void mln::static_dpoints_fwd_pixter< I, W >::invalidate ( )

Invalidate the iterator.

template<typename I , typename W >
bool mln::static_dpoints_fwd_pixter< I, W >::is_valid ( ) const

Test the iterator validity.

void mln::Iterator< static_dpoints_fwd_pixter< I, W > >::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 , typename W >
void mln::static_dpoints_fwd_pixter< I, W >::next_ ( )

Go to the next pixel.

mln::Generalized_Pixel< static_dpoints_fwd_pixter< I, W > >::operator unsigned ( ) const
inlineinherited

Definition at line 65 of file generalized_pixel.hh.

template<typename I , typename W >
void mln::static_dpoints_fwd_pixter< I, W >::start ( )

Manipulation.

Start an iteration.

template<typename I , typename W >
void mln::static_dpoints_fwd_pixter< I, W >::update ( )

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

pixel iterator value.

rvalue mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::val ( ) const
inherited

Get the pixel iterator value.

Member Typedef Documentation

typedef Object<void> mln::Object< static_dpoints_fwd_pixter< I, W > >::category
inherited

Definition at line 106 of file object.hh.

Definition at line 105 of file object.hh.

typedef I mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::image
inherited

Image type.

Definition at line 131 of file pixel_impl.hh.

typedef I ::lvalue mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::lvalue
inherited

Image lvalue type.

Definition at line 137 of file pixel_impl.hh.

typedef I ::rvalue mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::rvalue
inherited

Image rvalue type.

Definition at line 140 of file pixel_impl.hh.

typedef I ::value mln::internal::pixel_impl_< I, static_dpoints_fwd_pixter< I, W > >::value
inherited

Image value type.

Definition at line 134 of file pixel_impl.hh.