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

#include <mln/core/w_window.hh>

Public Member Functions

 w_window ()
void clear ()
unsigned delta () const
const mln::window< D >::dpsitedp (unsigned i) const
bool has (const typename mln::window< D >::dpsite &dp) const
w_window< D, W > & insert (const W &w, const D &d)
bool is_centered () const
bool is_empty () const
bool is_symmetric () const
bool is_valid () const
unsigned size () const
const std::vector< D > & std_vector () const
void sym ()
w (unsigned i) const
const std::vector< W > & weights () const
const mln::window< D > & win () const

Protected Attributes

std::vector< W > wei_
mln::window< D > win_

Public Types

typedef with_w_
< dpsites_bkd_piter< w_window
< D, W > >, W > 
bkd_qiter
typedef Weighted_Window< void > category
typedef D dpsite
typedef w_window< D, W > exact_t
typedef with_w_
< dpsites_fwd_piter< w_window
< D, W > >, W > 
fwd_qiter
typedef mln::window< D >::psite psite
typedef mln::window< D >::site site
typedef W weight
typedef mln::window< D > window

Related Functions

(Note that these are not member functions.)

template<typename D , typename W >
std::ostream & operator<< (std::ostream &ostr, const w_window< D, W > &w_win)
template<typename D , typename Wl , typename Wr >
bool operator== (const w_window< D, Wl > &lhs, const w_window< D, Wr > &rhs)

Detailed Description

template<typename D, typename W>
struct mln::w_window< D, W >

Generic w_window class.

This type of w_window is just like a set of delta-points. The parameter D is the type of delta-points; the parameter W is the type of weights.

Definition at line 78 of file core/w_window.hh.

Constructor & Destructor Documentation

template<typename D, typename W>
mln::w_window< D, W >::w_window ( )

Constructor without argument.

Member Function Documentation

template<typename D, typename W>
void mln::w_window< D, W >::clear ( )

Clear this window.

unsigned mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::delta ( ) const
inherited

Give the maximum coordinate gap; final method.

This method is valid iff the support is regular and the definition is not varying.

const mln::window< D > ::dpsite& mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::dp ( unsigned  i) const
inherited

Give the i-th delta-point; final method.

This method is valid iff the support is regular and the definition is unique.

bool mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::has ( const typename mln::window< D > ::dpsite dp) const
inherited

Test if the dp delta-point is in this window; final method.

This method is valid iff the support is regular and the definition is unique.

template<typename D, typename W>
w_window<D,W>& mln::w_window< D, W >::insert ( const W &  w,
const D &  d 
)

Insert a couple of weight w and delta-point d.

bool mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::is_centered ( ) const
inherited

Test if the weighted window is centered; final method.

This method is valid iff the support is regular and the definition is not varying.

bool mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::is_empty ( ) const
inherited

Test if the weighted window is empty; final method.

template<typename D, typename W>
bool mln::w_window< D, W >::is_symmetric ( ) const

Test if the window is symmetric.

bool mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::is_valid ( ) const
inherited

return true by default.

unsigned mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::size ( ) const
inherited

Give the window size; final method.

This method is valid iff the underlying window has a fixed size.

template<typename D, typename W>
const std::vector<D>& mln::w_window< D, W >::std_vector ( ) const

Give access to the vector of delta-points.

template<typename D, typename W>
void mln::w_window< D, W >::sym ( )

Apply a central symmetry to the window.

template<typename D, typename W>
W mln::w_window< D, W >::w ( unsigned  i) const

Give the i-th weight.

template<typename D, typename W>
const std::vector<W>& mln::w_window< D, W >::weights ( ) const

Give access to the vector of weights.

template<typename D, typename W>
const mln::window<D>& mln::w_window< D, W >::win ( ) const

Give the corresponding window.

Friends And Related Function Documentation

template<typename D , typename W >
std::ostream & operator<< ( std::ostream &  ostr,
const w_window< D, W > &  w_win 
)
related

Print a weighted window w_win into an output stream ostr.

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

Equality test between two weighted windows lhs and rhs.

Member Data Documentation

template<typename D, typename W>
std::vector<W> mln::w_window< D, W >::wei_
protected

Definition at line 129 of file core/w_window.hh.

template<typename D, typename W>
mln::window<D> mln::w_window< D, W >::win_
protected

Definition at line 128 of file core/w_window.hh.

Member Typedef Documentation

template<typename D, typename W>
typedef with_w_< dpsites_bkd_piter< w_window<D, W> >, W > mln::w_window< D, W >::bkd_qiter

Site_Iterator type to browse (backward) the points of a generic w_window.

Definition at line 92 of file core/w_window.hh.

typedef Weighted_Window<void> mln::Weighted_Window< w_window< D, W > >::category
inherited

Definition at line 72 of file weighted_window.hh.

template<typename D, typename W>
typedef D mln::w_window< D, W >::dpsite

Dpsite associated type.

Definition at line 82 of file core/w_window.hh.

typedef w_window< D, W > mln::Object< w_window< D, W > >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename D, typename W>
typedef with_w_< dpsites_fwd_piter< w_window<D, W> >, W > mln::w_window< D, W >::fwd_qiter

Site_Iterator type to browse (forward) the points of a generic w_window.

Definition at line 89 of file core/w_window.hh.

typedef mln::window< D > ::psite mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::psite
inherited

Psite associated type.

Definition at line 60 of file weighted_window_base.hh.

typedef mln::window< D > ::site mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::site
inherited

Site associated type.

Definition at line 63 of file weighted_window_base.hh.

template<typename D, typename W>
typedef W mln::w_window< D, W >::weight

Weight associated type.

Definition at line 85 of file core/w_window.hh.

typedef mln::window< D > mln::internal::weighted_window_base< mln::window< D > , w_window< D, W > >::window
inherited

Window associated type.

Definition at line 54 of file weighted_window_base.hh.