mln::value::stack_image< n, I > Struct Template Reference

Stack image class. More...

#include <stack.hh>

Inheritance diagram for mln::value::stack_image< n, I >:

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 stack_image< n, I >	exact_t
typedef I::domain_t::fwd_piter	fwd_piter
	Forward Site_Iterator associated type.
typedef internal::helper_stack_image_lvalue_ < n, I >::ret	lvalue
	Return type of read-write access.
typedef fwd_piter	piter
	Site_Iterator associated type; default definition is fwd_piter.
typedef I::psite	psite
	Point_Site associated type.
typedef value	rvalue
	Return type of read-only access.
typedef I::domain_t::site	site
	Site associated type.
typedef stack_image< n, tag::image_< I > >	skeleton
	Skeleton.
typedef mln::value::set < algebra::vec< n, I::value > >	t_eligible_values_set
	Eligible-value-set associated type.
typedef mln::value::set < typename mln::value::super_value < algebra::vec< n, I::value > >::ret >	t_values_space
	Value space associated type.
typedef I	unmorph
	Unmorph image associated type.
typedef algebra::vec< n, typename I::value >	value
	Value associated type.
Public Member Functions
mln::metal::const_< I >::ret *	delegatee_ () 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< stack_image < n, I > > > &	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_ (const algebra::vec< n, I > &imas)
	Initialize an empty image.
bool	is_valid () const
	Test if this image has been initialized.
std::size_t	nsites () const
	Give the number of sites of the image domain.
lvalue	operator() (const psite &)
	Read-write access of pixel value at point site p.
rvalue	operator() (const psite &p) const
	Read-only access of pixel value at point site p.
rvalue	read_ (const psite &p) const
stack_image< n, I > &	rw ()
	State that the morpher is writable.
mln::metal::const_< I >::ret &	unmorph_ () const
	Give the morphed image (const version).
I &	unmorph_ ()
	Give the morphed image (mutable version).
const t_eligible_values_set &	values_eligible () const
const t_values_space &	values_space () const
	Return the value space of the image.
void	write_ (const psite &p, const value &v)
	stack_image (const algebra::vec< n, I > &imas)
	Constructors.
	stack_image ()
Protected Attributes
util::tracked_ptr < internal::data< stack_image < n, I > > >	data_

---

Detailed Description

template<unsigned n, typename I>
struct mln::value::stack_image< n, I >

Stack image class.

mln::value::stack_image stores a vector of n images of the same domain.

The parameter n is the number of images, I is the type of a stack element. Acces a value will compute a vector which contains n coordinates : [stack[0](p), stack[1](p), ... , stack[n](p)]

---

Member Typedef Documentation

typedef I::domain_t ::bkd_piter mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::bkd_piter [inherited]

Backward Site_Iterator associated type.

typedef Image<void> mln::Image< stack_image< n, I > >::category [inherited]

Reimplemented from mln::Object< stack_image< n, I > >.

typedef I mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::delegatee [inherited]

Delegatee associated type.

template<unsigned n, typename I>

typedef I ::domain_t mln::value::stack_image< n, I >::domain_t

Site_Set associated type.

Reimplemented from mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >.

typedef stack_image< n, I > mln::Object< stack_image< n, I > >::exact_t [inherited]

typedef I::domain_t ::fwd_piter mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::fwd_piter [inherited]

Forward Site_Iterator associated type.

template<unsigned n, typename I>

typedef internal::helper_stack_image_lvalue_<n,I>::ret mln::value::stack_image< n, I >::lvalue

Return type of read-write access.

typedef fwd_piter mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::piter [inherited]

Site_Iterator associated type; default definition is fwd_piter.

template<unsigned n, typename I>

typedef I ::psite mln::value::stack_image< n, I >::psite

Point_Site associated type.

Reimplemented from mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >.

template<unsigned n, typename I>

typedef value mln::value::stack_image< n, I >::rvalue

Return type of read-only access.

The rvalue type is not a const reference, since the value type is built on the fly, and return by value (copy).

typedef I::domain_t ::site mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::site [inherited]

Site associated type.

template<unsigned n, typename I>

typedef stack_image< n, tag::image_<I> > mln::value::stack_image< n, I >::skeleton

Skeleton.

typedef mln::value::set<algebra::vec< n, I::value > > mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::t_eligible_values_set [inherited]

Eligible-value-set associated type.

typedef mln::value::set< typename mln::value::super_value<algebra::vec< n, I::value > >::ret > mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::t_values_space [inherited]

Value space associated type.

typedef I mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::unmorph [inherited]

Unmorph image associated type.

template<unsigned n, typename I>

typedef algebra::vec<n, typename I ::value> mln::value::stack_image< n, I >::value

Value associated type.

Reimplemented from mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >.

---

Constructor & Destructor Documentation

template<unsigned n, typename I>

mln::value::stack_image< n, I >::stack_image

(

const algebra::vec< n, I > &

imas

)

[inline]

Constructors.

References mln::value::stack_image< n, I >::init_().

template<unsigned n, typename I>

mln::value::stack_image< n, I >::stack_image

(

)

[inline]

---

Member Function Documentation

mln::metal::const_< I >::ret* mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::delegatee_

(

)

const [inherited]

Return the delegatee_ pointer; default code.

I* mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::delegatee_

(

)

[inherited]

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

void mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::destroy

(

)

[inherited]

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

const I ::domain_t& mln::internal::image_value_morpher< I, algebra::vec< n, I::value > , stack_image< n, I > >::domain

(

)

const [inherited]

bool mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::has

(

const psite &

p

)

const [inherited]

Test if p belongs to the image domain.

bool mln::internal::image_value_morpher< I, algebra::vec< n, I::value > , stack_image< n, I > >::has

(

const typename I::psite &

p

)

const [inherited]

Referenced by mln::value::stack_image< n, I >::read_(), and mln::value::stack_image< n, I >::write_().

const util::tracked_ptr< internal::data<stack_image< n, I > > >& mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::hook_data_

(

)

const [inherited]

Hook to the image data.

const void* mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::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_< stack_image< n, I > , mln::metal::equal< mln_trait_image_speed(stack_image< n, I >), 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<unsigned n, typename I>

void mln::value::stack_image< n, I >::init_

(

const algebra::vec< n, I > &

imas

)

[inline]

Initialize an empty image.

References mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >::data_, and mln::value::stack_image< n, I >::is_valid().

Referenced by mln::value::stack_image< n, I >::stack_image().

template<unsigned n, typename I >

bool mln::value::stack_image< n, I >::is_valid

(

)

const [inline]

Test if this image has been initialized.

Reimplemented from mln::internal::image_morpher< I, algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >.

References mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >::data_.

Referenced by mln::value::stack_image< n, I >::init_().

std::size_t mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::nsites

(

)

const [inherited]

Give the number of sites of the image domain.

template<unsigned n, typename I >

stack_image< n, I >::lvalue mln::value::stack_image< n, I >::operator()

(

const psite &

p

)

[inline]

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

template<unsigned n, typename I >

stack_image< n, I >::rvalue mln::value::stack_image< n, I >::operator()

(

const psite &

p

)

const [inline]

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

References mln::value::stack_image< n, I >::read_().

template<unsigned n, typename I >

stack_image< n, I >::rvalue mln::value::stack_image< n, I >::read_

(

const psite &

p

)

const [inline]

References mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >::data_, and mln::internal::image_value_morpher< I, algebra::vec< n, I::value >, stack_image< n, I > >::has().

Referenced by mln::value::internal::helper_stack_image_lvalue_< n, const I >::make(), and mln::value::stack_image< n, I >::operator()().

stack_image< n, I > & mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, 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.

mln::metal::const_< I >::ret& mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::unmorph_

(

)

const [inherited]

Give the morphed image (const version).

I& mln::internal::image_morpher< I, algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::unmorph_

(

)

[inherited]

Give the morphed image (mutable version).

const t_eligible_values_set& mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::values_eligible

(

)

const [inherited]

const t_values_space& mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::values_space

(

)

const [inherited]

Return the value space of the image.

template<unsigned n, typename I >

void mln::value::stack_image< n, I >::write_	(	const psite &	p,
		const value &	v
	)			[inline]

References mln::internal::image_base< algebra::vec< n, I::value >, I::domain_t, stack_image< n, I > >::data_, and mln::internal::image_value_morpher< I, algebra::vec< n, I::value >, stack_image< n, I > >::has().

---

Member Data Documentation

util::tracked_ptr< internal::data<stack_image< n, I > > > mln::internal::image_base< algebra::vec< n, I::value > , I::domain_t , stack_image< n, I > >::data_ [protected, inherited]

Referenced by mln::value::stack_image< n, I >::init_(), mln::value::stack_image< n, I >::is_valid(), mln::value::stack_image< n, I >::read_(), and mln::value::stack_image< n, I >::write_().