$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::win::diag2d Struct Reference

#include <mln/win/diag2d.hh>

Public Member Functions

 diag2d (unsigned length)
unsigned delta () const
unsigned delta_ () const
const dpoint2ddp (unsigned i) const
bool has (const dpoint2d &dp) const
bool is_centered () const
bool is_empty () const
bool is_symmetric () const
bool is_valid () const
unsigned length () const
void print (std::ostream &ostr) const
void print_ (std::ostream &ostr) const
unsigned size () const
const std::vector< dpoint2d > & std_vector () const
void sym ()
const std::vector< dpoint2d > & vect () const

Protected Member Functions

void insert (const dpoint2d &d)

Protected Attributes

unsigned length_
mln::window< dpoint2dwin_

Public Types

typedef dpsites_fwd_piter< diag2dbkd_qiter
typedef Window< void > category
typedef psite center_t
typedef dpoint2d dpsite
typedef diag2d exact_t
typedef dpsites_fwd_piter< diag2dfwd_qiter
typedef dpoint2d::psite psite
typedef fwd_qiter qiter
typedef window< dpoint2dregular
typedef dpoint2d::site site

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)

Constructor.

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

Member Function Documentation

Give the maximum coordinate gap between the window center and a window point.

unsigned mln::win::diag2d::delta_ ( ) const

Give the maximum coordinate gap between the window center and a window point.

Reimplemented from mln::internal::classical_window_base< dpoint2d, diag2d >.

const dpoint2d & mln::internal::classical_window_base< dpoint2d , diag2d >::dp ( unsigned  i) const
inherited

Give the i-th delta-point.

bool mln::internal::classical_window_base< dpoint2d , diag2d >::has ( const dpoint2d dp) const
inherited

Test if the delta-point dp belongs to the window.

void mln::internal::classical_window_base< dpoint2d , diag2d >::insert ( const dpoint2d d)
protectedinherited
bool mln::internal::classical_window_base< dpoint2d , diag2d >::is_centered ( ) const
inherited

Test if the window is centered; return true.

bool mln::internal::classical_window_base< dpoint2d , diag2d >::is_empty ( ) const
inherited

Test if the window is empty (null size; no delta-point).

bool mln::internal::classical_window_base< dpoint2d , diag2d >::is_symmetric ( ) const
inherited

Test if the window is symmetric; return true.

bool mln::internal::window_base< dpoint2d , diag2d >::is_valid ( ) const
inherited

return true by default.

unsigned mln::win::diag2d::length ( ) const

Give the diagonal length, that is, its width.

void mln::internal::classical_window_base< dpoint2d , diag2d >::print ( std::ostream &  ostr) const
inherited

Print into ostr the window definition.

void mln::win::diag2d::print_ ( std::ostream &  ostr) const

Give the number of delta-points.

const std::vector<dpoint2d >& mln::internal::classical_window_base< dpoint2d , diag2d >::std_vector ( ) const
inherited

Give the vector of delta-points.

Apply a central symmetry to the target window; a no-op here.

const std::vector<dpoint2d >& mln::internal::classical_window_base< dpoint2d , diag2d >::vect ( ) const
inherited

Give the vector of delta-points.

Member Data Documentation

unsigned mln::win::diag2d::length_
protected

Definition at line 85 of file diag2d.hh.

Definition at line 119 of file classical_window_base.hh.

Member Typedef Documentation

Backward site iterator associated type.

Definition at line 68 of file classical_window_base.hh.

typedef Window<void> mln::Window< diag2d >::category
inherited

Definition at line 95 of file concept/window.hh.

Type of the window center.

Definition at line 64 of file window_base.hh.

DPsite associated type.

Definition at line 55 of file window_base.hh.

typedef diag2d mln::Object< diag2d >::exact_t
inherited

Definition at line 105 of file object.hh.

Forward site iterator associated type.

Definition at line 65 of file classical_window_base.hh.

Psite associated type.

Definition at line 58 of file window_base.hh.

Site iterator associated type.

Definition at line 71 of file classical_window_base.hh.

Regular window associated type.

Definition at line 61 of file classical_window_base.hh.

Site associated type.

Definition at line 61 of file window_base.hh.