Public Types | Public Member Functions

mln::accu::shape::volume< I > Struct Template Reference
[On images]

Volume accumulator class. More...

#include <volume.hh>

Inherits base< unsigned, volume< I > >.

List of all members.

Public Types

typedef util::pix< I > argument
 The accumulated data type.
typedef argument::value value
 The value type associated to the pixel type.

Public Member Functions

bool is_valid () const
 Check whether this accu is able to return a result.
void take_as_init (const T &t)
 Take as initialization the value t.
void take_n_times (unsigned n, const T &t)
 Take n times the value t.
unsigned to_result () const
 Get the value of the accumulator.

void init ()
 Manipulators.
void set_value (unsigned v)
 Force the value of the counter to v.

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.


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.

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.


Member Function Documentation

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

Manipulators.

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

References mln::literal::zero.

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

Check whether this accu is able to return a result.

Always true here.

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

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

Force the value of the counter to v.

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

References mln::literal::zero.

void mln::Accumulator< volume< I > >::take_as_init ( const T &  t  )  [inherited]

Take as initialization the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

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

Take n times the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

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

Get the value of the accumulator.

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