Milena (Olena)  User documentation 2.0a Id
mln::win::diag2d Struct Reference

Diagonal line window defined on the 2D square grid. More...

#include <diag2d.hh>

Inherits mln::internal::classical_window_base< dpoint2d, diag2d >.

List of all members.

Public Member Functions

 diag2d (unsigned length)
 Constructor.
unsigned length () const
 Give the diagonal length, that is, its width.

Detailed Description

Diagonal line window defined on the 2D square grid.

An diag2d is centered and symmetric. its width (length) is odd.

For instance:

     *          o
     *        o
     *      x
     *    o
     *  o
     * 

is defined with length = 5.

Definition at line 63 of file diag2d.hh.


Constructor & Destructor Documentation

mln::win::diag2d::diag2d ( unsigned  length) [inline]

Constructor.

Parameters:
[in]lengthLength, thus width, of the diagonal line.
Precondition:
length is odd.

Definition at line 93 of file diag2d.hh.

References length().


Member Function Documentation

unsigned mln::win::diag2d::length ( ) const [inline]

Give the diagonal length, that is, its width.

Definition at line 106 of file diag2d.hh.

Referenced by diag2d().

 All Classes Namespaces Functions Variables Typedefs Enumerator