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

#include <mln/core/image/imorph/decorated_image.hh>

Public Member Functions

 decorated_image ()
 decorated_image (I &ima, const D &deco)
 ~decorated_image ()
const D & decoration () const
D & decoration ()
mln::metal::const_< I >::retdelegatee_ () const
I * delegatee_ ()
void destroy ()
const I::domain_t & domain () const
bool has (const psite &p) const
bool has (const typename I::psite &p) const
void init_ (I &ima, const D &deco)
bool is_valid () const
std::size_t nsites () const
 operator decorated_image< const I, D > () const
rvalue operator() (const psite &p) const
lvalue operator() (const psite &p)
rvalue operator() (const typename I::domain_t::psite &p) const
lvalue operator() (const typename I::domain_t::psite &p)
rvalue read_ (const typename I::psite &p) const
decorated_image< I, D > & rw ()
I & unmorph_ ()
mln::metal::const_< I >::retunmorph_ () const
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const
void write_ (const typename I::psite &p, const typename I::value &v)

Protected Attributes

mln::util::tracked_ptr
< internal::data
< decorated_image< I, D > > > 
data_

Public Types

typedef I::domain_t::bkd_piter bkd_piter
typedef Image< void > category
typedef I delegatee
typedef I::domain_t domain_t
typedef decorated_image< I, D > exact_t
typedef I::domain_t::fwd_piter fwd_piter
typedef
internal::decorated_image_impl_
< I, self_
impl_
typedef impl_::lvalue lvalue
typedef fwd_piter piter
typedef I::psite psite
typedef I::rvalue rvalue
typedef decorated_image< I, D > self_
typedef I::domain_t::site site
typedef decorated_image
< tag::image_< I >, tag::data_
< D > > 
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, typename D>
struct mln::decorated_image< I, D >

Image that can have additional features.

Definition at line 84 of file decorated_image.hh.

Constructor & Destructor Documentation

template<typename I, typename D>
mln::decorated_image< I, D >::decorated_image ( )

Ctors.

template<typename I, typename D>
mln::decorated_image< I, D >::decorated_image ( I &  ima,
const D &  deco 
)
template<typename I, typename D>
mln::decorated_image< I, D >::~decorated_image ( )

Dtor.

Member Function Documentation

template<typename I, typename D>
const D& mln::decorated_image< I, D >::decoration ( ) const

Give the decoration.

template<typename I, typename D>
D& mln::decorated_image< I, D >::decoration ( )

Give the decoration.

mln::metal::const_< I >::ret* mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::delegatee_ ( ) const
inherited

INTERNAL_API Return the delegatee_ pointer; default code.

I* mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::delegatee_ ( )
inherited

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

void mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::destroy ( )
inherited

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

const I ::domain_t& mln::internal::image_identity< I, I::domain_t , decorated_image< I, D > >::domain ( ) const
inherited
bool mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::has ( const psite p) const
inherited

Test if p belongs to the image domain.

bool mln::internal::image_identity< I, I::domain_t , decorated_image< I, D > >::has ( const typename I::psite &  p) const
inherited
template<typename I, typename D>
void mln::decorated_image< I, D >::init_ ( I &  ima,
const D &  deco 
)

INTERNAL_API Initialize an empty image.

bool mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::is_valid ( ) const
inherited

Test if this image has been initialized; default impl.

Reimplemented from mln::internal::image_base< I::value, I::domain_t, decorated_image< I, D > >.

std::size_t mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::nsites ( ) const
inherited

Give the number of sites of the image domain.

template<typename I, typename D>
mln::decorated_image< I, D >::operator decorated_image< const I, D > ( ) const

Const promotion via conversion.

template<typename I, typename D>
rvalue mln::decorated_image< I, D >::operator() ( const psite p) const

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

template<typename I, typename D>
lvalue mln::decorated_image< I, D >::operator() ( const psite p)

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

rvalue mln::internal::image_identity< I, I::domain_t , decorated_image< I, D > >::operator() ( const typename I::domain_t ::psite p) const
inherited

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

lvalue mln::internal::image_identity< I, I::domain_t , decorated_image< I, D > >::operator() ( const typename I::domain_t ::psite p)
inherited

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

template<typename I, typename D>
rvalue mln::decorated_image< I, D >::read_ ( const typename I::psite &  p) const

INTERNAL_API Actual read routine.

decorated_image< I, D > & mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::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 , I::domain_t , decorated_image< I, D > >::unmorph_ ( )
inherited

INTERNAL_API Give the morphed image (mutable version).

mln::metal::const_< I >::ret& mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::unmorph_ ( ) const
inherited

Give the morphed image (const version).

const t_eligible_values_set& mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::values_eligible ( ) const
inherited
const t_values_space& mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::values_space ( ) const
inherited

Return the value space of the image.

void mln::internal::decorated_image_impl_< I, decorated_image< I, D > >::write_ ( const typename I::psite &  p,
const typename I::value &  v 
)
inherited

Actual write routine.

Member Data Documentation

mln::util::tracked_ptr< internal::data<decorated_image< I, D > > > mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::data_
protectedinherited

INTERNAL_API Internal data, sharable by several images.

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

Member Typedef Documentation

typedef I::domain_t ::bkd_piter mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::bkd_piter
inherited

Backward Site_Iterator associated type.

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

typedef Image<void> mln::Image< decorated_image< I, D > >::category
inherited

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

typedef I mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::delegatee
inherited

Delegatee associated type.

Definition at line 60 of file image_morpher.hh.

typedef I::domain_t mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::domain_t
inherited

Site_Set associated type.

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

typedef decorated_image< I, D > mln::Object< decorated_image< I, D > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef I::domain_t ::fwd_piter mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::fwd_piter
inherited

Forward Site_Iterator associated type.

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

template<typename I, typename D>
typedef internal::decorated_image_impl_< I, self_ > mln::decorated_image< I, D >::impl_

Definition at line 90 of file decorated_image.hh.

template<typename I, typename D>
typedef impl_::lvalue mln::decorated_image< I, D >::lvalue

Return type of read-write access.

Definition at line 98 of file decorated_image.hh.

typedef fwd_piter mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::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, typename D>
typedef I ::psite mln::decorated_image< I, D >::psite

Type of the psite.

Definition at line 93 of file decorated_image.hh.

template<typename I, typename D>
typedef I ::rvalue mln::decorated_image< I, D >::rvalue

Return type of read-only access.

Definition at line 96 of file decorated_image.hh.

template<typename I, typename D>
typedef decorated_image<I, D> mln::decorated_image< I, D >::self_

Definition at line 89 of file decorated_image.hh.

typedef I::domain_t ::site mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::site
inherited

Site associated type.

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

template<typename I, typename D>
typedef decorated_image< tag::image_<I>, tag::data_<D> > mln::decorated_image< I, D >::skeleton

Skeleton.

Definition at line 113 of file decorated_image.hh.

typedef mln::value::set<I::value > mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::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 , I::domain_t , decorated_image< I, D > >::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 , I::domain_t , decorated_image< I, D > >::unmorph
inherited

Unmorph image associated type.

Definition at line 72 of file image_morpher.hh.

typedef I ::value mln::internal::image_identity< I, I::domain_t , decorated_image< I, D > >::value
inherited

Value associated type.

Definition at line 137 of file image_identity.hh.