$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::accu::shape::volume< I > Struct Template Reference

#include <mln/accu/shape/volume.hh>

Public Member Functions

 volume ()
bool is_valid () const
unsigned subj_ ()
void take_as_init (const T &t)
void take_as_init_ (const T &t)
void take_n_times (unsigned n, const T &t)
void take_n_times_ (unsigned n, const T &t)
unsigned to_result () const
void init ()
void take (const argument &pixel)
void take (const volume< I > &other)
void set_value (unsigned v)

Protected Attributes

unsigned area__
value ref_level__
unsigned volume_

Public Types

typedef util::pix< I > argument
typedef Accumulator< void > category
typedef volume< I > exact_t
typedef unsigned q_result
typedef mln::metal::unqualif
< unsigned >::ret 
result
typedef argument::value value

Detailed Description

template<typename I>
struct mln::accu::shape::volume< I >

Volume accumulator class.

The parameter I is the image type on which the accumulator of pixels is built.

Definition at line 66 of file accu/shape/volume.hh.

Constructor & Destructor Documentation

template<typename I>
mln::accu::shape::volume< I >::volume ( )

Member Function Documentation

template<typename I>
void mln::accu::shape::volume< I >::init ( )

Manipulators.

template<typename I>
bool mln::accu::shape::volume< I >::is_valid ( ) const

Check whether this accu is able to return a result.

Always true here.

template<typename I>
void mln::accu::shape::volume< I >::set_value ( unsigned  v)

Force the value of the counter to v.

unsigned mln::accu::internal::base< unsigned , volume< I > >::subj_ ( )
inherited
template<typename I>
void mln::accu::shape::volume< I >::take ( const argument pixel)
template<typename I>
void mln::accu::shape::volume< I >::take ( const volume< I > &  other)
void mln::Accumulator< volume< I > >::take_as_init ( const T t)
inherited

Take as initialization the value t.

void mln::Accumulator< volume< I > >::take_as_init_ ( const T t)
inherited

INTERNAL_API

Default implementation of "take as initialization".

void mln::Accumulator< volume< I > >::take_n_times ( unsigned  n,
const T t 
)
inherited

Take n times the value t.

void mln::Accumulator< volume< I > >::take_n_times_ ( unsigned  n,
const T t 
)
inherited

INTERNAL_API

Default implementation of "take n times".

template<typename I>
unsigned mln::accu::shape::volume< I >::to_result ( ) const

Get the value of the accumulator.

Member Data Documentation

template<typename I>
unsigned mln::accu::shape::volume< I >::area__
protected

The area of the component.

Definition at line 103 of file accu/shape/volume.hh.

template<typename I>
value mln::accu::shape::volume< I >::ref_level__
protected

The reference level (the level of the component's root).

Definition at line 101 of file accu/shape/volume.hh.

template<typename I>
unsigned mln::accu::shape::volume< I >::volume_
protected

The volume of the component.

Definition at line 105 of file accu/shape/volume.hh.

Member Typedef Documentation

template<typename I>
typedef util::pix<I> mln::accu::shape::volume< I >::argument

The accumulated data type.

The volume of component is represented by the volume of its root pixel. See mln::morpho::closing_volume and mln::morpho::opening_volume for actual uses of this accumulator. FIXME: Replaced by mln::morpho::attribute::volume

Definition at line 76 of file accu/shape/volume.hh.

typedef Accumulator<void> mln::Accumulator< volume< I > >::category
inherited

Definition at line 64 of file accumulator.hh.

typedef volume< I > mln::Object< volume< I > >::exact_t
inherited

Definition at line 105 of file object.hh.

Definition at line 58 of file base.hh.

typedef mln::metal::unqualif< unsigned >::ret mln::accu::internal::base< unsigned , volume< I > >::result
inherited

Definition at line 59 of file base.hh.

template<typename I>
typedef argument::value mln::accu::shape::volume< I >::value

The value type associated to the pixel type.

Definition at line 78 of file accu/shape/volume.hh.