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

#include <mln/core/image/graph_elt_neighborhood_if.hh>

Public Member Functions

void change_window (const W &new_win)
unsigned delta () const
const W::dpsite & dp (unsigned i) const
W & hook_win_ ()
bool is_valid () const
const I & mask () const
unsigned size () const
const W & win () const
Constructors.
 graph_elt_neighborhood_if ()
 graph_elt_neighborhood_if (const Image< I > &mask)

Public Types

typedef neighb_bkd_niter
< graph_elt_window_if< G, S, I > > 
bkd_niter
typedef Neighborhood< void > category
typedef W::dpsite dpsite
typedef E exact_t
typedef neighb_fwd_niter
< graph_elt_window_if< G, S, I > > 
fwd_niter
typedef fwd_niter niter
typedef W::psite psite
typedef W::site site
typedef neighb
< graph_elt_window_if< G, S, I > > 
super_
typedef W window

Related Functions

(Note that these are not member functions.)

template<typename I , typename N >
util::array< intnegative_offsets_wrt (const Image< I > &ima, const Neighborhood< N > &nbh)
template<typename I , typename N >
util::array< intoffsets_wrt (const Image< I > &ima, const Neighborhood< N > &nbh)
template<typename N >
std::ostream & operator<< (std::ostream &ostr, const Neighborhood< N > &nbh)
template<typename L , typename R >
bool operator== (const Neighborhood< L > &lhs, const Neighborhood< R > &rhs)
template<typename I , typename N >
util::array< intpositive_offsets_wrt (const Image< I > &ima, const Neighborhood< N > &nbh)

Detailed Description

template<typename G, typename S, typename I>
struct mln::graph_elt_neighborhood_if< G, S, I >

Elementary neighborhood_if on graph class.

Definition at line 43 of file graph_elt_neighborhood_if.hh.

Constructor & Destructor Documentation

template<typename G , typename S , typename I >
mln::graph_elt_neighborhood_if< G, S, I >::graph_elt_neighborhood_if ( )

Construct an invalid neighborhood.

template<typename G , typename S , typename I >
mln::graph_elt_neighborhood_if< G, S, I >::graph_elt_neighborhood_if ( const Image< I > &  mask)
Parameters
[in]maskA graph image of Boolean.

Member Function Documentation

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

Change the corresponding window.

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

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

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

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

template<typename W, typename E>
W& mln::internal::neighb_base< W, E >::hook_win_ ( )
inherited

INTERNAL_API

Hook to the window.

template<typename W, typename E>
bool mln::internal::neighborhood_base< W, E >::is_valid ( ) const
inherited

Return true by default.

template<typename G , typename S , typename I >
const I& mln::graph_elt_neighborhood_if< G, S, I >::mask ( ) const

Return the graph image used as mask.

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

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

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

Get the corresponding window.

Friends And Related Function Documentation

template<typename I , typename N >
util::array< int > negative_offsets_wrt ( const Image< I > &  ima,
const Neighborhood< N > &  nbh 
)
related
template<typename I , typename N >
util::array< int > offsets_wrt ( const Image< I > &  ima,
const Neighborhood< N > &  nbh 
)
related
template<typename N >
std::ostream & operator<< ( std::ostream &  ostr,
const Neighborhood< N > &  nbh 
)
related
template<typename L , typename R >
bool operator== ( const Neighborhood< L > &  lhs,
const Neighborhood< R > &  rhs 
)
related
template<typename I , typename N >
util::array< int > positive_offsets_wrt ( const Image< I > &  ima,
const Neighborhood< N > &  nbh 
)
related

Member Typedef Documentation

typedef neighb_bkd_niter<graph_elt_window_if< G, S, I > > mln::neighb< graph_elt_window_if< G, S, I > >::bkd_niter
inherited

Backward site iterator associated type.

Definition at line 69 of file neighb.hh.

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

Definition at line 69 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 129 of file neighborhood_base.hh.

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

Definition at line 105 of file object.hh.

typedef neighb_fwd_niter<graph_elt_window_if< G, S, I > > mln::neighb< graph_elt_window_if< G, S, I > >::fwd_niter
inherited

Forward site iterator associated type.

Definition at line 66 of file neighb.hh.

typedef fwd_niter mln::neighb< graph_elt_window_if< G, S, I > >::niter
inherited

Site iterator associated type.

Definition at line 72 of file neighb.hh.

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

Psite associated type.

Definition at line 132 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 135 of file neighborhood_base.hh.

template<typename G , typename S , typename I >
typedef neighb< graph_elt_window_if<G,S,I> > mln::graph_elt_neighborhood_if< G, S, I >::super_

Definition at line 46 of file graph_elt_neighborhood_if.hh.

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

Window associated type.

Definition at line 126 of file neighborhood_base.hh.