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

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

Public Member Functions

void destroy ()
const p_vertices< G,
internal::vfsite_selector< P,
G >::site_function_t > & 
domain () const
fun::i2v::array< V > function () const
bool has (const psite &p) const
void init_ (const Function_v2v< fun::i2v::array< V > > &f, const Site_Set< p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > > &ps)
bool is_valid () const
typedef mlc_if (is_mutable, mutable_result, typename fun::i2v::array< V >::result) lvalue
std::size_t nsites () const
rvalue operator() (const typename p_vertices< G, internal::vfsite_selector< P, G >::site_function_t >::psite &p) const
lvalue operator() (const typename p_vertices< G, internal::vfsite_selector< P, G >::site_function_t >::psite &p)
rvalue operator() (const psite &p) const
lvalue operator() (const psite &p)
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const
 vertex_image ()
 vertex_image (const p_vertices< G, site_function_t > &pv)
 vertex_image (const p_vertices< G, site_function_t > &pv, const Function_v2v< fun::i2v::array< V > > &vertex_values)
template<typename FV >
 vertex_image (const p_vertices< G, site_function_t > &pv, const Function_v2v< FV > &vertex_values)
rvalue operator() (unsigned v_id) const
lvalue operator() (unsigned v_id)

Protected Attributes

mln::util::tracked_ptr
< internal::data< vertex_image
< P, V, G > > > 
data_

Public Types

typedef p_vertices< G,
internal::vfsite_selector< P,
G >::site_function_t >
::bkd_piter 
bkd_piter
typedef Image< void > category
typedef p_vertices< G,
internal::vfsite_selector< P,
G >::site_function_t
domain_t
typedef vertex_image< P, V, G > exact_t
typedef site_function_t::result function_result_t
typedef fun::i2v::array< V > function_t
typedef p_vertices< G,
internal::vfsite_selector< P,
G >::site_function_t >
::fwd_piter 
fwd_piter
typedef G graph_t
typedef super_::lvalue lvalue
typedef vertex_nbh_t nbh_t
typedef fwd_piter piter
typedef super_::psite psite
typedef super_::rvalue rvalue
typedef p_vertices< G,
site_function_t
S
typedef p_vertices< G,
internal::vfsite_selector< P,
G >::site_function_t >::site 
site
typedef
internal::vfsite_selector< P,
G >::site_function_t 
site_function_t
typedef vertex_image
< tag::psite_< P >
, tag::value_< V >
, tag::graph_< G > > 
skeleton
typedef mln::value::set
< fun::i2v::array< V >::result > 
t_eligible_values_set
typedef mln::value::set
< typename
mln::value::super_value
< fun::i2v::array< V >::result >
::ret
t_values_space
typedef fun::i2v::array< V >
::result 
value
typedef graph_elt_neighborhood
< G, S
vertex_nbh_t
typedef graph_elt_window< G, Svertex_win_t
typedef vertex_win_t win_t

Detailed Description

template<typename P, typename V, typename G = util::graph>
class mln::vertex_image< P, V, G >

Image based on graph vertices.

Definition at line 130 of file core/image/vertex_image.hh.

Constructor & Destructor Documentation

template<typename P, typename V, typename G = util::graph>
mln::vertex_image< P, V, G >::vertex_image ( )

Constructors.

template<typename P, typename V, typename G = util::graph>
mln::vertex_image< P, V, G >::vertex_image ( const p_vertices< G, site_function_t > &  pv)
template<typename P, typename V, typename G = util::graph>
mln::vertex_image< P, V, G >::vertex_image ( const p_vertices< G, site_function_t > &  pv,
const Function_v2v< fun::i2v::array< V > > &  vertex_values 
)
template<typename P, typename V, typename G = util::graph>
template<typename FV >
mln::vertex_image< P, V, G >::vertex_image ( const p_vertices< G, site_function_t > &  pv,
const Function_v2v< FV > &  vertex_values 
)

Member Function Documentation

void mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::destroy ( )
inherited

Detach data from an image (free it if nobody else hold it).

Give the definition domain.

fun::i2v::array< V > mln::pw::internal::image_base< fun::i2v::array< V > , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::function ( ) const
inherited

Return the function which computes a site value.

bool mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::has ( const psite p) const
inherited

Test if p belongs to the image domain.

void mln::pw::internal::image_base< fun::i2v::array< V > , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::init_ ( const Function_v2v< fun::i2v::array< V > > &  f,
const Site_Set< p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > > &  ps 
)
inherited

Initialize an empty image.

bool mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::is_valid ( ) const
inherited

Test if this image has been initialized; default impl.

typedef mln::pw::internal::image_base< fun::i2v::array< V > , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::mlc_if ( is_mutable  ,
mutable_result  ,
typename fun::i2v::array< V > ::result   
)
inherited

Return type of read-write access.

std::size_t mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::nsites ( ) const
inherited

Give the number of sites of the image domain.

rvalue mln::pw::internal::image_base< fun::i2v::array< V > , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::operator() ( const typename p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > ::psite p) const
inherited

Read-only access of pixel value at point site p.

lvalue mln::pw::internal::image_base< fun::i2v::array< V > , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::operator() ( const typename p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > ::psite p)
inherited

Read-write access returns either a temporary value (copy) or a reference in the case of a mutable function (container).

template<typename P, typename V, typename G = util::graph>
rvalue mln::vertex_image< P, V, G >::operator() ( unsigned  v_id) const

Value accessors/operators overloads.

template<typename P, typename V, typename G = util::graph>
lvalue mln::vertex_image< P, V, G >::operator() ( unsigned  v_id)
template<typename P, typename V, typename G = util::graph>
rvalue mln::vertex_image< P, V, G >::operator() ( const psite p) const
template<typename P, typename V, typename G = util::graph>
lvalue mln::vertex_image< P, V, G >::operator() ( const psite p)
const t_eligible_values_set& mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::values_eligible ( ) const
inherited
const t_values_space& mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::values_space ( ) const
inherited

Return the value space of the image.

Member Data Documentation

mln::util::tracked_ptr< internal::data<vertex_image< P, V, G > > > mln::internal::image_base< fun::i2v::array< V >::result , p_vertices< G, internal::vfsite_selector< P, G >::site_function_t > , vertex_image< P, V, G > >::data_
protectedinherited

INTERNAL_API Internal data, sharable by several images.

Definition at line 176 of file core/internal/image_base.hh.

Member Typedef Documentation

Backward Site_Iterator associated type.

Definition at line 122 of file core/internal/image_base.hh.

typedef Image<void> mln::Image< vertex_image< P, V, G > >::category
inherited

Definition at line 78 of file core/concept/image.hh.

Site_Set associated type.

Definition at line 109 of file core/internal/image_base.hh.

typedef vertex_image< P, V, G > mln::Object< vertex_image< P, V, G > >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename P, typename V, typename G = util::graph>
typedef site_function_t ::result mln::vertex_image< P, V, G >::function_result_t

Definition at line 150 of file core/image/vertex_image.hh.

Function associated type.

Definition at line 127 of file pw/internal/image_base.hh.

Forward Site_Iterator associated type.

Definition at line 119 of file core/internal/image_base.hh.

template<typename P, typename V, typename G = util::graph>
typedef G mln::vertex_image< P, V, G >::graph_t

The type of the underlying graph.

Definition at line 145 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef super_::lvalue mln::vertex_image< P, V, G >::lvalue

Definition at line 142 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef vertex_nbh_t mln::vertex_image< P, V, G >::nbh_t

Neighborhood type.

Definition at line 169 of file core/image/vertex_image.hh.

Site_Iterator associated type; default definition is fwd_piter.

Definition at line 127 of file core/internal/image_base.hh.

template<typename P, typename V, typename G = util::graph>
typedef super_::psite mln::vertex_image< P, V, G >::psite

Definition at line 140 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef super_::rvalue mln::vertex_image< P, V, G >::rvalue

Definition at line 141 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef p_vertices<G,site_function_t> mln::vertex_image< P, V, G >::S

Definition at line 158 of file core/image/vertex_image.hh.

Site associated type.

Definition at line 115 of file core/internal/image_base.hh.

template<typename P, typename V, typename G = util::graph>
typedef internal::vfsite_selector<P,G>::site_function_t mln::vertex_image< P, V, G >::site_function_t

Function mapping graph elements to sites.

Definition at line 149 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef vertex_image< tag::psite_<P>, tag::value_<V>, tag::graph_<G> > mln::vertex_image< P, V, G >::skeleton

Skeleton type.

Definition at line 156 of file core/image/vertex_image.hh.

Eligible-value-set associated type.

Definition at line 95 of file core/internal/image_base.hh.

Value space associated type.

Definition at line 102 of file core/internal/image_base.hh.

Value associated type.

Definition at line 130 of file pw/internal/image_base.hh.

template<typename P, typename V, typename G = util::graph>
typedef graph_elt_neighborhood<G,S> mln::vertex_image< P, V, G >::vertex_nbh_t

Vertex Neighborhood type.

Definition at line 164 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef graph_elt_window<G,S> mln::vertex_image< P, V, G >::vertex_win_t

Vertex Window type.

Definition at line 161 of file core/image/vertex_image.hh.

template<typename P, typename V, typename G = util::graph>
typedef vertex_win_t mln::vertex_image< P, V, G >::win_t

Window type.

Definition at line 167 of file core/image/vertex_image.hh.