mln::hexa< I > Struct Template Reference
[Domain morphers]

hexagonal image class. More...

#include <hexa.hh>

Inheritance diagram for mln::hexa< I >:

Inheritance graph

List of all members.

Public Types

typedef hexa_bkd_piter_< box2dbkd_piter
 FIXME : should it be in box2d_h? Backward Site_Iterator associated type.
typedef Image< void > category
typedef I delegatee
 Delegatee associated type.
typedef S domain_t
 Site_Set associated type.
typedef E exact_t
typedef hexa_fwd_piter_< box2dfwd_piter
 FIXME : should it be in box2d_h? Forward Site_Iterator associated type.
typedef I::lvalue lvalue
 Lvalue associated type.
typedef fwd_piter piter
 Site_Iterator associated type; default definition is fwd_piter.
typedef point2d_h psite
 Point site type.
typedef I::rvalue rvalue
 Return type of read-only access.
typedef S::site site
 Site associated type.
typedef hexa< tag::image_< I > > skeleton
 Skeleton.
typedef mln::value::set< I::value > t_eligible_values_set
 Eligible-value-set associated type.
typedef mln::value::set
< typename
mln::value::super_value
< I::value >::ret
t_values_space
 Value space associated type.
typedef I unmorph
 Unmorph image associated type.
typedef I::value value
 Value associated type.

Public Member Functions

I * delegatee_ ()
 Return the delegatee_ pointer (non-const version); default code.
mln::metal::const_< I >::retdelegatee_ () const
 Return the delegatee_ pointer; default code.
void destroy ()
 Detach data from an image (free it if nobody else hold it).
const box2d_hdomain () const
 Give the definition domain.
bool has (const psite &p) const
 Test if p belongs to the image domain.
bool has (const psite &p) const
 Test if p belongs to the image domain.
 hexa (I &ima)
 Constructor with an base image.
 hexa ()
 Constructor without argument.
const util::tracked_ptr
< internal::data< E > > & 
hook_data_ () const
 Hook to the image data.
const void * id_ () const
 Give an identifier of this image.
template<typename P>
unsigned index_of_point (const P &p) const
 Give the offset of the site p.
void init_ (I &ima)
 Initialization.
bool is_valid () const
 Test if this image has been initialized; default impl.
std::size_t nsites () const
 Give the number of sites of the image domain.
lvalue operator() (const typename S::psite &p)
 Read and "write if possible" access of pixel value at point site p.
rvalue operator() (const typename S::psite &p) const
 Read-only access of pixel value at point site p.
lvalue operator() (const point2d_h &p)
 Read-write access of pixel value at hexa point site p.
rvalue operator() (const point2d_h &p) const
 Read-only access of pixel value at hexa point site p.
E & rw ()
 State that the morpher is writable.
mln::metal::const_< I >::retunmorph_ () const
 Give the morphed image (const version).
I & unmorph_ ()
 Give the morphed image (mutable version).
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const
 Return the value space of the image.

Protected Attributes

util::tracked_ptr
< internal::data< E > > 
data_


Detailed Description

template<typename I>
struct mln::hexa< I >

hexagonal image class.

The parameter I is the type of the base image. This image class which handles hexagonal grid.

Ex : 1 3 5 7 9 11 0 2 4 6 8 10 ------------------- 0 XX| | | | | | |XX --------------------- 2 XX| | | | | | |XX --------------------- 4 XX| | | | | | |XX --------------------- 6 XX| | | | | | |XX --------------------- 8 XX| | | | | | |XX -------------------

Definition at line 116 of file hexa.hh.


Member Typedef Documentation

template<typename I>
typedef hexa_bkd_piter_<box2d> mln::hexa< I >::bkd_piter

FIXME : should it be in box2d_h? Backward Site_Iterator associated type.

Reimplemented from mln::internal::image_base< I::value, S, E >.

Definition at line 140 of file hexa.hh.

template<typename E>
typedef Image<void> mln::Image< E >::category [inherited]

Reimplemented from mln::Object< E >.

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

typedef I mln::internal::image_morpher< I , I::value , S , E >::delegatee [inherited]

Delegatee associated type.

Definition at line 57 of file image_morpher.hh.

typedef S mln::internal::image_base< I::value , S , E >::domain_t [inherited]

Site_Set associated type.

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

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

Definition at line 172 of file object.hh.

template<typename I>
typedef hexa_fwd_piter_<box2d> mln::hexa< I >::fwd_piter

FIXME : should it be in box2d_h? Forward Site_Iterator associated type.

Reimplemented from mln::internal::image_base< I::value, S, E >.

Definition at line 136 of file hexa.hh.

template<typename I>
typedef I ::lvalue mln::hexa< I >::lvalue

Lvalue associated type.

Reimplemented from mln::internal::image_domain_morpher< I, S, E >.

Definition at line 126 of file hexa.hh.

typedef fwd_piter mln::internal::image_base< I::value , S , E >::piter [inherited]

Site_Iterator associated type; default definition is fwd_piter.

Reimplemented in mln::ch_piter_image< I, Fwd >.

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

template<typename I>
typedef point2d_h mln::hexa< I >::psite

Point site type.

Reimplemented from mln::internal::image_base< I::value, S, E >.

Reimplemented in mln::image2d_h< V >.

Definition at line 132 of file hexa.hh.

template<typename I>
typedef I ::rvalue mln::hexa< I >::rvalue

Return type of read-only access.

Reimplemented from mln::internal::image_domain_morpher< I, S, E >.

Definition at line 129 of file hexa.hh.

typedef S ::site mln::internal::image_base< I::value , S , E >::site [inherited]

Site associated type.

Reimplemented in mln::tr_image< S, I, T >.

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

template<typename I>
typedef hexa< tag::image_<I> > mln::hexa< I >::skeleton

Skeleton.

Definition at line 120 of file hexa.hh.

typedef mln::value::set<I::value > mln::internal::image_base< I::value , S , E >::t_eligible_values_set [inherited]

Eligible-value-set associated type.

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

typedef mln::value::set< typename mln::value::super_value<I::value >::ret > mln::internal::image_base< I::value , S , E >::t_values_space [inherited]

Value space associated type.

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

typedef I mln::internal::image_morpher< I , I::value , S , E >::unmorph [inherited]

Unmorph image associated type.

Definition at line 68 of file image_morpher.hh.

template<typename I>
typedef I ::value mln::hexa< I >::value

Value associated type.

Reimplemented from mln::internal::image_base< I::value, S, E >.

Definition at line 123 of file hexa.hh.


Constructor & Destructor Documentation

template<typename I>
mln::hexa< I >::hexa (  )  [inline]

Constructor without argument.

Definition at line 215 of file hexa.hh.

template<typename I>
mln::hexa< I >::hexa ( I &  ima  )  [inline]

Constructor with an base image.

Definition at line 222 of file hexa.hh.

References mln::hexa< I >::init_().


Member Function Documentation

I * mln::internal::image_morpher< I , I::value , S , E >::delegatee_ (  )  [inherited]

Return the delegatee_ pointer (non-const version); default code.

mln::metal::const_< I >::ret* mln::internal::image_morpher< I , I::value , S , E >::delegatee_ (  )  const [inherited]

void mln::internal::image_base< I::value , S , E >::destroy (  )  [inherited]

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

Referenced by mln::plain< I >::operator=().

template<typename I>
const box2d_h & mln::hexa< I >::domain (  )  const [inline]

bool mln::internal::image_base< I::value , S , E >::has ( const psite &  p  )  const [inherited]

template<typename I>
bool mln::hexa< I >::has ( const psite p  )  const [inline]

Test if p belongs to the image domain.

Definition at line 259 of file hexa.hh.

References mln::internal::image_base< I::value, S, E >::data_, and mln::internal::image_morpher< I, I::value, S, E >::is_valid().

Referenced by mln::hexa< I >::operator()().

const util::tracked_ptr< internal::data<E > >& mln::internal::image_base< I::value , S , E >::hook_data_ (  )  const [inherited]

Hook to the image data.

Referenced by mln::labeled_image< I >::init_from_().

const void* mln::internal::image_base< I::value , S , E >::id_ (  )  const [inherited]

Give an identifier of this image.

When several image variables designate the same image, they share the same identifier.

template<typename E, typename B>
template<typename P>
unsigned mln::internal::check::image_fastest_< E, B >::index_of_point ( const P &  p  )  const [inline, inherited]

Give the offset of the site p.

Parameters:
[in] p A site.
Warning:
This method is final.
Precondition:
The image has to be initialized and to own the point p.
Postcondition:
p == point_at_index(result)

Definition at line 133 of file internal/check/image_fastest.hh.

template<typename I>
void mln::hexa< I >::init_ ( I &  ima  )  [inline]

bool mln::internal::image_morpher< I , I::value , S , E >::is_valid (  )  const [inherited]

std::size_t mln::internal::image_base< I::value , S , E >::nsites (  )  const [inherited]

Give the number of sites of the image domain.

template<typename I, typename S, typename E>
image_domain_morpher< I, S, E >::lvalue mln::internal::image_domain_morpher< I, S, E >::operator() ( const typename S::psite &  p  )  [inline, inherited]

template<typename I, typename S, typename E>
I::rvalue mln::internal::image_domain_morpher< I, S, E >::operator() ( const typename S::psite &  p  )  const [inline, inherited]

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

Definition at line 86 of file image_domain_morpher.hh.

References mln::exact().

template<typename I>
hexa< I >::lvalue mln::hexa< I >::operator() ( const point2d_h p  )  [inline]

template<typename I>
hexa< I >::rvalue mln::hexa< I >::operator() ( const point2d_h p  )  const [inline]

E & mln::internal::image_morpher< I , I::value , S , E >::rw (  )  [inherited]

State that the morpher is writable.

This allows for C++ to use it as a mutable object even if it is a temporary object.

mln::metal::const_< I >::ret& mln::internal::image_morpher< I , I::value , S , E >::unmorph_ (  )  const [inherited]

Give the morphed image (const version).

I & mln::internal::image_morpher< I , I::value , S , E >::unmorph_ (  )  [inherited]

Give the morphed image (mutable version).

const t_eligible_values_set& mln::internal::image_base< I::value , S , E >::values_eligible (  )  const [inherited]

const t_values_space& mln::internal::image_base< I::value , S , E >::values_space (  )  const [inherited]

Return the value space of the image.


Member Data Documentation

util::tracked_ptr< internal::data<E > > mln::internal::image_base< I::value , S , E >::data_ [protected, inherited]

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

Referenced by mln::labeled_image_base< I, E >::bbox(), mln::labeled_image_base< I, E >::bboxes(), mln::extension_val< I >::change_extension(), mln::decorated_image< I, D >::decorated_image(), mln::decorated_image< I, D >::decoration(), mln::unproject_image< I, D, F >::domain(), mln::transformed_image< I, F >::domain(), mln::tr_image< S, I, T >::domain(), mln::sub_image_if< I, S >::domain(), mln::sub_image< I, S >::domain(), mln::slice_image< I >::domain(), mln::p2p_image< I, F >::domain(), mln::lazy_image< I, F, B >::domain(), mln::image_if< I, F >::domain(), mln::hexa< I >::domain(), mln::extended< I >::domain(), mln::extension_val< I >::extension(), mln::extension_ima< I, J >::extension(), mln::extension_fun< I, F >::extension(), mln::p2p_image< I, F >::fun(), mln::tr_image< S, I, T >::has(), mln::lazy_image< I, F, B >::has(), mln::interpolated< I, F >::has(), mln::hexa< I >::has(), mln::extension_ima< I, J >::has(), mln::unproject_image< I, D, F >::init_(), mln::transformed_image< I, F >::init_(), mln::tr_image< S, I, T >::init_(), mln::sub_image_if< I, S >::init_(), mln::sub_image< I, S >::init_(), mln::slice_image< I >::init_(), mln::safe_image< I >::init_(), mln::plain< I >::init_(), mln::p2p_image< I, F >::init_(), mln::lazy_image< I, F, B >::init_(), mln::labeled_image< I >::init_(), mln::interpolated< I, F >::init_(), mln::image_if< I, F >::init_(), mln::hexa< I >::init_(), mln::extension_val< I >::init_(), mln::extension_ima< I, J >::init_(), mln::extension_fun< I, F >::init_(), mln::extended< I >::init_(), mln::decorated_image< I, D >::init_(), mln::ch_piter_image< I, Fwd >::init_(), mln::labeled_image< I >::init_from_(), mln::interpolated< I, F >::is_valid(), mln::labeled_image< I >::labeled_image(), mln::lazy_image< I, F, B >::lazy_image(), mln::decorated_image< I, D >::operator decorated_image< const I, D >(), mln::plain< I >::operator I(), mln::image_if< I, F >::operator image_if< const I, F >(), mln::safe_image< I >::operator safe_image< const I >(), mln::slice_image< I >::operator slice_image< const I >(), mln::sub_image< I, S >::operator sub_image< const I, S >(), mln::transformed_image< I, F >::operator transformed_image< const I, F >(), mln::unproject_image< I, D, F >::operator()(), mln::transformed_image< I, F >::operator()(), mln::tr_image< S, I, T >::operator()(), mln::slice_image< I >::operator()(), mln::p2p_image< I, F >::operator()(), mln::hexa< I >::operator()(), mln::extension_ima< I, J >::operator()(), mln::extension_fun< I, F >::operator()(), mln::plain< I >::operator=(), mln::plain< I >::plain(), mln::decorated_image< I, D >::read_(), mln::labeled_image_base< I, E >::relabel(), mln::tr_image< S, I, T >::set_tr(), mln::slice_image< I >::sli(), mln::labeled_image_base< I, E >::subdomain(), mln::tr_image< S, I, T >::tr(), and mln::labeled_image_base< I, E >::update_data().


Generated on Sun Apr 25 01:55:28 2010 for Milena (Olena) by  doxygen 1.5.6