oln::abstract::window_base< Sup, Exact > Struct Template Reference

Window Base. More...

#include <window_base.hh>

Inheritance diagram for oln::abstract::window_base< Sup, Exact >:

[legend]Collaboration diagram for oln::abstract::window_base< Sup, Exact >:

[legend]List of all members.

Public Types
typedef window_base< Sup, Exact >	self_type
	Set self type.
typedef struct_elt_traits< Exact >::point_type	point_type
	The associate image's type of point.
typedef struct_elt_traits< Exact >::dpoint_type	dpoint_type
	The associate image's type of dpoint (move point).
typedef Exact	exact_type
	Set exact type.
typedef Sup	super_type
	Set type of class inherited.
enum	{ dim = struct_elt_traits<Exact >::dim }
Static Public Member Functions
std::string	name ()
	Return the name of the type.
Protected Member Functions
bool	has_ (const dpoint_type &dp) const
	Test if the set of points contains this one. dp a dpoint (deplacement point).
unsigned	card_ () const
	Get the number of points.
bool	is_centered_ () const
	Test if the set of points is centered.
bool	is_equal (const exact_type &win) const
	Compare two sets of points. win The set of point to compare.
coord	get_delta () const
	Get the delta of the set of points.
coord	delta_update (const dpoint_type &dp)
	Update delta. dp a deplacement point.
void	sym_ ()
	Set a set of point to opposite.
const dpoint_type	at (unsigned i) const
	Get the nth structuring element. i The nth.
	window_base ()
	CTor.
	window_base (unsigned size)
	Used only by sub-classes size The number of point.
Protected Attributes
std::vector< dpoint_type >	dp_
	The list of point.
max_accumulator< coord >	delta_
	Delta : the maximale point of the list.
bool	centered_
	Is the set of point centered ?
Friends
class	struct_elt< Exact >
class	neighborhood< Exact >

---

Detailed Description

template<class Sup, class Exact>
struct oln::abstract::window_base< Sup, Exact >

Window Base.

A window is a set of points and this class defines how to deal with. This class regroups common things for window, w_window (weight window) and neighborhood. Here, a set of point is a window or a weigh window or a neighborhood.

Definition at line 103 of file window_base.hh.

---

Member Typedef Documentation

template<class Sup, class Exact> typedef struct_elt_traits<Exact>::dpoint_type oln::abstract::window_base< Sup, Exact >::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 in oln::abstract::neighborhoodnd< Exact >, oln::abstract::w_windownd< Exact >, oln::abstract::windownd< Exact >, oln::neighborhood1d, oln::neighborhood2d, oln::neighborhood3d, oln::w_window1d< T >, oln::w_window2d< T >, oln::w_window3d< T >, oln::window1d, oln::window2d, oln::window3d, oln::abstract::neighborhoodnd< neighborhood3d >, oln::abstract::neighborhoodnd< neighborhood2d >, oln::abstract::neighborhoodnd< neighborhood1d >, oln::abstract::w_windownd< w_window2d< T2 > >, oln::abstract::w_windownd< w_window2d< T > >, oln::abstract::w_windownd< w_window1d< T > >, oln::abstract::w_windownd< w_window3d< T > >, oln::abstract::windownd< window1d >, oln::abstract::windownd< window3d >, oln::abstract::windownd< window2d >, and oln::w_window2d< T2 >. Definition at line 122 of file window_base.hh.

template<class Sup, class Exact> typedef struct_elt_traits<Exact>::point_type oln::abstract::window_base< Sup, Exact >::point_type

The associate image's type of point. Warning: Prefer the macros oln_point_type(Pointable) and oln_point_type_(Pointable) (the same without the 'typename' keyword) Definition at line 115 of file window_base.hh.

---

Constructor & Destructor Documentation

template<class Sup, class Exact> oln::abstract::window_base< Sup, Exact >::window_base (   )  [inline, protected]

CTor. Used only by sub-classes Definition at line 251 of file window_base.hh. : super_type(), dp_(), delta_(0) { centered_ = false; }

template<class Sup, class Exact> oln::abstract::window_base< Sup, Exact >::window_base (  unsigned  size  )  [inline, protected]

Used only by sub-classes size The number of point. Set the number of points this object will get. Used only by sub-classes Definition at line 263 of file window_base.hh. : super_type(), dp_(), delta_(0) { dp_.reserve(size); centered_ = false; }

---

Member Function Documentation

template<class Sup, class Exact> const dpoint_type oln::abstract::window_base< Sup, Exact >::at (  unsigned  i  )  const [inline, protected]

Get the nth structuring element. i The nth. Returns: The nth dpoint. Precondition: i < card(). Definition at line 240 of file window_base.hh. { precondition(i < this->card()); return dp_[i]; }

template<class Sup, class Exact> unsigned oln::abstract::window_base< Sup, Exact >::card_ (   )  const [inline, protected]

Get the number of points. Returns: The number of points. Definition at line 162 of file window_base.hh. { return dp_.size(); }

template<class Sup, class Exact> coord oln::abstract::window_base< Sup, Exact >::delta_update (  const dpoint_type &  dp  )  [inline, protected]

Update delta. dp a deplacement point. Returns: Delta. If the point is the biggest element of the set of points, then this point is assigned to delta. Definition at line 216 of file window_base.hh. { return this->exact().delta_update_(dp); }

template<class Sup, class Exact> coord oln::abstract::window_base< Sup, Exact >::get_delta (   )  const [inline, protected]

Get the delta of the set of points. Returns: Delta. Delta is the bigger element of the set of points. Definition at line 202 of file window_base.hh. { return delta_; }

template<class Sup, class Exact> bool oln::abstract::window_base< Sup, Exact >::has_ (  const dpoint_type &  dp  )  const [inline, protected]

Test if the set of points contains this one. dp a dpoint (deplacement point). Returns: True if the set of points contains this dpoint. Definition at line 152 of file window_base.hh. { return std::find(dp_.begin(), dp_.end(), dp) != dp_.end(); }

template<class Sup, class Exact> bool oln::abstract::window_base< Sup, Exact >::is_centered_ (   )  const [inline, protected]

Test if the set of points is centered. Returns: True if it's centered. Centered means : at least one element for neighborhood; list of point contains 0 for window. Definition at line 176 of file window_base.hh. { return centered_; }

template<class Sup, class Exact> bool oln::abstract::window_base< Sup, Exact >::is_equal (  const exact_type &  win  )  const [inline, protected]

Compare two sets of points. win The set of point to compare. Returns: True if they are the same. Definition at line 187 of file window_base.hh. { for (typename std::vector<dpoint_type>::const_iterator it = dp_.begin(); it != dp_.end(); ++it) if (std::find(win.dp_.begin(), win.dp_.end(), *it) == win.dp_.end()) return false; return true; }

template<class Sup, class Exact> void oln::abstract::window_base< Sup, Exact >::sym_ (   )  [inline, protected]

Set a set of point to opposite. Each point of the set of point is assigned to its opposite. Definition at line 227 of file window_base.hh. { for (unsigned i = 0; i < this->card(); ++i) dp_[i] = - dp_[i]; }

---

Friends And Related Function Documentation

template<class Sup, class Exact> friend class struct_elt< Exact > [friend]

Todo: FIXME: this has been commented out to satisfy icc and comeau. I don't know who is right between them and gcc. Definition at line 133 of file window_base.hh.

---

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

• window_base.hh

---