oln::window3d Class Reference

Window 3 dimensions. More...

#include <window3d.hh>

Inheritance diagram for oln::window3d:

[legend]Collaboration diagram for oln::window3d:

[legend]List of all members.

Public Types
typedef abstract::windownd< window3d >	super_type
	The super type.
typedef window3d	self_type
	The self type.
typedef struct_elt_traits< self_type >::iter_type	iter_type
	The associate image's type of iterator.
typedef struct_elt_traits< self_type >::neighb_type	neighb_type
	Type of neighbor.
typedef struct_elt_traits< self_type >::dpoint_type	dpoint_type
	The associate image's type of dpoint (move point).
Public Member Functions
window3d &	add (const dpoint_type &dp)
	Add a dpoint (move point) to the window. dp The new point.
window3d &	add (coord slice, coord row, coord col)
	Add a point by coordinates to the window. slice The coordinate (slice) of the new point. row The coordinate (row) of the new point. col The coordinate (col) of the new point.
	window3d ()
	Construct a window of 3 dimensions.
	window3d (unsigned size)
	Construct a window of 3 dimensions. size The number of element.
	window3d (unsigned n, const coord crd[])
	Construct a window of 3 dimensions from several points. n The number of element. crd The coordinates of the elements.
Static Public Member Functions
std::string	name ()
	Return the name of the type.
Protected Member Functions
coord	delta_update_ (const dpoint_type &dp)
	Update delta. dp a move point.
Friends
class	abstract::window_base< abstract::window< window3d >, window3d >

---

Detailed Description

Window 3 dimensions.

A window is a set of points. This class defines how to deal with. These points have 3 dimensions.

Definition at line 63 of file window3d.hh.

---

Member Typedef Documentation

typedef struct_elt_traits< self_type >::dpoint_type oln::window3d::dpoint_type

The associate image's type of dpoint (move point). Warning: Prefer the macros oln_dpoint_type(Pointable) and oln_dpoint_type_(Pointable) (the same without the 'typename' keyword) Reimplemented from oln::abstract::windownd< window3d >. Definition at line 87 of file window3d.hh. Referenced by add(), and window3d().

typedef struct_elt_traits< self_type >::iter_type oln::window3d::iter_type

The associate image's type of iterator. Warning: Prefer the macros oln_iter_type(Iterable) and oln_iter_type_(Iterable) (the same without the 'typename' keyword) Definition at line 77 of file window3d.hh.

---

Member Function Documentation

window3d& oln::window3d::add (  coord  slice, coord  row, coord  col )  [inline]

Add a point by coordinates to the window. slice The coordinate (slice) of the new point. row The coordinate (row) of the new point. col The coordinate (col) of the new point. Add a new member by its coordinates to the window. The coordinates are only the column number, row number and column number because the window has 3 dimensions. Definition at line 113 of file window3d.hh. References add(), oln::coord, and dpoint_type. { return this->add(dpoint_type(slice, row, col)); }

window3d& oln::window3d::add (  const dpoint_type &  dp  )  [inline]

Add a dpoint (move point) to the window. dp The new point. Add a new member to the window. This point must be of 3 dimensions. Definition at line 98 of file window3d.hh. Referenced by add(), oln::mk_win_block(), oln::mk_win_ellipsoid(), oln::mk_win_from_neighb(), and window3d(). { return this->exact().add_(dp); }

coord oln::window3d::delta_update_ (  const dpoint_type &  dp  )  [inline, protected]

Update delta. dp a move point. Returns: Delta. If the point is the biggest element of the window. then this point is assigned to delta. Definition at line 160 of file window3d.hh. References oln::abstract::window_base< window< window3d >, window3d >::delta_. { delta_(abs(dp.slice())); delta_(abs(dp.row())); delta_(abs(dp.col())); return delta_; }

---

The documentation for this class was generated from the following file:

• window3d.hh

---