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

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

Public Member Functions

void change_mask (const Image< I > &mask)
bool is_valid () const
const I & mask () const
Constructors.
 graph_elt_window_if ()
 graph_elt_window_if (const Image< I > &mask)
bool is_empty () const
bool is_centered () const
bool is_symmetric () const
unsigned delta () const
self_sym ()
bool is_neighbable_ () const

Public Types

typedef Window< void > category
typedef graph_elt_window_if< G,
S, I > 
exact_t
typedef I mask_t
Associated types.
typedef S target
typedef target::psite psite
typedef graph_window_if_piter
< target, self_, nbh_fwd_iter_ > 
fwd_qiter
typedef graph_window_if_piter
< target, self_, nbh_bkd_iter_ > 
bkd_qiter
typedef fwd_qiter qiter
typedef S::fun_t::result site
typedef void dpsite

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 106 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 ( )

Default. Construct an invalid window.

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

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)

Change mask image.

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_neighbable_ ( ) const
inherited

Is the window neighbable?

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

Return true by default.

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

Return the graph image used as mask.

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.

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 150 of file graph_elt_window_if.hh.

typedef Window<void> mln::Window< graph_elt_window_if< G, S, I > >::category
inherited

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

typedef void mln::graph_window_base< S::fun_t::result , graph_elt_window_if< G, S, I > >::dpsite
inherited

Definition at line 57 of file graph_window_base.hh.

typedef graph_elt_window_if< G, S, I > mln::Object< graph_elt_window_if< G, S, I > >::exact_t
inherited

Definition at line 105 of file object.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 146 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 120 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 142 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 153 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 54 of file graph_window_base.hh.

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

The image domain on which this window iterates on.

Definition at line 139 of file graph_elt_window_if.hh.