Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

mln::internal::image_base< T, S, E > Struct Template Reference

A base class for images. More...

#include <image_base.hh>

Inheritance diagram for mln::internal::image_base< T, S, E >:
Inheritance graph

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 fwd_piter piter
 Site_Iterator associated type; default definition is fwd_piter.
typedef S::psite psite
 Point_Site associated type.
typedef S::site site
 Site associated type.
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).
bool has (const psite &p) const
 Test if p belongs to the image domain.
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.
 image_base (const image_base &rhs)
 Copy constructor (performs a shallow copy).
unsigned index_of_point (const P &p) const
 Give the offset of the site p.
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.
image_baseoperator= (const image_base &rhs)
 Assignment operator (performs a shallow assignment).
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const
 Return the value space of the image.

Protected Member Functions

 image_base ()
 Constructor without argument.

Protected Attributes

util::tracked_ptr
< internal::data< E > > 
data_

Detailed Description

template<typename T, typename S, typename E>
struct mln::internal::image_base< T, S, E >

A base class for images.

Parameter T is the image value type. Parameter S is the image site set type.

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


Member Typedef Documentation

template<typename T, typename S, typename E>
typedef S ::bkd_piter mln::internal::image_base< T, S, E >::bkd_piter
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

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 173 of file object.hh.

template<typename T, typename S, typename E>
typedef S ::fwd_piter mln::internal::image_base< T, S, E >::fwd_piter
template<typename T, typename S, typename E>
typedef fwd_piter mln::internal::image_base< T, S, E >::piter

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
template<typename T, typename S, typename E>
typedef S ::site mln::internal::image_base< T, S, E >::site

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, typename E>
typedef mln::value::set<T> mln::internal::image_base< T, S, E >::t_eligible_values_set

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

Value space associated type.

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

template<typename T, typename S, typename E>
typedef T mln::internal::image_base< T, S, E >::value

Value associated type.

Reimplemented in mln::complex_image< D, G, V >, mln::extended< I >, mln::extension_fun< I, F >, mln::extension_ima< I, J >, mln::extension_val< I >, mln::hexa< I >, mln::flat_image< T, S >, mln::image1d< T >, mln::image2d< T >, mln::image3d< T >, mln::interpolated< I, F >, mln::tr_image< S, I, T >, mln::cast_image_< T, I >, mln::fun_image< F, I >, mln::internal::thru_image_read< I, F >, mln::thrubin_image< I1, I2, F >, mln::violent_cast_image< T, I >, mln::internal::image_identity< I, S, E >, mln::pw::internal::image_base< F, S, E >, mln::value::stack_image< n, I >, mln::hexa< image2d< V > >, mln::image2d< bool >, mln::image3d< t_label >, mln::image3d< unsigned >, mln::internal::image_identity< I, I::domain_t, decorated_image< I, D > >, mln::internal::image_identity< const I, I::domain_t, E >, mln::internal::image_identity< I, I::domain_t, extension_fun< I, F > >, mln::internal::image_identity< mln::trait::ch_value< I, F::result >::ret, I::domain_t, lazy_image< I, F, B > >, mln::internal::image_identity< I, I::domain_t, interpolated< I, F > >, mln::internal::image_identity< I, I::domain_t, safe_image< I > >, mln::internal::image_identity< I, I::domain_t, ch_piter_image< I, Fwd > >, mln::internal::image_identity< I, S, tr_image< S, I, T > >, mln::internal::image_identity< I, I::domain_t, plain< I > >, mln::internal::image_identity< const I, I::domain_t, labeled_image< I > >, mln::internal::image_identity< I, I::domain_t, extension_ima< I, J > >, mln::internal::image_identity< I, I::domain_t, extension_val< I > >, mln::pw::internal::image_base< fun::i2v::array< V >, p_edges< G, internal::efsite_selector< P, G >::site_function_t >, edge_image< P, V, G > >, mln::pw::internal::image_base< fun::i2v::array< V >, p_vertices< G, internal::vfsite_selector< P, G >::site_function_t >, vertex_image< P, V, G > >, and mln::pw::internal::image_base< F, S, image< F, S > >.

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


Constructor & Destructor Documentation

template<typename T , typename S , typename E >
mln::internal::image_base< T, S, E >::image_base ( const image_base< T, S, E > &  rhs  )  [inline]

Copy constructor (performs a shallow copy).

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

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

template<typename T , typename S , typename E >
mln::internal::image_base< T, S, E >::image_base (  )  [inline, protected]

Member Function Documentation

template<typename T , typename S , typename E >
void mln::internal::image_base< T, S, E >::destroy (  )  [inline]

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 , typename E >
bool mln::internal::image_base< T, S, E >::has ( const psite p  )  const [inline]
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]

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]

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.

unsigned mln::internal::check::image_fastest_< E, mln::metal::equal< mln_trait_image_speed(E), 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 T , typename S , typename E >
bool mln::internal::image_base< T, S, E >::is_valid (  )  const [inline]

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

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::util::internal::adjacency_matrix_impl_selector< V, Q >::clear(), mln::world::binary_2d::impl::enlargex2(), mln::internal::image_base< T, S, E >::has(), mln::internal::image_base< T, S, E >::image_base(), mln::accu::stat::histo3d_rgb< V >::is_valid(), mln::internal::image_base< T, S, E >::nsites(), mln::internal::image_base< T, S, E >::operator=(), mln::accu::stat::operator==(), mln::util::internal::adjacency_matrix_impl_selector< V, Q >::print_data_(), mln::world::binary_2d::reduce(), mln::util::internal::adjacency_matrix_impl_selector< V, Q >::remove(), and mln::world::binary_2d::subsample().

template<typename T , typename S , typename E >
std::size_t mln::internal::image_base< T, S, E >::nsites (  )  const [inline]

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 , typename E >
image_base< T, S, E > & mln::internal::image_base< T, S, E >::operator= ( const image_base< T, S, E > &  rhs  )  [inline]

Assignment operator (performs a shallow assignment).

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

References mln::internal::image_base< T, S, E >::data_, mln::exact(), 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]

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]

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]