Public Types | Public Member Functions | Protected Member Functions | Protected Attributes

mln::win::diag2d Struct Reference
[2D windows]

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

#include <diag2d.hh>

Inheritance diagram for mln::win::diag2d:
Inheritance graph

List of all members.

Public Types

typedef dpsites_fwd_piter< diag2dbkd_qiter
 Backward site iterator associated type.
typedef Window< void > category
typedef psite center_t
 Type of the window center.
typedef dpoint2d dpsite
 DPsite associated type.
typedef diag2d exact_t
typedef dpsites_fwd_piter< diag2dfwd_qiter
 Forward site iterator associated type.
typedef dpoint2d::psite psite
 Psite associated type.
typedef fwd_qiter qiter
 Site iterator associated type.
typedef window< dpoint2dregular
 Regular window associated type.
typedef dpoint2d::site site
 Site associated type.

Public Member Functions

unsigned delta () const
 Give the maximum coordinate gap between the window center and a window point.
unsigned delta_ () const
 Give the maximum coordinate gap between the window center and a window point.
 diag2d (unsigned length)
 Constructor.
const dpoint2ddp (unsigned i) const
 Give the i-th delta-point.
bool has (const dpoint2d &dp) const
 Test if the delta-point dp belongs to the window.
bool is_centered () const
 Test if the window is centered; return true.
bool is_empty () const
 Test if the window is empty (null size; no delta-point).
bool is_neighbable_ () const
 Test if this window can be a neighborhood.
bool is_symmetric () const
 Test if the window is symmetric; return true.
bool is_valid () const
 return true by default.
unsigned length () const
 Give the diagonal length, that is, its width.
void print (std::ostream &ostr) const
 Print into ostr the window definition.
void print_ (std::ostream &ostr) const
unsigned size () const
 Give the number of delta-points.
const std::vector< dpoint2d > & std_vector () const
 Give the vector of delta-points.
void sym ()
 Apply a central symmetry to the target window; a no-op here.
const std::vector< dpoint2d > & vect () const
 Give the vector of delta-points.

Protected Member Functions

void insert (const dpoint2d &d)

Protected Attributes

unsigned length_
mln::window< dpoint2dwin_

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.


Member Typedef Documentation

Backward site iterator associated type.

Definition at line 67 of file classical_window_base.hh.

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

Reimplemented from mln::Object< diag2d >.

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

Type of the window center.

Definition at line 62 of file window_base.hh.

DPsite associated type.

Definition at line 53 of file window_base.hh.

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

Definition at line 173 of file object.hh.

Forward site iterator associated type.

Definition at line 64 of file classical_window_base.hh.

Psite associated type.

Definition at line 56 of file window_base.hh.

Site iterator associated type.

Definition at line 70 of file classical_window_base.hh.

Regular window associated type.

Definition at line 60 of file classical_window_base.hh.

Site associated type.

Definition at line 59 of file window_base.hh.


Constructor & Destructor Documentation

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

Constructor.

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

Definition at line 93 of file diag2d.hh.

References mln::internal::classical_window_base< dpoint2d, diag2d >::insert().


Member Function Documentation

unsigned mln::internal::classical_window_base< dpoint2d , diag2d >::delta (  )  const [inherited]

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

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

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

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

Definition at line 112 of file diag2d.hh.

References length_.

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  )  [protected, inherited]

Referenced by diag2d().

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::window_base< dpoint2d , diag2d >::is_neighbable_ (  )  const [inherited]

Test if this window can be a neighborhood.

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 [inline]

Give the diagonal length, that is, its width.

Definition at line 106 of file diag2d.hh.

References length_.

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 [inline]

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

Definition at line 118 of file diag2d.hh.

References length_.

unsigned mln::internal::classical_window_base< dpoint2d , diag2d >::size (  )  const [inherited]

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.

void mln::internal::classical_window_base< dpoint2d , diag2d >::sym (  )  [inherited]

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.

Referenced by delta_(), length(), and print_().

Definition at line 118 of file classical_window_base.hh.