Public Types | Public Member Functions | Protected Attributes

mln::decorated_image< I, D > Struct Template Reference
[Identity morphers]

Image that can have additional features. More...

#include <decorated_image.hh>

Inheritance diagram for mln::decorated_image< I, D >:
Inheritance graph

List of all members.

Public Types

typedef I::domain_t::bkd_piter bkd_piter
 Backward Site_Iterator associated type.
typedef Image< void > category
typedef I delegatee
 Delegatee associated type.
typedef I::domain_t domain_t
 Site_Set associated type.
typedef decorated_image< I, D > exact_t
typedef I::domain_t::fwd_piter fwd_piter
 Forward Site_Iterator associated type.
typedef
internal::decorated_image_impl_
< I, self_
impl_
typedef impl_::lvalue lvalue
 Return type of read-write access.
typedef mln::value::proxy
< decorated_image< I, D > > 
lvalue
typedef fwd_piter piter
 Site_Iterator associated type; default definition is fwd_piter.
typedef I::psite psite
 Type of the psite.
typedef I::rvalue rvalue
 Return type of read-only access.
typedef decorated_image< I, D > self_
typedef I::domain_t::site site
 Site associated type.
typedef decorated_image
< tag::image_< I >, tag::data_
< D > > 
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

 decorated_image ()
 Ctors.
 decorated_image (I &ima, const D &deco)
const D & decoration () const
 Give the decoration.
D & decoration ()
 Give the decoration.
mln::metal::const_< I >::retdelegatee_ () const
 Return the delegatee_ pointer; default code.
I * delegatee_ ()
 Return the delegatee_ pointer (non-const version); default code.
void destroy ()
 Detach data from an image (free it if nobody else hold it).
const I::domain_t & domain () const
bool has (const psite &p) const
 Test if p belongs to the image domain.
bool has (const typename I::psite &p) const
const util::tracked_ptr
< internal::data
< decorated_image< I, D > > > & 
hook_data_ () const
 Hook to the image data.
const void * id_ () const
 Give an identifier of this image.
unsigned index_of_point (const P &p) const
 Give the offset of the site p.
void init_ (I &ima, const D &deco)
 Initialize an empty image.
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.
 operator decorated_image< const I, D > () const
 Const promotion via conversion.
rvalue operator() (const typename I::domain_t::psite &p) const
 Read-only access of pixel value at point site p.
rvalue operator() (const psite &p) const
 Read-only access of pixel value at point site p.
lvalue operator() (const typename I::domain_t::psite &p)
 Read-write access of pixel value at point site p.
lvalue operator() (const psite &p)
 Read-write access of pixel value at point site p.
rvalue read_ (const typename I::psite &p) const
 Actual read routine.
decorated_image< I, D > & rw ()
 State that the morpher is writable.
I & unmorph_ ()
 Give the morphed image (mutable version).
mln::metal::const_< I >::retunmorph_ () const
 Give the morphed image (const version).
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const
 Return the value space of the image.
void write_ (const typename I::psite &p, const typename I::value &v)
 Actual write routine.
 ~decorated_image ()
 Dtor.

Protected Attributes

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

Detailed Description

template<typename I, typename D>
struct mln::decorated_image< I, D >

Image that can have additional features.

Definition at line 81 of file decorated_image.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 118 of file core/internal/image_base.hh.

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

Reimplemented from mln::Object< decorated_image< I, D > >.

Definition at line 75 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 57 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 105 of file core/internal/image_base.hh.

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

Definition at line 173 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 115 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 87 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.

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

Definition at line 95 of file decorated_image.hh.

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

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

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

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

Definition at line 93 of file decorated_image.hh.

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

Definition at line 86 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 111 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 108 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 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 , I::domain_t , decorated_image< I, D > >::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 , I::domain_t , decorated_image< I, D > >::unmorph [inherited]

Unmorph image associated type.

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

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

Definition at line 134 of file image_identity.hh.


Constructor & Destructor Documentation

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

Ctors.

Definition at line 161 of file decorated_image.hh.

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

Dtor.

Definition at line 184 of file decorated_image.hh.


Member Function Documentation

template<typename I , typename D >
const D & mln::decorated_image< I, D >::decoration (  )  const [inline]
template<typename I , typename D >
D & mln::decorated_image< I, D >::decoration (  )  [inline]
mln::metal::const_< I >::ret* mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::delegatee_ (  )  const [inherited]

Return the delegatee_ pointer; default code.

Referenced by mln::decorated_image< I, D >::operator()().

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_identity< I, I::domain_t , decorated_image< I, D > >::has ( const typename I::psite &  p  )  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.

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

Hook to the image data.

const void* mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::id_ (  )  const [inherited]

Give an identifier of this image.

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

unsigned mln::internal::check::image_fastest_< decorated_image< I, D > , mln::metal::equal< mln_trait_image_speed(decorated_image< I, D >), trait::image::speed::fastest >::eval >::index_of_point ( const P &  p  )  const [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)
template<typename I, typename D>
void mln::decorated_image< I, D >::init_ ( I &  ima,
const D &  deco 
) [inline]
bool mln::internal::image_morpher< I, I::value , I::domain_t , decorated_image< I, D > >::is_valid (  )  const [inherited]
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 [inline]

Const promotion via conversion.

Definition at line 239 of file decorated_image.hh.

References mln::internal::image_base< I::value, I::domain_t, decorated_image< I, D > >::data_.

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 >
decorated_image< I, D >::rvalue mln::decorated_image< I, D >::operator() ( const psite p  )  const [inline]
template<typename I , typename D >
decorated_image< I, D >::lvalue mln::decorated_image< I, D >::operator() ( const psite p  )  [inline]

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

Definition at line 206 of file decorated_image.hh.

References mln::internal::image_morpher< I, I::value, I::domain_t, decorated_image< I, D > >::delegatee_().

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

Actual read routine.

Definition at line 216 of file decorated_image.hh.

Referenced by mln::decorated_image< I, D >::operator()().

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]

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

util::tracked_ptr< internal::data<decorated_image< I, D > > > mln::internal::image_base< I::value , I::domain_t , decorated_image< I, D > >::data_ [protected, inherited]