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:

List of all members.

Public Types

typedef dpsites_fwd_piter< E > bkd_qiter

Backward site iterator associated type.

typedef Window< void > category

typedef psite center_t

Type of the window center.

typedef D dpsite

DPsite associated type.

typedef E exact_t

typedef dpsites_fwd_piter< E > fwd_qiter

Forward site iterator associated type.

typedef D::psite psite

Psite associated type.

typedef fwd_qiter qiter

Site iterator associated type.

typedef window< D > regular

Regular window associated type.

typedef D::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 D & dp (unsigned i) const

Give the i-th delta-point.

bool has (const D &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< D > & 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< D > & vect () const

Give the vector of delta-points.

Protected Member Functions

void insert (const D &d)

Protected Attributes

unsigned length_

mln::window< D > win_

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

template<typename D, typename E>

typedef dpsites_fwd_piter<E> mln::internal::classical_window_base< D, E >::bkd_qiter [inherited]

Backward site iterator associated type.

Definition at line 67 of file classical_window_base.hh.

template<typename E>

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

Reimplemented from mln::Object< E >.

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

template<typename D, typename E>

typedef psite mln::internal::window_base< D, E >::center_t [inherited]

Type of the window center.

Definition at line 62 of file window_base.hh.

template<typename D, typename E>

typedef D mln::internal::window_base< D, E >::dpsite [inherited]

DPsite associated type.

Reimplemented in mln::win::multiple< W, F >, and mln::win::multiple_size< n, W, F >.

Definition at line 53 of file window_base.hh.

template<typename E>

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

Definition at line 172 of file object.hh.

template<typename D, typename E>

typedef dpsites_fwd_piter<E> mln::internal::classical_window_base< D, E >::fwd_qiter [inherited]

Forward site iterator associated type.

Definition at line 64 of file classical_window_base.hh.

template<typename D, typename E>

typedef D ::psite mln::internal::window_base< D, E >::psite [inherited]

Psite associated type.

Reimplemented in mln::win::multiple< W, F >, and mln::win::multiple_size< n, W, F >.

Definition at line 56 of file window_base.hh.

template<typename D, typename E>

typedef fwd_qiter mln::internal::classical_window_base< D, E >::qiter [inherited]

Site iterator associated type.

Definition at line 70 of file classical_window_base.hh.

template<typename D, typename E>

typedef window<D> mln::internal::classical_window_base< D, E >::regular [inherited]

Regular window associated type.

Definition at line 60 of file classical_window_base.hh.

template<typename D, typename E>

typedef D ::site mln::internal::window_base< D, E >::site [inherited]

Site associated type.

Reimplemented in mln::win::multiple< W, F >, and mln::win::multiple_size< n, W, F >.

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< D, E >::insert().

Member Function Documentation

template<typename D, typename E>

unsigned mln::internal::classical_window_base< D, E >::delta ( ) const [inline, inherited]

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

Definition at line 177 of file classical_window_base.hh.

References mln::exact().

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< D, E >.

Definition at line 112 of file diag2d.hh.

References length_.

template<typename D, typename E>

const D & mln::internal::classical_window_base< D, E >::dp ( unsigned i ) const [inline, inherited]

Give the i-th delta-point.

Definition at line 196 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::size(), and mln::internal::classical_window_base< D, E >::win_.

template<typename D, typename E>

bool mln::internal::classical_window_base< D, E >::has ( const D & dp ) const [inline, inherited]

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

Definition at line 221 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

template<typename D, typename E>

void mln::internal::classical_window_base< D, E >::insert ( const D & d ) [inline, protected, inherited]

Definition at line 229 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

Referenced by mln::win::backdiag2d::backdiag2d(), mln::win::ball< G, C >::ball(), mln::win::cube3d::cube3d(), mln::win::cuboid3d::cuboid3d(), diag2d(), mln::win::line< M, i, C >::line(), mln::win::octagon2d::octagon2d(), and mln::win::rectangle2d::rectangle2d().

template<typename D, typename E>

bool mln::internal::classical_window_base< D, E >::is_centered ( ) const [inline, inherited]

Test if the window is centered; return true.

Definition at line 150 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

template<typename D, typename E>

bool mln::internal::classical_window_base< D, E >::is_empty ( ) const [inline, inherited]

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

Definition at line 142 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

template<typename D, typename E>

bool mln::internal::window_base< D, E >::is_neighbable_ ( ) const [inline, inherited]

Test if this window can be a neighborhood.

Definition at line 95 of file window_base.hh.

References mln::exact().

Referenced by mln::convert::over_load::from_to_().

template<typename D, typename E>

bool mln::internal::classical_window_base< D, E >::is_symmetric ( ) const [inline, inherited]

Test if the window is symmetric; return true.

Definition at line 159 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

template<typename D, typename E>

bool mln::internal::window_base< D, E >::is_valid ( ) const [inline, inherited]

return true by default.

Definition at line 87 of file window_base.hh.

Referenced by mln::morpho::approx::impl::dilation_by_distance_thresholding_2d(), mln::morpho::approx::impl::dilation_by_distance_thresholding_3d(), mln::morpho::approx::impl::erosion_by_distance_thresholding_2d(), and mln::morpho::approx::impl::erosion_by_distance_thresholding_3d().

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_.

template<typename D, typename E>

void mln::internal::classical_window_base< D, E >::print ( std::ostream & ostr ) const [inline, inherited]

Print into ostr the window definition.

Definition at line 237 of file classical_window_base.hh.

References mln::exact().

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

Reimplemented from mln::internal::classical_window_base< D, E >.

Definition at line 118 of file diag2d.hh.

References length_.

template<typename D, typename E>

unsigned mln::internal::classical_window_base< D, E >::size ( ) const [inline, inherited]

Give the number of delta-points.

Reimplemented in mln::win::line< M, i, C >.

Definition at line 134 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

Referenced by mln::internal::classical_window_base< D, E >::dp().

template<typename D, typename E>

const std::vector< D > & mln::internal::classical_window_base< D, E >::std_vector ( ) const [inline, inherited]

Give the vector of delta-points.

Reimplemented in mln::win::rectangle2d.

Definition at line 205 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

Referenced by mln::internal::classical_window_base< D, E >::vect().

template<typename D, typename E>

void mln::internal::classical_window_base< D, E >::sym ( ) [inline, inherited]

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

Definition at line 168 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::win_.

template<typename D, typename E>

const std::vector< D > & mln::internal::classical_window_base< D, E >::vect ( ) const [inline, inherited]

Give the vector of delta-points.

Definition at line 213 of file classical_window_base.hh.

References mln::internal::classical_window_base< D, E >::std_vector().

Member Data Documentation

unsigned mln::win::diag2d::length_ [protected]

Definition at line 85 of file diag2d.hh.

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

template<typename D, typename E>

mln::window<D> mln::internal::classical_window_base< D, E >::win_ [protected, inherited]

Definition at line 118 of file classical_window_base.hh.


Public Types
typedef dpsites_fwd_piter< E >	bkd_qiter
	Backward site iterator associated type.
typedef Window< void >	category
typedef psite	center_t
	Type of the window center.
typedef D	dpsite
	DPsite associated type.
typedef E	exact_t
typedef dpsites_fwd_piter< E >	fwd_qiter
	Forward site iterator associated type.
typedef D::psite	psite
	Psite associated type.
typedef fwd_qiter	qiter
	Site iterator associated type.
typedef window< D >	regular
	Regular window associated type.
typedef D::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 D &	dp (unsigned i) const
	Give the `i-th` delta-point.
bool	has (const D &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< D > &	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< D > &	vect () const
	Give the vector of delta-points.
Protected Member Functions
void	insert (const D &d)
Protected Attributes
unsigned	length_
mln::window< D >	win_

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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