\hypertarget{a00169}{
\section{mln::doc::Pixel\_\-Iterator$<$ E $>$ Struct Template Reference}
\label{de/d53/a00169}\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}}
}


Documentation class for \hyperlink{a00046}{mln::Iterator}.  




{\ttfamily \#include $<$pixel\_\-iterator.hh$>$}



Inheritance diagram for mln::doc::Pixel\_\-Iterator$<$ E $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{d6/d8b/a03791}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef void \hyperlink{a00164_a664eece9557475f6e80cc1d19572dd2e}{image}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00165}{Image} associated type (with possible const qualification). \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00169_a6929acdf91af7d1708162b9b5e277698}{lvalue}
\begin{DoxyCompactList}\small\item\em Type returned by the read-\/write dereference operator. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00164_af49bda288f86606405f85140963437da}{rvalue}
\begin{DoxyCompactList}\small\item\em Read-\/only value associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00164_a67bfe34cad9a2eecef90678b7510e6a2}{value}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00418}{Value} associated type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a00164_a664eece9557475f6e80cc1d19572dd2e}{image} \& \hyperlink{a00164_a87e1cc4cc5af64ad4e82c534e2dd76f9}{ima} () const 
\begin{DoxyCompactList}\small\item\em Give the image of this generalized pixel. \item\end{DoxyCompactList}\item 
void \hyperlink{a00166_adef6af1f96b175248bccfc3224bc1dca}{invalidate} ()
\begin{DoxyCompactList}\small\item\em Invalidate the iterator. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00166_aed075f24d56b458a704a4988e44e1452}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Returns true if the iterator is valid, that is, designates an element. \item\end{DoxyCompactList}\item 
void \hyperlink{a00166_a694ae2e37aa59381af9dc5eb9ce9bbe8}{start} ()
\begin{DoxyCompactList}\small\item\em Start an iteration. \item\end{DoxyCompactList}\item 
\hyperlink{a00169_a6929acdf91af7d1708162b9b5e277698}{lvalue} \hyperlink{a00169_a19b6a81fa25a1a53c57bf967609813da}{val} () const 
\begin{DoxyCompactList}\small\item\em Give the pixel value. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


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

Documentation class for \hyperlink{a00046}{mln::Iterator}. \begin{DoxySeeAlso}{See also}
\hyperlink{a00327}{mln::Pixel\_\-Iterator} 
\end{DoxySeeAlso}


Definition at line 36 of file doc/pixel\_\-iterator.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00164_a664eece9557475f6e80cc1d19572dd2e}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!image@{image}}
\index{image@{image}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{image}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Generalized\_\-Pixel}$<$ E $>$::{\bf image}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{db/ddf/a00164_a664eece9557475f6e80cc1d19572dd2e}


\hyperlink{a00165}{Image} associated type (with possible const qualification). 



Definition at line 49 of file doc/generalized\_\-pixel.hh.

\hypertarget{a00169_a6929acdf91af7d1708162b9b5e277698}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!lvalue@{lvalue}}
\index{lvalue@{lvalue}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{lvalue}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Pixel\_\-Iterator}$<$ E $>$::{\bf lvalue}}}
\label{de/d53/a00169_a6929acdf91af7d1708162b9b5e277698}


Type returned by the read-\/write dereference operator. 



Definition at line 41 of file doc/pixel\_\-iterator.hh.

\hypertarget{a00164_af49bda288f86606405f85140963437da}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!rvalue@{rvalue}}
\index{rvalue@{rvalue}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{rvalue}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Generalized\_\-Pixel}$<$ E $>$::{\bf rvalue}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{db/ddf/a00164_af49bda288f86606405f85140963437da}


Read-\/only value associated type. 



Definition at line 55 of file doc/generalized\_\-pixel.hh.

\hypertarget{a00164_a67bfe34cad9a2eecef90678b7510e6a2}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!value@{value}}
\index{value@{value}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{value}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Generalized\_\-Pixel}$<$ E $>$::{\bf value}\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{db/ddf/a00164_a67bfe34cad9a2eecef90678b7510e6a2}


\hyperlink{a00418}{Value} associated type. 



Definition at line 52 of file doc/generalized\_\-pixel.hh.



\subsection{Member Function Documentation}
\hypertarget{a00164_a87e1cc4cc5af64ad4e82c534e2dd76f9}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!ima@{ima}}
\index{ima@{ima}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{ima}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ {\bf image}\& {\bf mln::doc::Generalized\_\-Pixel}$<$ E $>$::ima (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{db/ddf/a00164_a87e1cc4cc5af64ad4e82c534e2dd76f9}


Give the image of this generalized pixel. 

The constness of a pixel object is not transmitted to the underlying image. \hypertarget{a00166_adef6af1f96b175248bccfc3224bc1dca}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!invalidate@{invalidate}}
\index{invalidate@{invalidate}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{invalidate}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ void {\bf mln::doc::Iterator}$<$ E $>$::invalidate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d9/d38/a00166_adef6af1f96b175248bccfc3224bc1dca}


Invalidate the iterator. 

\hypertarget{a00166_aed075f24d56b458a704a4988e44e1452}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Iterator}$<$ E $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d9/d38/a00166_aed075f24d56b458a704a4988e44e1452}


Returns true if the iterator is valid, that is, designates an element. 

\hypertarget{a00166_a694ae2e37aa59381af9dc5eb9ce9bbe8}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!start@{start}}
\index{start@{start}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{start}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ void {\bf mln::doc::Iterator}$<$ E $>$::start (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inherited\mbox{]}}}}
\label{d9/d38/a00166_a694ae2e37aa59381af9dc5eb9ce9bbe8}


Start an iteration. 

Make the iterator designate the first element if it exists. If this first element does not exist, the iterator is not valid. \hypertarget{a00169_a19b6a81fa25a1a53c57bf967609813da}{
\index{mln::doc::Pixel\_\-Iterator@{mln::doc::Pixel\_\-Iterator}!val@{val}}
\index{val@{val}!mln::doc::Pixel_Iterator@{mln::doc::Pixel\_\-Iterator}}
\subsubsection[{val}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ {\bf lvalue} {\bf mln::doc::Pixel\_\-Iterator}$<$ E $>$::val (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{de/d53/a00169_a19b6a81fa25a1a53c57bf967609813da}


Give the pixel value. 

\begin{DoxyReturn}{Returns}
The current pixel value; this value cannot be modified. 
\end{DoxyReturn}


Reimplemented from \hyperlink{a00164_aaf712c5c4469665619b0f2bc1cffed82}{mln::doc::Generalized\_\-Pixel$<$ E $>$}.

