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

#include <mln/topo/is_simple_pair.hh>

Public Member Functions

bool operator() (const typename I::psite &f, const typename I::psite &g) const
bool operator() (const typename I::psite &f) const
void set_image (const mln::Image< I > &ima)
 is_simple_pair (const Neighborhood< NL > &lower_adj_nbh, const Neighborhood< NH > &higher_adj_nbh)
 is_simple_pair (const mln::Image< I > &ima, const Neighborhood< NL > &lower_adj_nbh, const Neighborhood< NH > &higher_adj_nbh)

Public Types

typedef Function_v2b< void > category
typedef is_simple_pair< I, NL, NH > exact_t
typedef void mutable_result
typedef bool result

Detailed Description

template<typename I, typename NL, typename NH>
class mln::topo::is_simple_pair< I, NL, NH >

A predicate for the simplicity of a pair (or a face that might belong to a simple pair).

The functor may either take a pair composed of an n-face F and an (n-1)-face G (where F is a facet), or just a single facet F. In this latter case, it tries to find an (n-1)-face G so that (F, G) form a simple pair.

Template Parameters
IThe type of the image.
NLThe neighborhood type returning the set of (n-1)-faces adjacent to a an n-face.
NHThe neighborhood type returning the set of (n+1)-faces adjacent to a an n-face.

Definition at line 60 of file is_simple_pair.hh.

Constructor & Destructor Documentation

template<typename I , typename NL , typename NH >
mln::topo::is_simple_pair< I, NL, NH >::is_simple_pair ( const Neighborhood< NL > &  lower_adj_nbh,
const Neighborhood< NH > &  higher_adj_nbh 
)

Constructors.

Construct an mln::topo::is_simple_pair from a couple of neighborhoods.

Parameters
lower_adj_nbhAn adjacency relationship between faces returning the set of (n-1)-faces adjacent to a given n-face.
higher_adj_nbhAn adjacency relationship between faces returning the set of (n+1)-faces adjacent to a given n-face.
template<typename I , typename NL , typename NH >
mln::topo::is_simple_pair< I, NL, NH >::is_simple_pair ( const mln::Image< I > &  ima,
const Neighborhood< NL > &  lower_adj_nbh,
const Neighborhood< NH > &  higher_adj_nbh 
)

Construct an mln::topo::detach_pair from an image and a couple of neighborhoods.

Precondition
ima is an image of Boolean values.
Parameters
imaThe input image the pair belongs to.
lower_adj_nbhAn adjacency relationship between faces returning the set of (n-1)-faces adjacent to a given n-face.
higher_adj_nbhAn adjacency relationship between faces returning the set of (n+1)-faces adjacent to a given n-face.

Member Function Documentation

template<typename I , typename NL , typename NH >
bool mln::topo::is_simple_pair< I, NL, NH >::operator() ( const typename I::psite &  f,
const typename I::psite &  g 
) const

Test whether the pair (f, g) is simple.

If f is not a facet, return false. If g is not a (n-1)-face adjacent to the n-face f, return false.

template<typename I , typename NL , typename NH >
bool mln::topo::is_simple_pair< I, NL, NH >::operator() ( const typename I::psite &  f) const

Test whether f is part of a simple pair.

If f is not a facet, return false.

template<typename I , typename NL , typename NH >
void mln::topo::is_simple_pair< I, NL, NH >::set_image ( const mln::Image< I > &  ima)

Set the underlying image.

Member Typedef Documentation

typedef Function_v2b<void> mln::Function_v2b< is_simple_pair< I, NL, NH > >::category
inherited

Definition at line 162 of file function.hh.

typedef is_simple_pair< I, NL, NH > mln::Object< is_simple_pair< I, NL, NH > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef void mln::Function_v2v< is_simple_pair< I, NL, NH > >::mutable_result
inherited

Definition at line 135 of file function.hh.

template<typename I , typename NL , typename NH >
typedef bool mln::topo::is_simple_pair< I, NL, NH >::result

Result type of the functor.

Definition at line 65 of file is_simple_pair.hh.