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

#include <apps/bench/static_window.hh>

Public Member Functions

 static_window (const mln::util::static_array< D, n > &dps)
unsigned delta () const
const D & dp (unsigned i) const
const mln::util::static_array
< D, n > & 
dps_hook_ () const
bool has (const D &dp) const
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
void sym ()

Public Types

enum  { length = n }
typedef dpsites_bkd_piter
< static_window< D, n > > 
bkd_qiter
typedef Window< void > category
typedef psite center_t
typedef D dpsite
typedef static_window< D, n > exact_t
typedef dpsites_fwd_piter
< static_window< D, n > > 
fwd_qiter
typedef D::psite psite
typedef fwd_qiter qiter
typedef static_window< D, n > regular
typedef D::site site

Detailed Description

template<typename D, unsigned n>
class mln::static_window< D, n >

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 89 of file static_window.hh.

Constructor & Destructor Documentation

template<typename D, unsigned n>
mln::static_window< D, n >::static_window ( const mln::util::static_array< D, n > &  dps)

Member Function Documentation

template<typename D, unsigned n>
unsigned mln::static_window< D, n >::delta ( ) const

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

template<typename D, unsigned n>
const D& mln::static_window< D, n >::dp ( unsigned  i) const

Give the i-th delta-point.

template<typename D, unsigned n>
const mln::util::static_array<D, n>& mln::static_window< D, n >::dps_hook_ ( ) const

Hook to the set of D.

template<typename D, unsigned n>
bool mln::static_window< D, n >::has ( const D &  dp) const

Test if dp is in this window definition.

template<typename D, unsigned n>
bool mln::static_window< D, n >::is_centered ( ) const

Test if the window is centered.

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

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

template<typename D, unsigned n>
bool mln::static_window< D, n >::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, static_window< D, n > >::is_valid ( ) const
inherited

return true by default.

template<typename D, unsigned n>
void mln::static_window< D, n >::print ( std::ostream &  ostr) const

Print the window definition into ostr.

template<typename D, unsigned n>
unsigned mln::static_window< D, n >::size ( ) const

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

template<typename D, unsigned n>
void mln::static_window< D, n >::sym ( )

Apply a central symmetry to the target window.

Member Typedef Documentation

template<typename D, unsigned n>
typedef dpsites_bkd_piter< static_window<D, n> > mln::static_window< D, n >::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 static_window.hh.

typedef Window<void> mln::Window< static_window< D, n > >::category
inherited

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

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

Type of the window center.

Definition at line 64 of file window_base.hh.

typedef D mln::internal::window_base< D, static_window< D, n > >::dpsite
inherited

DPsite associated type.

Definition at line 55 of file window_base.hh.

typedef static_window< D, n > mln::Object< static_window< D, n > >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename D, unsigned n>
typedef dpsites_fwd_piter< static_window<D, n> > mln::static_window< D, n >::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 static_window.hh.

typedef D ::psite mln::internal::window_base< D, static_window< D, n > >::psite
inherited

Psite associated type.

Definition at line 58 of file window_base.hh.

template<typename D, unsigned n>
typedef fwd_qiter mln::static_window< D, n >::qiter

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

Definition at line 131 of file static_window.hh.

template<typename D, unsigned n>
typedef static_window<D, n> mln::static_window< D, n >::regular

Regular window associated type.

Definition at line 96 of file static_window.hh.

typedef D ::site mln::internal::window_base< D, static_window< D, n > >::site
inherited

Site associated type.

Definition at line 61 of file window_base.hh.

Member Enumeration Documentation

template<typename D, unsigned n>
anonymous enum
Enumerator:
length 

Definition at line 93 of file static_window.hh.