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

#include <mln/core/neighb.hh>

Public Member Functions

 neighb ()
 neighb (const W &win)
void change_window (const W &new_win)
unsigned delta () const
const W::dpsite & dp (unsigned i) const
W & hook_win_ ()
bool is_valid () const
unsigned size () const
const W & win () const

Public Types

typedef neighb_bkd_niter< W > bkd_niter
typedef Neighborhood< void > category
typedef W::dpsite dpsite
typedef neighb< W > exact_t
typedef neighb_fwd_niter< W > fwd_niter
typedef fwd_niter niter
typedef W::psite psite
typedef W::site site
typedef W window

Detailed Description

template<typename W>
class mln::neighb< W >

Adapter class from window to neighborhood.

Definition at line 58 of file neighb.hh.

Constructor & Destructor Documentation

template<typename W>
mln::neighb< W >::neighb ( )

Constructor without argument.

template<typename W>
mln::neighb< W >::neighb ( const W &  win)

Constructor from a window win.

Member Function Documentation

void mln::internal::neighb_base< W, neighb< W > >::change_window ( const W &  new_win)
inherited

Change the corresponding window.

unsigned mln::internal::neighborhood_impl< W, neighb< W > >::delta ( ) const
inherited

Give the maximum coordinate gap between the neighborhood center and a neighboring point.

const W ::dpsite& mln::internal::neighborhood_impl< W, neighb< W > >::dp ( unsigned  i) const
inherited

Give the maximum coordinate gap between the neighborhood center and a neighboring point.

W& mln::internal::neighb_base< W, neighb< W > >::hook_win_ ( )
inherited

INTERNAL_API

Hook to the window.

bool mln::internal::neighborhood_base< W, neighb< W > >::is_valid ( ) const
inherited

Return true by default.

unsigned mln::internal::neighborhood_impl< W, neighb< W > >::size ( ) const
inherited

Give the neighborhood size, i.e., the number of elements it contains.

const W& mln::internal::neighb_base< W, neighb< W > >::win ( ) const
inherited

Get the corresponding window.

Member Typedef Documentation

template<typename W>
typedef neighb_bkd_niter<W> mln::neighb< W >::bkd_niter

Backward site iterator associated type.

Definition at line 69 of file neighb.hh.

typedef Neighborhood<void> mln::Neighborhood< neighb< W > >::category
inherited

Definition at line 69 of file core/concept/neighborhood.hh.

typedef W ::dpsite mln::internal::neighborhood_base< W, neighb< W > >::dpsite
inherited

Dpsite associated type.

Definition at line 129 of file neighborhood_base.hh.

typedef neighb< W > mln::Object< neighb< W > >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename W>
typedef neighb_fwd_niter<W> mln::neighb< W >::fwd_niter

Forward site iterator associated type.

Definition at line 66 of file neighb.hh.

template<typename W>
typedef fwd_niter mln::neighb< W >::niter

Site iterator associated type.

Definition at line 72 of file neighb.hh.

typedef W ::psite mln::internal::neighborhood_base< W, neighb< W > >::psite
inherited

Psite associated type.

Definition at line 132 of file neighborhood_base.hh.

typedef W ::site mln::internal::neighborhood_base< W, neighb< W > >::site
inherited

Site associated type.

Definition at line 135 of file neighborhood_base.hh.

typedef W mln::internal::neighborhood_base< W, neighb< W > >::window
inherited

Window associated type.

Definition at line 126 of file neighborhood_base.hh.