Public Types | Public Member Functions

mln::graph_elt_window_if< G, S, I > Class Template Reference

Custom window on graph class. More...

#include <graph_elt_window_if.hh>

Inheritance diagram for mln::graph_elt_window_if< G, S, I >:
Inheritance graph

List of all members.

Public Types

typedef I mask_t
 The type of the image used as mask.

typedef S target
 @}
typedef target::psite psite
 The type of psite corresponding to the window.
typedef graph_window_if_piter
< target, self_, nbh_fwd_iter_ > 
fwd_qiter
 Site_Iterator type to browse the psites of the window w.r.t.
typedef graph_window_if_piter
< target, self_, nbh_bkd_iter_ > 
bkd_qiter
 Site_Iterator type to browse the psites of the window w.r.t.
typedef fwd_qiter qiter
 The default qiter type.

typedef S::fun_t::result site
 Associated types.

Public Member Functions

void change_mask (const Image< I > &mask)
 Change mask image.
 graph_elt_window_if ()
 Constructor.
 graph_elt_window_if (const Image< I > &mask)
bool is_valid () const
 Return true by default.
const I & mask () const
 Return the graph image used as mask.

bool is_empty () const
 Interface of the concept Window.
bool is_centered () const
 Is the window centered?
bool is_symmetric () const
 Is the window symmetric?
unsigned delta () const
 Return the maximum coordinate gap between the window center and a window point.
self_sym ()
 Apply a central symmetry to the target window.

Detailed Description

template<typename G, typename S, typename I>
class mln::graph_elt_window_if< G, S, I >

Custom window on graph class.

It is defined thanks to a mask.

G is the graph type. S is the image site set. I is the graph image the type used as mask.

Definition at line 105 of file graph_elt_window_if.hh.


Member Typedef Documentation

template<typename G , typename S , typename I >
typedef graph_window_if_piter<target,self_,nbh_bkd_iter_> mln::graph_elt_window_if< G, S, I >::bkd_qiter

Site_Iterator type to browse the psites of the window w.r.t.

the reverse ordering of vertices.

Definition at line 147 of file graph_elt_window_if.hh.

template<typename G , typename S , typename I >
typedef graph_window_if_piter<target,self_,nbh_fwd_iter_> mln::graph_elt_window_if< G, S, I >::fwd_qiter

Site_Iterator type to browse the psites of the window w.r.t.

the ordering of vertices.

Definition at line 143 of file graph_elt_window_if.hh.

template<typename G , typename S , typename I >
typedef I mln::graph_elt_window_if< G, S, I >::mask_t

The type of the image used as mask.

Definition at line 119 of file graph_elt_window_if.hh.

template<typename G , typename S , typename I >
typedef target ::psite mln::graph_elt_window_if< G, S, I >::psite

The type of psite corresponding to the window.

Definition at line 139 of file graph_elt_window_if.hh.

template<typename G , typename S , typename I >
typedef fwd_qiter mln::graph_elt_window_if< G, S, I >::qiter

The default qiter type.

Definition at line 150 of file graph_elt_window_if.hh.

typedef S::fun_t::result mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::site [inherited]

Associated types.

The type of site corresponding to the window.

Definition at line 48 of file graph_window_base.hh.

template<typename G , typename S , typename I >
typedef S mln::graph_elt_window_if< G, S, I >::target

@}

Associated types. The image domain on which this window iterates on.

Definition at line 136 of file graph_elt_window_if.hh.


Constructor & Destructor Documentation

template<typename G , typename S , typename I >
mln::graph_elt_window_if< G, S, I >::graph_elt_window_if (  )  [inline]

Constructor.

@{ Default. Construct an invalid window.

Definition at line 174 of file graph_elt_window_if.hh.

template<typename G , typename S , typename I >
mln::graph_elt_window_if< G, S, I >::graph_elt_window_if ( const Image< I > &  mask  )  [inline]
Parameters:
[in] mask A graph image of bool.
See also:
vertex_image, edge_image.

Definition at line 181 of file graph_elt_window_if.hh.


Member Function Documentation

template<typename G , typename S , typename I >
void mln::graph_elt_window_if< G, S, I >::change_mask ( const Image< I > &  mask  )  [inline]

Change mask image.

Definition at line 199 of file graph_elt_window_if.hh.

References mln::graph_elt_window_if< G, S, I >::is_valid().

unsigned mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::delta (  )  const [inherited]

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

bool mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::is_centered (  )  const [inherited]

Is the window centered?

bool mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::is_empty (  )  const [inherited]

Interface of the concept Window.

Is the window is empty?

bool mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::is_symmetric (  )  const [inherited]

Is the window symmetric?

template<typename G , typename S , typename I >
bool mln::graph_elt_window_if< G, S, I >::is_valid (  )  const [inline]
template<typename G , typename S , typename I >
const I & mln::graph_elt_window_if< G, S, I >::mask (  )  const [inline]

Return the graph image used as mask.

Definition at line 190 of file graph_elt_window_if.hh.

self_& mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::sym (  )  [inherited]

Apply a central symmetry to the target window.