Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::win::ball< G, C > Struct Template Reference

Generic ball window defined on a given grid. More...

#include <ball.hh>

Inherits mln::internal::classical_window_base< dpoint< G, C >, ball< G, C > >.

Public Member Functions

 ball (unsigned diameter)
 Constructor.
 
unsigned diameter () const
 Give the ball diameter.
 

Detailed Description

template<typename G, typename C>
struct mln::win::ball< G, C >

Generic ball window defined on a given grid.

A ball is centered and symmetric; so its diameter is odd.

G is the given grid on which the ball is defined and C is the type of coordinates.

Definition at line 71 of file ball.hh.

Constructor & Destructor Documentation

template<typename G , typename C >
ball< G, C >::ball ( unsigned  diameter)
inline

Constructor.

Parameters
[in]diameterDiameter of the ball.
Precondition
diameter is odd.

Definition at line 99 of file ball.hh.

References mln::literal::origin.

Member Function Documentation

template<typename G , typename C >
unsigned ball< G, C >::diameter ( ) const
inline

Give the ball diameter.

Definition at line 122 of file ball.hh.