Public Types | Public Member Functions | Protected Attributes

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

Define an accumulator that computes the first site with the maximum value in an image. More...

#include <max_site.hh>

Inheritance diagram for mln::accu::max_site< I >:
Inheritance graph

List of all members.

Public Types

typedef mln::util::pix< I > argument
typedef Accumulator< void > category
typedef max_site< I > exact_t
typedef I::psite q_result
typedef I::psite result

Public Member Functions

bool is_valid () const
 Check whether this accu is able to return a result.
 max_site ()
 operator typename I::psite () const
I::psite subj_ ()
void take_as_init (const T &t)
 Take as initialization the value t.
void take_as_init_ (const T &t)
 Default implementation of "take as initialization".
void take_n_times (unsigned n, const T &t)
 Take n times the value t.
void take_n_times_ (unsigned n, const T &t)
 Default implementation of "take n times".
I::psite to_result () const
 Get the value of the accumulator.
I::value value_ () const
 Underlying value.

void init ()
 Manipulators.
void take (const argument &t)
void take (const max_site< I > &other)

Protected Attributes

bool is_valid_
I::psite max_p_
I::value max_v_

Detailed Description

template<typename I>
struct mln::accu::max_site< I >

Define an accumulator that computes the first site with the maximum value in an image.

Definition at line 53 of file max_site.hh.


Member Typedef Documentation

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

Definition at line 55 of file max_site.hh.

typedef Accumulator<void> mln::Accumulator< max_site< I > >::category [inherited]

Reimplemented from mln::Proxy< max_site< I > >.

Definition at line 80 of file accumulator.hh.

typedef max_site< I > mln::Object< max_site< I > >::exact_t [inherited]

Definition at line 173 of file object.hh.

typedef I::psite mln::accu::internal::base< I::psite , max_site< I > >::q_result [inherited]

Definition at line 58 of file base.hh.

template<typename I>
typedef I ::psite mln::accu::max_site< I >::result

Reimplemented from mln::accu::internal::base< I::psite, max_site< I > >.

Definition at line 56 of file max_site.hh.


Constructor & Destructor Documentation

template<typename I >
mln::accu::max_site< I >::max_site (  )  [inline]

Definition at line 106 of file max_site.hh.

References mln::accu::max_site< I >::init().


Member Function Documentation

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

Manipulators.

Definition at line 114 of file max_site.hh.

References mln::accu::max_site< I >::is_valid_, and mln::accu::max_site< I >::max_v_.

Referenced by mln::accu::max_site< I >::max_site().

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

Check whether this accu is able to return a result.

Always true here.

Definition at line 174 of file max_site.hh.

References mln::accu::max_site< I >::is_valid_.

Referenced by mln::accu::max_site< I >::take().

template<typename I >
mln::accu::max_site< I >::operator typename I::psite (  )  const [inline]

Definition at line 158 of file max_site.hh.

I::psite mln::accu::internal::base< I::psite , max_site< I > >::subj_ (  )  [inherited]
template<typename I >
void mln::accu::max_site< I >::take ( const argument t  )  [inline]
template<typename I >
void mln::accu::max_site< I >::take ( const max_site< I > &  other  )  [inline]
void mln::Accumulator< max_site< 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< max_site< I > >::take_as_init_ ( const T &  t  )  [inherited]

Default implementation of "take as initialization".

void mln::Accumulator< max_site< 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 '_').

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

Default implementation of "take n times".

template<typename I >
I::psite mln::accu::max_site< I >::to_result (  )  const [inline]

Get the value of the accumulator.

Definition at line 150 of file max_site.hh.

Referenced by mln::accu::max_site< I >::take().

template<typename I >
I::value mln::accu::max_site< I >::value_ (  )  const [inline]

Underlying value.

Definition at line 166 of file max_site.hh.

Referenced by mln::accu::max_site< I >::take().


Member Data Documentation

template<typename I>
bool mln::accu::max_site< I >::is_valid_ [protected]
template<typename I>
I ::psite mln::accu::max_site< I >::max_p_ [protected]

Definition at line 80 of file max_site.hh.

Referenced by mln::accu::max_site< I >::take().

template<typename I>
I ::value mln::accu::max_site< I >::max_v_ [protected]

Definition at line 81 of file max_site.hh.

Referenced by mln::accu::max_site< I >::init(), and mln::accu::max_site< I >::take().