mln::flat_image< T, S > Struct Template Reference
[Basic types]

Image with a single value. More...

#include <flat_image.hh>

Inheritance diagram for mln::flat_image< T, S >:

List of all members.

Public Types
typedef S::bkd_piter	bkd_piter
	Backward Site_Iterator associated type.
typedef Image< void >	category
typedef S	domain_t
	Site_Set associated type.
typedef E	exact_t
typedef S::fwd_piter	fwd_piter
	Forward Site_Iterator associated type.
typedef T &	lvalue
	Return type of read-write access.
typedef fwd_piter	piter
	Site_Iterator associated type; default definition is fwd_piter.
typedef S::psite	psite
	Point_Site associated type.
typedef const T &	rvalue
	Return type of read-only access.
typedef S::site	site
	Site associated type.
typedef flat_image < tag::value_< T > , tag::domain_< S > >	skeleton
	Skeleton.
typedef mln::value::set< T >	t_eligible_values_set
	Eligible-value-set associated type.
typedef mln::value::set < typename mln::value::super_value< T > ::ret >	t_values_space
	Value space associated type.
typedef T	value
	Value associated type.
Public Member Functions
void	destroy ()
	Detach data from an image (free it if nobody else hold it).
const S &	domain () const
	Give the definition domain.
	flat_image (const T &val, const S &pset)
	Constructor.
	flat_image ()
	Constructor without argument.
bool	has (const psite &p) const
	Test if p belongs to the image domain.
bool	has (const typename S::psite &p) const
	Test if p is valid: always return true.
const util::tracked_ptr < internal::data< E > > &	hook_data_ () const
	Hook to the image data.
const void *	id_ () const
	Give an identifier of this image.
template<typename P>
unsigned	index_of_point (const P &p) const
	Give the offset of the site p.
void	init_ (const T &val, const S &pset)
	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.
T &	operator() (const typename S::psite &p)
	Read-write access to the image value located at point p.
const T &	operator() (const typename S::psite &p) const
	Read-only access to the image value located at point p.
T &	value_ ()
const T &	value_ () const
	Specific methods.
const t_eligible_values_set &	values_eligible () const
const t_values_space &	values_space () const
	Return the value space of the image.
Protected Attributes
util::tracked_ptr < internal::data< E > >	data_

---

Detailed Description

template<typename T, typename S>
struct mln::flat_image< T, S >

Image with a single value.

Definition at line 105 of file flat_image.hh.

---

Member Typedef Documentation

template<typename T, typename S, typename E>

typedef S ::bkd_piter mln::internal::image_base< T, S, E >::bkd_piter [inherited]

Backward Site_Iterator associated type.

Reimplemented in mln::ch_piter_image< I, Fwd >, mln::hexa< I >, mln::image3d< T >, and mln::hexa< mln::image2d< V > >.

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

template<typename E>

typedef Image<void> mln::Image< E >::category [inherited]

Reimplemented from mln::Object< E >.

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

template<typename T, typename S, typename E>

typedef S mln::internal::image_base< T, S, E >::domain_t [inherited]

Site_Set associated type.

Reimplemented in mln::value::stack_image< n, I >.

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

template<typename E>

typedef E mln::Object< E >::exact_t [inherited]

Definition at line 172 of file object.hh.

template<typename T, typename S, typename E>

typedef S ::fwd_piter mln::internal::image_base< T, S, E >::fwd_piter [inherited]

Forward Site_Iterator associated type.

Reimplemented in mln::ch_piter_image< I, Fwd >, mln::hexa< I >, mln::image3d< T >, and mln::hexa< mln::image2d< V > >.

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

template<typename T, typename S>

typedef T& mln::flat_image< T, S >::lvalue

Return type of read-write access.

Definition at line 118 of file flat_image.hh.

template<typename T, typename S, typename E>

typedef fwd_piter mln::internal::image_base< T, S, E >::piter [inherited]

Site_Iterator associated type; default definition is fwd_piter.

Reimplemented in mln::ch_piter_image< I, Fwd >.

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

template<typename T, typename S, typename E>

typedef S ::psite mln::internal::image_base< T, S, E >::psite [inherited]

Point_Site associated type.

Reimplemented in mln::hexa< I >, mln::image2d_h< V >, mln::edge_image< P, V, G >, mln::image3d< T >, mln::decorated_image< I, D >, mln::interpolated< I, F >, mln::tr_image< S, I, T >, mln::vertex_image< P, V, G >, mln::internal::thru_image_read< I, F >, mln::thrubin_image< I1, I2, F >, mln::value::stack_image< n, I >, and mln::hexa< mln::image2d< V > >.

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

template<typename T, typename S>

typedef const T& mln::flat_image< T, S >::rvalue

Return type of read-only access.

Definition at line 115 of file flat_image.hh.

template<typename T, typename S, typename E>

typedef S ::site mln::internal::image_base< T, S, E >::site [inherited]

Site associated type.

Reimplemented in mln::tr_image< S, I, T >.

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

template<typename T, typename S>

typedef flat_image< tag::value_<T>, tag::domain_<S> > mln::flat_image< T, S >::skeleton

Skeleton.

Definition at line 108 of file flat_image.hh.

template<typename T, typename S, typename E>

typedef mln::value::set<T> mln::internal::image_base< T, S, E >::t_eligible_values_set [inherited]

Eligible-value-set associated type.

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

template<typename T, typename S, typename E>

typedef mln::value::set< typename mln::value::super_value<T>::ret > mln::internal::image_base< T, S, E >::t_values_space [inherited]

Value space associated type.

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

template<typename T, typename S>

typedef T mln::flat_image< T, S >::value

Value associated type.

Reimplemented from mln::internal::image_base< T, S, E >.

Definition at line 112 of file flat_image.hh.

---

Constructor & Destructor Documentation

template<typename T, typename S>

mln::flat_image< T, S >::flat_image

(

)

[inline]

Constructor without argument.

Definition at line 191 of file flat_image.hh.

template<typename T, typename S>

mln::flat_image< T, S >::flat_image	(	const T &	val,
		const S &	pset
	)			[inline]

Constructor.

Definition at line 197 of file flat_image.hh.

References mln::flat_image< T, S >::init_().

---

Member Function Documentation

template<typename T, typename S, typename E>

void mln::internal::image_base< T, S, E >::destroy

(

)

[inline, inherited]

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

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

template<typename T, typename S>

const S & mln::flat_image< T, S >::domain

(

)

const [inline]

Give the definition domain.

Definition at line 214 of file flat_image.hh.

References mln::internal::image_base< T, S, E >::data_.

template<typename T, typename S, typename E>

bool mln::internal::image_base< T, S, E >::has

(

const psite &

p

)

const [inline, inherited]

Test if p belongs to the image domain.

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

References mln::exact(), and mln::internal::image_base< T, S, E >::is_valid().

Referenced by mln::make::attachment(), and mln::make::detachment().

template<typename T, typename S>

bool mln::flat_image< T, S >::has

(

const typename S::psite &

p

)

const [inline]

Test if p is valid: always return true.

Definition at line 222 of file flat_image.hh.

template<typename T, typename S, typename E>

const util::tracked_ptr< internal::data< E > > & mln::internal::image_base< T, S, E >::hook_data_

(

)

const [inline, inherited]

Hook to the image data.

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

template<typename T, typename S, typename E>

const void * mln::internal::image_base< T, S, E >::id_

(

)

const [inline, inherited]

Give an identifier of this image.

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

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

References mln::util::tracked_ptr< T >::ptr_.

template<typename E, typename B>

template<typename P>

unsigned mln::internal::check::image_fastest_< E, B >::index_of_point

(

const P &

p

)

const [inline, 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)

Definition at line 133 of file internal/check/image_fastest.hh.

template<typename T, typename S>

void mln::flat_image< T, S >::init_	(	const T &	val,
		const S &	pset
	)			[inline]

Initialization.

Definition at line 205 of file flat_image.hh.

References mln::internal::image_base< T, S, E >::data_, and mln::internal::image_base< T, S, E >::is_valid().

Referenced by mln::flat_image< T, S >::flat_image(), and mln::init_().

template<typename T, typename S, typename E>

bool mln::internal::image_base< T, S, E >::is_valid

(

)

const [inline, inherited]

Test if this image has been initialized; default impl.

Reimplemented in mln::interpolated< I, F >, mln::tr_image< S, I, T >, mln::internal::image_morpher< I, T, S, E >, mln::value::stack_image< n, I >, mln::internal::image_morpher< I, I::value, I::domain_t, E >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::safe_image< I > >, mln::internal::image_morpher< I, I::value, D, mln::unproject_image< I, D, F > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::extension_val< I > >, mln::internal::image_morpher< I, T, I::domain_t, E >, mln::internal::image_morpher< I, F::result, I::domain_t, mln::thru_image< I, F > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::labeled_image< I > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::interpolated< I, F > >, mln::internal::image_morpher< I, mln::algebra::vec< n, I::value >, I::domain_t, mln::value::stack_image< n, I > >, mln::internal::image_morpher< mln::image2d< V >, mln::image2d< V >::value, mln::box< P >, mln::hexa< mln::image2d< V > > >, mln::internal::image_morpher< I, F::result, I::domain_t, mln::fun_image< F, I > >, mln::internal::image_morpher< I, I::value, S, E >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::extension_fun< I, F > >, mln::internal::image_morpher< I, I::value, mln::p_if< I::domain_t, F >, mln::image_if< I, F > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::extension_ima< I, J > >, mln::internal::image_morpher< I, I::value, mln::p_transformed< I::domain_t, F >, mln::transformed_image< I, F > >, mln::internal::image_morpher< I1, F::result, I1::domain_t, mln::thrubin_image< I1, I2, F > >, mln::internal::image_morpher< I, T, I::domain_t, mln::cast_image_< T, I > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::ch_piter_image< I, Fwd > >, mln::internal::image_morpher< I, I::value, mln::box< I::site >, mln::extended< I > >, mln::internal::image_morpher< I, T, I::domain_t, mln::violent_cast_image< T, I > >, mln::internal::image_morpher< I, I::value, S, mln::sub_image< I, S > >, mln::internal::image_morpher< I, I::value, S, mln::tr_image< S, I, T > >, mln::internal::image_morpher< mln::trait::ch_value< I, F::result >::ret, mln::trait::ch_value< I, F::result >::ret::value, I::domain_t, mln::lazy_image< I, F, B > >, mln::internal::image_morpher< I, I::value, mln::p_if< S, mln::fun::p2b::has< I > >, mln::sub_image_if< I, S > >, mln::internal::image_morpher< I, I::value, mln::box< P >, mln::hexa< I > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::p2p_image< I, F > >, mln::internal::image_morpher< I, I::value, mln::box< P >, mln::slice_image< I > >, mln::internal::image_morpher< I, I::value, I::domain_t, mln::decorated_image< I, D > >, and mln::internal::image_morpher< I, I::value, I::domain_t, mln::plain< I > >.

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

Referenced by mln::util::internal::adjacency_matrix_impl_selector< V, Q >::add(), mln::util::internal::adjacency_matrix_impl_selector< V, Q >::are_adjacent(), mln::image3d< T >::bbox(), mln::image2d< T >::bbox(), mln::image1d< T >::bbox(), mln::image3d< T >::border(), mln::image2d< T >::border(), mln::image1d< T >::border(), mln::image3d< T >::buffer(), mln::image2d< T >::buffer(), mln::image1d< T >::buffer(), mln::util::internal::adjacency_matrix_impl_selector< V, Q >::clear(), mln::image3d< T >::delta_index(), mln::image2d< T >::delta_index(), mln::image1d< T >::delta_index(), mln::image3d< T >::domain(), mln::image2d< T >::domain(), mln::image1d< T >::domain(), mln::complex_image< D, G, V >::domain(), mln::world::binary_2d::impl::enlargex2(), mln::internal::image_base< T, S, E >::has(), mln::image3d< T >::has(), mln::image2d< T >::has(), mln::image1d< T >::has(), mln::internal::image_base< T, S, E >::image_base(), mln::image3d< T >::init_(), mln::image2d< T >::init_(), mln::image1d< T >::init_(), mln::flat_image< T, S >::init_(), mln::complex_image< D, G, V >::init_(), mln::morpho::line_gradient(), mln::image3d< T >::ncols(), mln::image2d< T >::ncols(), mln::image3d< T >::nelements(), mln::image2d< T >::nelements(), mln::image1d< T >::nelements(), mln::image1d< T >::ninds(), mln::image3d< T >::nrows(), mln::image2d< T >::nrows(), mln::internal::image_base< T, S, E >::nsites(), mln::image3d< T >::nslices(), mln::flat_image< T, S >::operator()(), mln::internal::image_base< T, S, E >::operator=(), mln::util::internal::adjacency_matrix_impl_selector< V, Q >::print_data_(), mln::util::internal::adjacency_matrix_impl_selector< V, Q >::remove(), mln::image2d< T >::resize_(), mln::io::txt::save(), mln::world::binary_2d::subsample(), and mln::flat_image< T, S >::value_().

template<typename T, typename S, typename E>

std::size_t mln::internal::image_base< T, S, E >::nsites

(

)

const [inline, inherited]

Give the number of sites of the image domain.

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

References mln::exact(), and mln::internal::image_base< T, S, E >::is_valid().

template<typename T, typename S>

T & mln::flat_image< T, S >::operator()

(

const typename S::psite &

p

)

[inline]

Read-write access to the image value located at point p.

Definition at line 239 of file flat_image.hh.

References mln::internal::image_base< T, S, E >::data_, and mln::internal::image_base< T, S, E >::is_valid().

template<typename T, typename S>

const T & mln::flat_image< T, S >::operator()

(

const typename S::psite &

p

)

const [inline]

Read-only access to the image value located at point p.

Definition at line 230 of file flat_image.hh.

References mln::internal::image_base< T, S, E >::data_, and mln::internal::image_base< T, S, E >::is_valid().

template<typename T, typename S>

T & mln::flat_image< T, S >::value_

(

)

[inline]

Definition at line 257 of file flat_image.hh.

References mln::internal::image_base< T, S, E >::data_, and mln::internal::image_base< T, S, E >::is_valid().

template<typename T, typename S>

const T & mln::flat_image< T, S >::value_

(

)

const [inline]

Specific methods.

Definition at line 248 of file flat_image.hh.

References mln::internal::image_base< T, S, E >::data_, and mln::internal::image_base< T, S, E >::is_valid().

template<typename T, typename S, typename E>

const image_base< T, S, E >::t_eligible_values_set & mln::internal::image_base< T, S, E >::values_eligible

(

)

const [inline, inherited]

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

References mln::value::set< T >::the().

template<typename T, typename S, typename E>

const image_base< T, S, E >::t_values_space & mln::internal::image_base< T, S, E >::values_space

(

)

const [inline, inherited]

Return the value space of the image.

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

References mln::value::set< T >::the().

---

Member Data Documentation

template<typename T, typename S, typename E>

util::tracked_ptr< internal::data<E> > mln::internal::image_base< T, S, E >::data_ [protected, inherited]

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

Referenced by mln::image2d< bool >::alt(), mln::image2d< T >::at_(), mln::image1d< T >::at_(), mln::image2d< T >::bbox(), mln::image1d< T >::bbox(), mln::image2d< T >::border(), mln::image1d< T >::border(), mln::image2d< T >::buffer(), mln::image1d< T >::buffer(), mln::internal::run_image_< T, P, E >::compression(), mln::internal::image_morpher< I, T, S, E >::delegatee_(), mln::image2d< T >::delta_index(), mln::image2d< T >::domain(), mln::image1d< T >::domain(), mln::flat_image< T, S >::domain(), mln::complex_image< D, G, V >::domain(), mln::image2d< T >::element(), mln::image1d< T >::element(), mln::image2d< T >::has(), mln::image1d< T >::has(), mln::internal::image_base< T, S, E >::image_base(), mln::image2d< T >::init_(), mln::image1d< T >::init_(), mln::flat_image< T, S >::init_(), mln::complex_image< D, G, V >::init_(), mln::internal::image_morpher< I, T, S, E >::is_valid(), mln::image2d< T >::ncols(), mln::image2d< T >::nelements(), mln::image1d< T >::nelements(), mln::image1d< T >::ninds(), mln::image2d< T >::nrows(), mln::image2d< T >::operator()(), mln::image1d< T >::operator()(), mln::flat_image< T, S >::operator()(), mln::complex_image< D, G, V >::operator()(), mln::internal::image_base< T, S, E >::operator=(), mln::image2d< T >::point_at_index(), mln::image1d< T >::point_at_index(), mln::image2d< T >::resize_(), mln::image1d< T >::resize_(), mln::flat_image< T, S >::value_(), and mln::complex_image< D, G, V >::values().