Public Types | Public Member Functions | Protected Attributes

mln::sub_image_if< I, S > Struct Template Reference
[Domain morphers]

Image having its domain restricted by a site set and a function. More...

#include <sub_image_if.hh>

Inheritance diagram for mln::sub_image_if< I, S >:
Inheritance graph

List of all members.

Public Types

typedef p_if< S, fun::p2b::has
< I > >::bkd_piter 
bkd_piter
 Backward Site_Iterator associated type.
typedef Image< void > category
typedef I delegatee
 Delegatee associated type.
typedef p_if< S, fun::p2b::has
< I > > 
domain_t
 Site_Set associated type.
typedef sub_image_if< I, S > exact_t
typedef p_if< S, fun::p2b::has
< I > >::fwd_piter 
fwd_piter
 Forward Site_Iterator associated type.
typedef
internal::morpher_lvalue_< I >
::ret 
lvalue
 Return type of read-write access.
typedef fwd_piter piter
 Site_Iterator associated type; default definition is fwd_piter.
typedef p_if< S, fun::p2b::has
< I > >::psite 
psite
 Point_Site associated type.
typedef I::rvalue rvalue
 Return type of read-only access.
typedef p_if< S, fun::p2b::has
< I > >::site 
site
 Site associated type.
typedef sub_image_if
< tag::image_< I >
, tag::domain_< S > > 
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

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 p_if< S, fun::p2b::has
< I > > & 
domain () const
 Give the definition domain.
bool has (const psite &p) const
 Test if p belongs to the image domain.
const util::tracked_ptr
< internal::data< sub_image_if
< I, S > > > & 
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 S &s)
 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.
rvalue operator() (const typename p_if< S, fun::p2b::has< I > >::psite &p) const
 Read-only access of pixel value at point site p.
lvalue operator() (const typename p_if< S, fun::p2b::has< I > >::psite &p)
 Read and "write if possible" access of pixel value at point site p.
sub_image_if< I, S > & rw ()
 State that the morpher is writable.
 sub_image_if (I &ima, const S &s)
 Constructor.
 sub_image_if ()
 Constructor without argument.
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.

Protected Attributes

util::tracked_ptr
< internal::data< sub_image_if
< I, S > > > 
data_

Detailed Description

template<typename I, typename S>
struct mln::sub_image_if< I, S >

Image having its domain restricted by a site set and a function.

Definition at line 101 of file sub_image_if.hh.


Member Typedef Documentation

typedef p_if< S, fun::p2b::has< I > > ::bkd_piter mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::bkd_piter [inherited]

Backward Site_Iterator associated type.

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

typedef Image<void> mln::Image< sub_image_if< I, S > >::category [inherited]

Reimplemented from mln::Object< sub_image_if< I, S > >.

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

typedef I mln::internal::image_morpher< I, I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::delegatee [inherited]

Delegatee associated type.

Definition at line 57 of file image_morpher.hh.

typedef p_if< S, fun::p2b::has< I > > mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::domain_t [inherited]

Site_Set associated type.

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

typedef sub_image_if< I, S > mln::Object< sub_image_if< I, S > >::exact_t [inherited]

Definition at line 173 of file object.hh.

typedef p_if< S, fun::p2b::has< I > > ::fwd_piter mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::fwd_piter [inherited]

Forward Site_Iterator associated type.

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

Return type of read-write access.

Definition at line 59 of file image_domain_morpher.hh.

typedef fwd_piter mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::piter [inherited]

Site_Iterator associated type; default definition is fwd_piter.

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

typedef p_if< S, fun::p2b::has< I > > ::psite mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::psite [inherited]

Point_Site associated type.

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

typedef I ::rvalue mln::internal::image_domain_morpher< I, p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::rvalue [inherited]

Return type of read-only access.

Definition at line 56 of file image_domain_morpher.hh.

typedef p_if< S, fun::p2b::has< I > > ::site mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::site [inherited]

Site associated type.

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

template<typename I, typename S>
typedef sub_image_if< tag::image_<I>, tag::domain_<S> > mln::sub_image_if< I, S >::skeleton

Skeleton.

Definition at line 106 of file sub_image_if.hh.

typedef mln::value::set<I::value > mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::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 , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::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 , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::unmorph [inherited]

Unmorph image associated type.

Definition at line 68 of file image_morpher.hh.

typedef I::value mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::value [inherited]

Value associated type.

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


Constructor & Destructor Documentation

template<typename I , typename S >
mln::sub_image_if< I, S >::sub_image_if (  )  [inline]

Constructor without argument.

Definition at line 181 of file sub_image_if.hh.

template<typename I , typename S >
mln::sub_image_if< I, S >::sub_image_if ( I &  ima,
const S &  s 
) [inline]

Constructor.

Definition at line 187 of file sub_image_if.hh.

References mln::sub_image_if< I, S >::init_().


Member Function Documentation

mln::metal::const_< I >::ret* mln::internal::image_morpher< I, I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::delegatee_ (  )  const [inherited]

Return the delegatee_ pointer; default code.

I* mln::internal::image_morpher< I, I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::delegatee_ (  )  [inherited]

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

void mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::destroy (  )  [inherited]

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

template<typename I , typename S >
const p_if< S, fun::p2b::has< I > > & mln::sub_image_if< I, S >::domain (  )  const [inline]
bool mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::has ( const psite p  )  const [inherited]

Test if p belongs to the image domain.

const util::tracked_ptr< internal::data<sub_image_if< I, S > > >& mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::hook_data_ (  )  const [inherited]

Hook to the image data.

const void* mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::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_< sub_image_if< I, S > , mln::metal::equal< mln_trait_image_speed(sub_image_if< I, S >), 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 S >
void mln::sub_image_if< I, S >::init_ ( I &  ima,
const S &  s 
) [inline]
bool mln::internal::image_morpher< I, I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::is_valid (  )  const [inherited]

Test if this image has been initialized; default impl.

Reimplemented from mln::internal::image_base< I::value, p_if< S, fun::p2b::has< I > >, sub_image_if< I, S > >.

Referenced by mln::sub_image_if< I, S >::init_().

std::size_t mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::nsites (  )  const [inherited]

Give the number of sites of the image domain.

lvalue mln::internal::image_domain_morpher< I, p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::operator() ( const typename p_if< S, fun::p2b::has< I > > ::psite p  )  [inherited]

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

rvalue mln::internal::image_domain_morpher< I, p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::operator() ( const typename p_if< S, fun::p2b::has< I > > ::psite p  )  const [inherited]

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

sub_image_if< I, S > & mln::internal::image_morpher< I, I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::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 , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::unmorph_ (  )  [inherited]

Give the morphed image (mutable version).

mln::metal::const_< I >::ret& mln::internal::image_morpher< I, I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::unmorph_ (  )  const [inherited]

Give the morphed image (const version).

const t_eligible_values_set& mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::values_eligible (  )  const [inherited]
const t_values_space& mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::values_space (  )  const [inherited]

Return the value space of the image.


Member Data Documentation

util::tracked_ptr< internal::data<sub_image_if< I, S > > > mln::internal::image_base< I::value , p_if< S, fun::p2b::has< I > > , sub_image_if< I, S > >::data_ [protected, inherited]