$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::internal::run_image_< T, P, E > Class Template Reference

#include <mln/core/internal/run_image.hh>

Public Member Functions

float compression () const
void destroy ()
void finalize ()
bool has (const typename p_set_of< p_run< P > >::psite &ps) const
bool has (const psite &p) const
bool is_valid () const
std::size_t nsites () const
point_at (const typename p_set_of< p_run< P > >::psite &ps) const
const t_eligible_values_setvalues_eligible () const
const t_values_spacevalues_space () const

Protected Member Functions

 run_image_ ()

Protected Attributes

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

Public Types

typedef p_set_of< p_run< P >
>::bkd_piter 
bkd_piter
typedef Image< void > category
typedef p_set_of< p_run< P > > domain_t
typedef E exact_t
typedef p_set_of< p_run< P >
>::fwd_piter 
fwd_piter
typedef fwd_piter piter
typedef p_set_of< p_run< P >
>::psite 
psite
typedef p_set_of< p_run< P >
>::site 
site
typedef mln::value::set< P > t_eligible_values_set
typedef mln::value::set
< typename
mln::value::super_value< P >
::ret
t_values_space
typedef P value

Detailed Description

template<typename T, typename P, typename E>
class mln::internal::run_image_< T, P, E >

Factorization class for run_image.

Parameter T is the type of the image value. Parameter P is the type of the image point. Parameter E is the Exact type of the image.

Definition at line 53 of file run_image.hh.

Constructor & Destructor Documentation

template<typename T , typename P , typename E >
mln::internal::run_image_< T, P, E >::run_image_ ( )
protected

Member Function Documentation

template<typename T , typename P , typename E >
float mln::internal::run_image_< T, P, E >::compression ( ) const

Give the rate of compression.

Give the rate of space gained by coding an image in this format. A rate of 1 means there is no compression. Less than 1 means we have gained space.

Returns
The rate of compression.
void mln::internal::image_base< P , p_set_of< p_run< P > > , E >::destroy ( )
inherited

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

template<typename T , typename P , typename E >
void mln::internal::run_image_< T, P, E >::finalize ( )

Finalize the construction.

For internal use, this method has to be called to have actually an lighter image. So it improves compression.

template<typename T , typename P , typename E >
bool mln::internal::run_image_< T, P, E >::has ( const typename p_set_of< p_run< P > >::psite ps) const

Tell if the image has the given point site.

Returns
True if the image has the point site, else false.
bool mln::internal::image_base< P , p_set_of< p_run< P > > , E >::has ( const psite p) const
inherited

Test if p belongs to the image domain.

bool mln::internal::image_base< P , p_set_of< p_run< P > > , E >::is_valid ( ) const
inherited

Test if this image has been initialized; default impl.

std::size_t mln::internal::image_base< P , p_set_of< p_run< P > > , E >::nsites ( ) const
inherited

Give the number of sites of the image domain.

template<typename T , typename P , typename E >
P mln::internal::run_image_< T, P, E >::point_at ( const typename p_set_of< p_run< P > >::psite ps) const

Give the point represented by the point-site.

Use the coordinate of the psite to see what point it corresponds with the domain of the image.

Returns
The corresponding point.
const t_eligible_values_set& mln::internal::image_base< P , p_set_of< p_run< P > > , E >::values_eligible ( ) const
inherited
const t_values_space& mln::internal::image_base< P , p_set_of< p_run< P > > , E >::values_space ( ) const
inherited

Return the value space of the image.

Member Data Documentation

mln::util::tracked_ptr< internal::data<E> > mln::internal::image_base< P , p_set_of< p_run< P > > , E >::data_
protectedinherited

INTERNAL_API Internal data, sharable by several images.

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

Member Typedef Documentation

typedef p_set_of< p_run< P > > ::bkd_piter mln::internal::image_base< P , p_set_of< p_run< P > > , E >::bkd_piter
inherited

Backward Site_Iterator associated type.

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

template<typename E>
typedef Image<void> mln::Image< E >::category
inherited

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

typedef p_set_of< p_run< P > > mln::internal::image_base< P , p_set_of< p_run< P > > , E >::domain_t
inherited

Site_Set associated type.

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

template<typename E>
typedef E mln::Object< E >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef p_set_of< p_run< P > > ::fwd_piter mln::internal::image_base< P , p_set_of< p_run< P > > , E >::fwd_piter
inherited

Forward Site_Iterator associated type.

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

typedef fwd_piter mln::internal::image_base< P , p_set_of< p_run< P > > , E >::piter
inherited

Site_Iterator associated type; default definition is fwd_piter.

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

typedef p_set_of< p_run< P > > ::psite mln::internal::image_base< P , p_set_of< p_run< P > > , E >::psite
inherited

Point_Site associated type.

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

typedef p_set_of< p_run< P > > ::site mln::internal::image_base< P , p_set_of< p_run< P > > , E >::site
inherited

Site associated type.

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

Eligible-value-set associated type.

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

typedef mln::value::set< typename mln::value::super_value<P >::ret > mln::internal::image_base< P , p_set_of< p_run< P > > , E >::t_values_space
inherited

Value space associated type.

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

typedef P mln::internal::image_base< P , p_set_of< p_run< P > > , E >::value
inherited

Value associated type.

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