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

#include <mln/core/image/dmorph/hexa.hh>

Public Member Functions

 hexa ()
 hexa (I &ima)
mln::metal::const_< I >::retdelegatee_ () const
I * delegatee_ ()
void destroy ()
const box2d_hdomain () const
bool has (const psite &p) const
bool has (const psite &p) const
void init_ (I &ima)
bool is_valid () const
std::size_t nsites () const
rvalue operator() (const typename box2d_h::psite &p) const
lvalue operator() (const typename box2d_h::psite &p)
rvalue operator() (const point2d_h &p) const
lvalue operator() (const point2d_h &p)
hexa< I > & rw ()
I & unmorph_ ()
mln::metal::const_< I >::retunmorph_ () const
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const

Protected Attributes

mln::util::tracked_ptr
< internal::data< hexa< I > > > 
data_

Public Types

typedef hexa_bkd_piter_< box2dbkd_piter
typedef Image< void > category
typedef I delegatee
typedef box2d_h domain_t
typedef hexa< I > exact_t
typedef hexa_fwd_piter_< box2dfwd_piter
typedef I::lvalue lvalue
typedef fwd_piter piter
typedef point2d_h psite
typedef I::rvalue rvalue
typedef box2d_h::site site
typedef hexa< tag::image_< I > > skeleton
typedef mln::value::set< I::value > t_eligible_values_set
typedef mln::value::set
< typename
mln::value::super_value
< I::value >::ret
t_values_space
typedef I unmorph
typedef I::value value

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 121 of file hexa.hh.

Constructor & Destructor Documentation

template<typename I>
mln::hexa< I >::hexa ( )

Constructor without argument.

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

Constructor with an base image.

Member Function Documentation

mln::metal::const_< I >::ret* mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::delegatee_ ( ) const
inherited

INTERNAL_API Return the delegatee_ pointer; default code.

I* mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::delegatee_ ( )
inherited

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

void mln::internal::image_base< I::value , box2d_h , hexa< I > >::destroy ( )
inherited

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

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

Give the definition domain.

bool mln::internal::image_base< I::value , box2d_h , hexa< I > >::has ( const psite p) const
inherited

Test if p belongs to the image domain.

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

Test if p belongs to the image domain.

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

INTERNAL_API Initialization.

bool mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::is_valid ( ) const
inherited

Test if this image has been initialized; default impl.

Reimplemented from mln::internal::image_base< I::value, box2d_h, hexa< I > >.

std::size_t mln::internal::image_base< I::value , box2d_h , hexa< I > >::nsites ( ) const
inherited

Give the number of sites of the image domain.

rvalue mln::internal::image_domain_morpher< I, box2d_h , hexa< I > >::operator() ( const typename box2d_h ::psite p) const
inherited

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

lvalue mln::internal::image_domain_morpher< I, box2d_h , hexa< I > >::operator() ( const typename box2d_h ::psite p)
inherited

Read and "write if possible" access of pixel value at point site p.

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

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

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

Read-write access of pixel value at hexa point site p.

hexa< I > & mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::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.

I& mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::unmorph_ ( )
inherited

INTERNAL_API Give the morphed image (mutable version).

mln::metal::const_< I >::ret& mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::unmorph_ ( ) const
inherited

Give the morphed image (const version).

const t_eligible_values_set& mln::internal::image_base< I::value , box2d_h , hexa< I > >::values_eligible ( ) const
inherited
const t_values_space& mln::internal::image_base< I::value , box2d_h , hexa< I > >::values_space ( ) const
inherited

Return the value space of the image.

Member Data Documentation

mln::util::tracked_ptr< internal::data<hexa< I > > > mln::internal::image_base< I::value , box2d_h , hexa< I > >::data_
protectedinherited

INTERNAL_API Internal data, sharable by several images.

Definition at line 176 of file core/internal/image_base.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.

Definition at line 145 of file hexa.hh.

typedef Image<void> mln::Image< hexa< I > >::category
inherited

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

typedef I mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::delegatee
inherited

Delegatee associated type.

Definition at line 60 of file image_morpher.hh.

typedef box2d_h mln::internal::image_base< I::value , box2d_h , hexa< I > >::domain_t
inherited

Site_Set associated type.

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

typedef hexa< I > mln::Object< hexa< I > >::exact_t
inherited

Definition at line 105 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.

Definition at line 141 of file hexa.hh.

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

Lvalue associated type.

Definition at line 131 of file hexa.hh.

typedef fwd_piter mln::internal::image_base< I::value , box2d_h , hexa< I > >::piter
inherited

Site_Iterator associated type; default definition is fwd_piter.

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

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

Point site type.

Definition at line 137 of file hexa.hh.

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

Return type of read-only access.

Definition at line 134 of file hexa.hh.

typedef box2d_h ::site mln::internal::image_base< I::value , box2d_h , hexa< I > >::site
inherited

Site associated type.

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

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

Skeleton.

Definition at line 125 of file hexa.hh.

typedef mln::value::set<I::value > mln::internal::image_base< I::value , box2d_h , hexa< I > >::t_eligible_values_set
inherited

Eligible-value-set associated type.

Definition at line 95 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 , box2d_h , hexa< I > >::t_values_space
inherited

Value space associated type.

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

typedef I mln::internal::image_morpher< I, I::value , box2d_h , hexa< I > >::unmorph
inherited

Unmorph image associated type.

Definition at line 72 of file image_morpher.hh.

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

Value associated type.

Definition at line 128 of file hexa.hh.