mln::win::cube3d Struct Reference [3D windows]

Cube window defined on the 3D grid. More...

#include <cube3d.hh>

Inheritance diagram for mln::win::cube3d:

List of all members.

Public Types
typedef dpsites_fwd_piter< cube3d >	bkd_qiter
	Backward site iterator associated type.
typedef Window< void >	category
typedef dpoint3d	dpsite
	DPsite associated type.
typedef cube3d	exact_t
typedef dpsites_fwd_piter< cube3d >	fwd_qiter
	Forward site iterator associated type.
typedef dpoint3d::psite	psite
	Psite associated type.
typedef fwd_qiter	qiter
	Site iterator associated type.
typedef window< dpoint3d >	regular
	Regular window associated type.
typedef dpoint3d::site	site
	Site associated type.
Public Member Functions
	cube3d (unsigned length)
	Constructor.
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.
const dpoint3d &	dp (unsigned i) const
	Give the i-th delta-point.
bool	has (const dpoint3d &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 cube length, that is, its height.
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< dpoint3d > &	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< dpoint3d > &	vect () const
	Give the vector of delta-points.
Protected Member Functions
void	insert (const dpoint3d &d)
Protected Attributes
unsigned	length_
mln::window< dpoint3d >	win_

---

Detailed Description

Cube window defined on the 3D grid.

An cube3d is centered and symmetric; so its height (length) is odd.

For instance:

     *   o o o
     *  o o o
     * o o o

     *   o o o
     *  o x o
     * o o o

     *   o o o
     *  o o o
     * o o o
     * 

is defined with length = 3.

---

Member Typedef Documentation

typedef dpsites_fwd_piter<cube3d > mln::internal::classical_window_base< dpoint3d , cube3d >::bkd_qiter [inherited]

Backward site iterator associated type.

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

Reimplemented from mln::Object< cube3d >.

typedef dpoint3d mln::internal::window_base< dpoint3d , cube3d >::dpsite [inherited]

DPsite associated type.

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

typedef dpsites_fwd_piter<cube3d > mln::internal::classical_window_base< dpoint3d , cube3d >::fwd_qiter [inherited]

Forward site iterator associated type.

typedef dpoint3d ::psite mln::internal::window_base< dpoint3d , cube3d >::psite [inherited]

Psite associated type.

typedef fwd_qiter mln::internal::classical_window_base< dpoint3d , cube3d >::qiter [inherited]

Site iterator associated type.

typedef window<dpoint3d > mln::internal::classical_window_base< dpoint3d , cube3d >::regular [inherited]

Regular window associated type.

typedef dpoint3d ::site mln::internal::window_base< dpoint3d , cube3d >::site [inherited]

Site associated type.

---

Constructor & Destructor Documentation

mln::win::cube3d::cube3d

(

unsigned

length

)

[inline]

Constructor.

Parameters:

[in]

length

Length, thus height, of the cube3d.

Precondition:

length is odd.

References mln::internal::classical_window_base< dpoint3d, cube3d >::insert().

---

Member Function Documentation

unsigned mln::internal::classical_window_base< dpoint3d , cube3d >::delta

(

)

const [inherited]

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

unsigned mln::win::cube3d::delta_

(

)

const [inline]

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

Reimplemented from mln::internal::classical_window_base< dpoint3d, cube3d >.

References length_.

const dpoint3d & mln::internal::classical_window_base< dpoint3d , cube3d >::dp

(

unsigned

i

)

const [inherited]

Give the i-th delta-point.

bool mln::internal::classical_window_base< dpoint3d , cube3d >::has

(

const dpoint3d &

dp

)

const [inherited]

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

void mln::internal::classical_window_base< dpoint3d , cube3d >::insert

(

const dpoint3d &

d

)

[protected, inherited]

Referenced by cube3d().

bool mln::internal::classical_window_base< dpoint3d , cube3d >::is_centered

(

)

const [inherited]

Test if the window is centered; return true.

bool mln::internal::classical_window_base< dpoint3d , cube3d >::is_empty

(

)

const [inherited]

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

bool mln::internal::window_base< dpoint3d , cube3d >::is_neighbable_

(

)

const [inherited]

Test if this window can be a neighborhood.

bool mln::internal::classical_window_base< dpoint3d , cube3d >::is_symmetric

(

)

const [inherited]

Test if the window is symmetric; return true.

bool mln::internal::window_base< dpoint3d , cube3d >::is_valid

(

)

const [inherited]

return true by default.

unsigned mln::win::cube3d::length

(

)

const [inline]

Give the cube length, that is, its height.

References length_.

void mln::internal::classical_window_base< dpoint3d , cube3d >::print

(

std::ostream &

ostr

)

const [inherited]

Print into ostr the window definition.

void mln::win::cube3d::print_

(

std::ostream &

ostr

)

const [inline]

Reimplemented from mln::internal::classical_window_base< dpoint3d, cube3d >.

References length_.

unsigned mln::internal::classical_window_base< dpoint3d , cube3d >::size

(

)

const [inherited]

Give the number of delta-points.

const std::vector<dpoint3d >& mln::internal::classical_window_base< dpoint3d , cube3d >::std_vector

(

)

const [inherited]

Give the vector of delta-points.

void mln::internal::classical_window_base< dpoint3d , cube3d >::sym

(

)

[inherited]

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

const std::vector<dpoint3d >& mln::internal::classical_window_base< dpoint3d , cube3d >::vect

(

)

const [inherited]

Give the vector of delta-points.

---

Member Data Documentation

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

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

mln::window<dpoint3d > mln::internal::classical_window_base< dpoint3d , cube3d >::win_ [protected, inherited]