\hypertarget{a00175}{
\section{mln::doc::Weighted\_\-Window$<$ E $>$ Struct Template Reference}
\label{de/d45/a00175}\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}}
}


Documentation class for \hyperlink{a00443}{mln::Weighted\_\-Window}.  




{\ttfamily \#include $<$weighted\_\-window.hh$>$}



Inheritance diagram for mln::doc::Weighted\_\-Window$<$ E $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=256pt]{dc/dfc/a03802}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef void \hyperlink{a00175_a61dcd95473d99f959fa4a6e52cbcd74f}{bkd\_\-qiter}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00171}{Site\_\-Iterator} type associated to this weighted\_\-window to browse its points in a backward way. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00175_a50e2a6679f4f8924f8f94e57c6a43f48}{dpoint}
\begin{DoxyCompactList}\small\item\em Dpsite associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00175_a91742dfd09632cff593e5cca67258a19}{fwd\_\-qiter}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00171}{Site\_\-Iterator} type associated to this weighted\_\-window to browse its points in a forward way. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00175_acc74e1b3b451429fd3f0e8a2d66177c3}{point}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00343}{Site} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00175_a94e9c1f54f714238a1f3d2cb986f7c56}{weight}
\begin{DoxyCompactList}\small\item\em Weight associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00175_ad6a68ac436eae24abd34730bc17eefe2}{window}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00176}{Window} associated type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
unsigned \hyperlink{a00175_a8f32ea19aa9a529a1635c47787a0ef39}{delta} () const 
\begin{DoxyCompactList}\small\item\em Give the maximum coordinate gap between the window center and a window point. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00175_ab29724d94f511dbd756082c08adaf82f}{is\_\-centered} () const 
\begin{DoxyCompactList}\small\item\em Test if the weighted\_\-window is centered. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00175_ad7b79928ab6cbfe4484f7114847d8b1a}{is\_\-empty} () const 
\begin{DoxyCompactList}\small\item\em Test if the weighted window is empty. \item\end{DoxyCompactList}\item 
E \& \hyperlink{a00175_a4eff670ef88fa76df68d2b47212d5ca3}{sym} ()
\begin{DoxyCompactList}\small\item\em Apply a central symmetry to the target weighted window. \item\end{DoxyCompactList}\item 
const \hyperlink{a00175_ad6a68ac436eae24abd34730bc17eefe2}{window} \& \hyperlink{a00175_aa1ee11bb7aa6314b145d8612721c305e}{win} () const 
\begin{DoxyCompactList}\small\item\em Give the corresponding window. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename E$>$ struct mln::doc::Weighted\_\-Window$<$ E $>$}

Documentation class for \hyperlink{a00443}{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.

\begin{DoxySeeAlso}{See also}
\hyperlink{a00443}{mln::Weighted\_\-Window} 
\end{DoxySeeAlso}


Definition at line 40 of file doc/weighted\_\-window.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00175_a61dcd95473d99f959fa4a6e52cbcd74f}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!bkd\_\-qiter@{bkd\_\-qiter}}
\index{bkd\_\-qiter@{bkd\_\-qiter}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{bkd\_\-qiter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::{\bf bkd\_\-qiter}}}
\label{de/d45/a00175_a61dcd95473d99f959fa4a6e52cbcd74f}


\hyperlink{a00171}{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.

\hypertarget{a00175_a50e2a6679f4f8924f8f94e57c6a43f48}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!dpoint@{dpoint}}
\index{dpoint@{dpoint}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{dpoint}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::{\bf dpoint}}}
\label{de/d45/a00175_a50e2a6679f4f8924f8f94e57c6a43f48}


Dpsite associated type. 



Definition at line 57 of file doc/weighted\_\-window.hh.

\hypertarget{a00175_a91742dfd09632cff593e5cca67258a19}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!fwd\_\-qiter@{fwd\_\-qiter}}
\index{fwd\_\-qiter@{fwd\_\-qiter}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{fwd\_\-qiter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::{\bf fwd\_\-qiter}}}
\label{de/d45/a00175_a91742dfd09632cff593e5cca67258a19}


\hyperlink{a00171}{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.

\hypertarget{a00175_acc74e1b3b451429fd3f0e8a2d66177c3}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!point@{point}}
\index{point@{point}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{point}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::{\bf point}}}
\label{de/d45/a00175_acc74e1b3b451429fd3f0e8a2d66177c3}


\hyperlink{a00343}{Site} associated type. 



Definition at line 54 of file doc/weighted\_\-window.hh.

\hypertarget{a00175_a94e9c1f54f714238a1f3d2cb986f7c56}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!weight@{weight}}
\index{weight@{weight}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{weight}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::{\bf weight}}}
\label{de/d45/a00175_a94e9c1f54f714238a1f3d2cb986f7c56}


Weight associated type. 



Definition at line 60 of file doc/weighted\_\-window.hh.

\hypertarget{a00175_ad6a68ac436eae24abd34730bc17eefe2}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!window@{window}}
\index{window@{window}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{window}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::{\bf window}}}
\label{de/d45/a00175_ad6a68ac436eae24abd34730bc17eefe2}


\hyperlink{a00176}{Window} associated type. 



Definition at line 63 of file doc/weighted\_\-window.hh.



\subsection{Member Function Documentation}
\hypertarget{a00175_a8f32ea19aa9a529a1635c47787a0ef39}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!delta@{delta}}
\index{delta@{delta}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{delta}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ unsigned {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::delta (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{de/d45/a00175_a8f32ea19aa9a529a1635c47787a0ef39}


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

\hypertarget{a00175_ab29724d94f511dbd756082c08adaf82f}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!is\_\-centered@{is\_\-centered}}
\index{is\_\-centered@{is\_\-centered}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{is\_\-centered}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::is\_\-centered (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{de/d45/a00175_ab29724d94f511dbd756082c08adaf82f}


Test if the weighted\_\-window is centered. 

A weighted window is centered is the origin belongs to it. \hypertarget{a00175_ad7b79928ab6cbfe4484f7114847d8b1a}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!is\_\-empty@{is\_\-empty}}
\index{is\_\-empty@{is\_\-empty}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{is\_\-empty}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::is\_\-empty (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{de/d45/a00175_ad7b79928ab6cbfe4484f7114847d8b1a}


Test if the weighted window is empty. 

A weighted\_\-window of null size is empty. \hypertarget{a00175_a4eff670ef88fa76df68d2b47212d5ca3}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!sym@{sym}}
\index{sym@{sym}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{sym}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ E\& {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::sym (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{de/d45/a00175_a4eff670ef88fa76df68d2b47212d5ca3}


Apply a central symmetry to the target weighted window. 

\hypertarget{a00175_aa1ee11bb7aa6314b145d8612721c305e}{
\index{mln::doc::Weighted\_\-Window@{mln::doc::Weighted\_\-Window}!win@{win}}
\index{win@{win}!mln::doc::Weighted_Window@{mln::doc::Weighted\_\-Window}}
\subsubsection[{win}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf window}\& {\bf mln::doc::Weighted\_\-Window}$<$ E $>$::win (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{de/d45/a00175_aa1ee11bb7aa6314b145d8612721c305e}


Give the corresponding window. 

