Public Types | Public Member Functions | Private Attributes

mln::internal::neighb_base< W, E > Class Template Reference

Adapter class from window to neighborhood. More...

#include <neighb_base.hh>

Inheritance diagram for mln::internal::neighb_base< W, E >:
Inheritance graph

List of all members.

Public Types

typedef Neighborhood< void > category
typedef W::dpsite dpsite
 Dpsite associated type.
typedef E exact_t
typedef W::psite psite
 Psite associated type.
typedef W::site site
 Site associated type.
typedef W window
 Window associated type.

Public Member Functions

void change_window (const W &new_win)
 Change the corresponding window.
unsigned delta () const
 Give the maximum coordinate gap between the neighborhood center and a neighboring point.
const W::dpsite & dp (unsigned i) const
 Give the maximum coordinate gap between the neighborhood center and a neighboring point.
W & hook_win_ ()
bool is_valid () const
 Return true by default.
 neighb_base ()
 Constructor without argument.
 neighb_base (const W &win)
 Constructor from a window win.
unsigned size () const
 Give the neighborhood size, i.e., the number of elements it contains.
const W & win () const
 Get the corresponding window.

Private Attributes

win_

Detailed Description

template<typename W, typename E>
class mln::internal::neighb_base< W, E >

Adapter class from window to neighborhood.

Template Parameters:
W The underlying window type.
E The exact neighborhood type.

Definition at line 51 of file neighb_base.hh.


Member Typedef Documentation

template<typename E>
typedef Neighborhood<void> mln::Neighborhood< E >::category [inherited]

Reimplemented from mln::Object< E >.

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

template<typename W, typename E>
typedef W ::dpsite mln::internal::neighborhood_base< W, E >::dpsite [inherited]

Dpsite associated type.

Definition at line 125 of file neighborhood_base.hh.

template<typename E>
typedef E mln::Object< E >::exact_t [inherited]

Definition at line 173 of file object.hh.

template<typename W, typename E>
typedef W ::psite mln::internal::neighborhood_base< W, E >::psite [inherited]

Psite associated type.

Definition at line 128 of file neighborhood_base.hh.

template<typename W, typename E>
typedef W ::site mln::internal::neighborhood_base< W, E >::site [inherited]

Site associated type.

Definition at line 131 of file neighborhood_base.hh.

template<typename W, typename E>
typedef W mln::internal::neighborhood_base< W, E >::window [inherited]

Window associated type.

Definition at line 122 of file neighborhood_base.hh.


Constructor & Destructor Documentation

template<typename W , typename E >
mln::internal::neighb_base< W, E >::neighb_base (  )  [inline]

Constructor without argument.

Definition at line 85 of file neighb_base.hh.

template<typename W, typename E >
mln::internal::neighb_base< W, E >::neighb_base ( const W &  win  )  [inline]

Constructor from a window win.

Definition at line 91 of file neighb_base.hh.

References mln::internal::neighb_base< W, E >::change_window().


Member Function Documentation

template<typename W, typename E >
void mln::internal::neighb_base< W, E >::change_window ( const W &  new_win  )  [inline]

Change the corresponding window.

Definition at line 107 of file neighb_base.hh.

References mln::internal::neighb_base< W, E >::win_.

Referenced by mln::convert::over_load::from_to_(), and mln::internal::neighb_base< W, E >::neighb_base().

template<typename W , typename E >
unsigned mln::internal::neighborhood_impl< W, E >::delta (  )  const [inline, inherited]

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

Definition at line 177 of file neighborhood_base.hh.

References mln::exact().

template<typename W , typename E >
const W::dpsite & mln::internal::neighborhood_impl< W, E >::dp ( unsigned  i  )  const [inline, inherited]

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

Definition at line 189 of file neighborhood_base.hh.

References mln::exact().

template<typename W , typename E >
W & mln::internal::neighb_base< W, E >::hook_win_ (  )  [inline]
template<typename W , typename E >
bool mln::internal::neighborhood_base< W, E >::is_valid (  )  const [inline, inherited]

Return true by default.

Definition at line 157 of file neighborhood_base.hh.

template<typename W , typename E >
unsigned mln::internal::neighborhood_impl< W, E >::size (  )  const [inline, inherited]

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

Definition at line 167 of file neighborhood_base.hh.

References mln::exact().

Referenced by mln::c18(), mln::c2(), mln::c26(), mln::c2_3d_sli(), mln::c2_col(), mln::c2_row(), mln::c4(), mln::c4_3d(), mln::c6(), mln::c8(), mln::c8_3d(), and mln::world::inter_pixel::v2v().

template<typename W , typename E >
const W & mln::internal::neighb_base< W, E >::win (  )  const [inline]

Get the corresponding window.

Definition at line 99 of file neighb_base.hh.

References mln::internal::neighb_base< W, E >::win_.


Member Data Documentation

template<typename W, typename E>
W mln::internal::neighb_base< W, E >::win_ [private]