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

#include <mln/core/window.hh>

Public Member Functions

 window ()
void clear ()
unsigned delta () const
const D & dp (unsigned i) const
const mln::util::set< D > & dps_hook_ () const
bool has (const D &dp) const
window< D > & insert (const D &dp)
template<typename W >
window< D > & insert (const Window< W > &win)
bool is_centered () const
bool is_empty () const
bool is_symmetric () const
bool is_valid () const
void print (std::ostream &ostr) const
unsigned size () const
const std::vector< D > & std_vector () const
void sym ()
window< D > & insert (const typename D::coord &dind)
window< D > & insert (const typename D::coord &drow, const typename D::coord &dcol)
window< D > & insert (const typename D::coord &dsli, const typename D::coord &drow, const typename D::coord &dcol)

Public Types

typedef dpsites_bkd_piter
< window< D > > 
bkd_qiter
typedef Window< void > category
typedef psite center_t
typedef D dpsite
typedef window< D > exact_t
typedef dpsites_fwd_piter
< window< D > > 
fwd_qiter
typedef D::psite psite
typedef fwd_qiter qiter
typedef window< D > regular
typedef D::site site

Related Functions

(Note that these are not member functions.)

template<typename D , unsigned n>
bool operator== (const static_window< D, n > &lhs, const static_window< D, n > &rhs)
template<typename D >
bool operator== (const window< D > &lhs, const window< D > &rhs)

Detailed Description

template<typename D>
class mln::window< D >

Generic window class.

This type of window is just like a set of delta-points. The parameter is D, type of delta-point.

Definition at line 87 of file window.hh.

Constructor & Destructor Documentation

template<typename D>
mln::window< D >::window ( )

Constructor without argument.

The constructed window is empty.

Member Function Documentation

template<typename D>
void mln::window< D >::clear ( )

Clear the window.

template<typename D>
unsigned mln::window< D >::delta ( ) const

Give the maximum coordinate gap between the window center and a window point.

template<typename D>
const D& mln::window< D >::dp ( unsigned  i) const

Give the i-th delta-point.

template<typename D>
const mln::util::set<D>& mln::window< D >::dps_hook_ ( ) const

INTERNAL_API

Hook to the set of D.

template<typename D>
bool mln::window< D >::has ( const D &  dp) const

Test if dp is in this window definition.

template<typename D>
window<D>& mln::window< D >::insert ( const D &  dp)

Insert a delta-point dp.

template<typename D>
template<typename W >
window<D>& mln::window< D >::insert ( const Window< W > &  win)

Insert another window win.

template<typename D>
window<D>& mln::window< D >::insert ( const typename D::coord &  dind)

Insertion of a delta-point with different numbers of arguments (coordinates) w.r.t. the dimension.

template<typename D>
window<D>& mln::window< D >::insert ( const typename D::coord &  drow,
const typename D::coord &  dcol 
)
template<typename D>
window<D>& mln::window< D >::insert ( const typename D::coord &  dsli,
const typename D::coord &  drow,
const typename D::coord &  dcol 
)
template<typename D>
bool mln::window< D >::is_centered ( ) const

Test if the window is centered.

Returns
True if the delta-point 0 belongs to the window.
template<typename D>
bool mln::window< D >::is_empty ( ) const

Test if the window is empty (null size; no delta-point).

template<typename D>
bool mln::window< D >::is_symmetric ( ) const

Test if the window is symmetric.

 \return True if for every dp of this window, -dp is also in
 this window.
bool mln::internal::window_base< D, window< D > >::is_valid ( ) const
inherited

return true by default.

template<typename D>
void mln::window< D >::print ( std::ostream &  ostr) const

Print the window definition into ostr.

template<typename D>
unsigned mln::window< D >::size ( ) const

Give the window size, i.e., the number of delta-sites.

template<typename D>
const std::vector<D>& mln::window< D >::std_vector ( ) const

Give the std vector of delta-points.

template<typename D>
void mln::window< D >::sym ( )

Apply a central symmetry to the target window.

Friends And Related Function Documentation

template<typename D , unsigned n>
bool operator== ( const static_window< D, n > &  lhs,
const static_window< D, n > &  rhs 
)
related

Equality comparison between windows lhs and rhs.

template<typename D >
bool operator== ( const window< D > &  lhs,
const window< D > &  rhs 
)
related

Equality comparison between windows lhs and rhs.

Member Typedef Documentation

template<typename D>
typedef dpsites_bkd_piter< window<D> > mln::window< D >::bkd_qiter

Site_Iterator type to browse the points of a basic window w.r.t. the reverse ordering of delta-points.

Definition at line 126 of file window.hh.

typedef Window<void> mln::Window< window< D > >::category
inherited

Definition at line 95 of file concept/window.hh.

typedef psite mln::internal::window_base< D, window< D > >::center_t
inherited

Type of the window center.

Definition at line 64 of file window_base.hh.

typedef D mln::internal::window_base< D, window< D > >::dpsite
inherited

DPsite associated type.

Definition at line 55 of file window_base.hh.

typedef window< D > mln::Object< window< D > >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename D>
typedef dpsites_fwd_piter< window<D> > mln::window< D >::fwd_qiter

Site_Iterator type to browse the points of a basic window w.r.t. the ordering of delta-points.

Definition at line 121 of file window.hh.

typedef D ::psite mln::internal::window_base< D, window< D > >::psite
inherited

Psite associated type.

Definition at line 58 of file window_base.hh.

template<typename D>
typedef fwd_qiter mln::window< D >::qiter

Site_Iterator type to browse the points of a basic window whatever the ordering of delta-points.

Definition at line 131 of file window.hh.

template<typename D>
typedef window<D> mln::window< D >::regular

Regular window associated type.

Definition at line 92 of file window.hh.

typedef D ::site mln::internal::window_base< D, window< D > >::site
inherited

Site associated type.

Definition at line 61 of file window_base.hh.