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

#include <mln/accu/stat/histo3d_rgb.hh>

Public Member Functions

bool is_valid () const
image3d< unsignedsubj_ ()
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)
 histo3d_rgb ()
void init ()
void take (const argument &t)
void take (const histo3d_rgb< V > &other)
result to_result () const
 operator result () const

Protected Attributes

result count_

Public Types

typedef V argument
typedef Accumulator< void > category
typedef histo3d_rgb< V > exact_t
typedef result q_result
typedef image3d< unsignedresult

Detailed Description

template<typename V>
struct mln::accu::stat::histo3d_rgb< V >

Define a histogram as accumulator which returns an image3d.

Param V defines the type of the input image value. It is in this space that we count the values. For instance, this histogram works well for image2d< rgb<2> > or with image2d< rgb<7> >. The number of bins depends directly the values V. For 8 bits there is 256x3 bins. Note that less quantification works too.

Definition at line 166 of file histo3d_rgb.hh.

Constructor & Destructor Documentation

template<typename V>
mln::accu::stat::histo3d_rgb< V >::histo3d_rgb ( )

Constructors.

Infer the size of the resulting image3d domain.

By evaluating the minimum and the maximum of V, we define the domain of the resulting image3d.

Member Function Documentation

template<typename V>
void mln::accu::stat::histo3d_rgb< V >::init ( )

Manipulators.

Initialize the histogram with zero value.

This method must be called just before starting the use of the histogram. If it's not, resulting values won't converge to the density.

template<typename V>
bool mln::accu::stat::histo3d_rgb< V >::is_valid ( ) const

Check whethever this accumulator is able to return a result.

Depends if the resulting image1d is valid. We can assume it is quite always the case.

template<typename V>
mln::accu::stat::histo3d_rgb< V >::operator result ( ) const
image3d< unsigned > mln::accu::internal::base< image3d< unsigned > , histo3d_rgb< V > >::subj_ ( )
inherited
template<typename V>
void mln::accu::stat::histo3d_rgb< V >::take ( const argument t)

Update the histogram with the RGB pixel t.

Parameters
[in]ta graylevel pixel of type V.

The end user shouldn't call this method. In place of it, he can go through the data compute interface.

template<typename V>
void mln::accu::stat::histo3d_rgb< V >::take ( const histo3d_rgb< V > &  other)

Update the histogram with an other histogram.

Parameters
[in]otherthe other histogram.

The end user shouldn't call this method. This is part of data compute interface mechanism.

void mln::Accumulator< histo3d_rgb< V > >::take_as_init ( const T t)
inherited

Take as initialization the value t.

void mln::Accumulator< histo3d_rgb< V > >::take_as_init_ ( const T t)
inherited

INTERNAL_API

Default implementation of "take as initialization".

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

Take n times the value t.

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

INTERNAL_API

Default implementation of "take n times".

template<typename V>
result mln::accu::stat::histo3d_rgb< V >::to_result ( ) const

Accessors.

Return the histogram as an RGB image3d.

This is the machinery to communicate with data compute interface. The end user should'nt use it.

Member Data Documentation

template<typename V>
result mln::accu::stat::histo3d_rgb< V >::count_
protected

Definition at line 226 of file histo3d_rgb.hh.

Member Typedef Documentation

template<typename V>
typedef V mln::accu::stat::histo3d_rgb< V >::argument

Definition at line 169 of file histo3d_rgb.hh.

typedef Accumulator<void> mln::Accumulator< histo3d_rgb< V > >::category
inherited

Definition at line 64 of file accumulator.hh.

typedef histo3d_rgb< V > mln::Object< histo3d_rgb< V > >::exact_t
inherited

Definition at line 105 of file object.hh.

template<typename V>
typedef result mln::accu::stat::histo3d_rgb< V >::q_result

Definition at line 171 of file histo3d_rgb.hh.

template<typename V>
typedef image3d<unsigned> mln::accu::stat::histo3d_rgb< V >::result

Definition at line 170 of file histo3d_rgb.hh.