mln::doc::Weighted_Window< E > Struct Template Reference
Documentation class for mln::Weighted_Window. More...
#include <weighted_window.hh>
Public Types | |
| typedef void | bkd_qiter |
| Site_Iterator type associated to this weighted_window to browse its points in a backward way. | |
| typedef void | dpoint |
| Dpsite associated type. | |
| typedef void | fwd_qiter |
| Site_Iterator type associated to this weighted_window to browse its points in a forward way. | |
| typedef void | point |
| Site associated type. | |
| typedef void | weight |
| Weight associated type. | |
| typedef void | window |
| Window associated type. | |
Public Member Functions | |
| unsigned | delta () const |
| Give the maximum coordinate gap between the window center and a window point. | |
| bool | is_centered () const |
| Test if the weighted_window is centered. | |
| bool | is_empty () const |
| Test if the weighted window is empty. | |
| E & | sym () |
| Apply a central symmetry to the target weighted window. | |
| const window & | win () const |
| Give the corresponding window. | |
Detailed Description
template<typename E>
struct mln::doc::Weighted_Window< E >
Documentation class for mln::Weighted_Window.
A weighted_window is the definition of a set of points located around a central point, with a weight associated to each point.
- See also:
- mln::Weighted_Window
Definition at line 40 of file doc/weighted_window.hh.
Member Typedef Documentation
| typedef void mln::doc::Weighted_Window< E >::bkd_qiter |
Site_Iterator type associated to this weighted_window to browse its points in a backward way.
Definition at line 51 of file doc/weighted_window.hh.
| typedef void mln::doc::Weighted_Window< E >::dpoint |
| typedef void mln::doc::Weighted_Window< E >::fwd_qiter |
Site_Iterator type associated to this weighted_window to browse its points in a forward way.
Definition at line 46 of file doc/weighted_window.hh.
| typedef void mln::doc::Weighted_Window< E >::point |
| typedef void mln::doc::Weighted_Window< E >::weight |
| typedef void mln::doc::Weighted_Window< E >::window |
Member Function Documentation
| unsigned mln::doc::Weighted_Window< E >::delta | ( | ) | const |
| bool mln::doc::Weighted_Window< E >::is_centered | ( | ) | const |
Test if the weighted_window is centered.
A weighted window is centered is the origin belongs to it.
| bool mln::doc::Weighted_Window< E >::is_empty | ( | ) | const |
Test if the weighted window is empty.
A weighted_window of null size is empty.
| E& mln::doc::Weighted_Window< E >::sym | ( | ) |
Apply a central symmetry to the target weighted window.
| const window& mln::doc::Weighted_Window< E >::win | ( | ) | const |
Give the corresponding window.
