\hypertarget{a00165}{
\section{mln::doc::Image$<$ E $>$ Struct Template Reference}
\label{d0/d48/a00165}\index{mln::doc::Image@{mln::doc::Image}}
}


Documentation class for \hyperlink{a00044}{mln::Image}.  




{\ttfamily \#include $<$image.hh$>$}



Inheritance diagram for mln::doc::Image$<$ E $>$:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=242pt]{d4/d6e/a03784}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef void \hyperlink{a00165_a5d6de13b4783dc3fcc044fa1a4c6225d}{bkd\_\-piter}
\begin{DoxyCompactList}\small\item\em Backward point iterator associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_aa903407b69035b9bdca6bc5225545b93}{coord}
\begin{DoxyCompactList}\small\item\em Coordinate associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a090f7a77442a87e3b6e4eb1567165e76}{dpoint}
\begin{DoxyCompactList}\small\item\em Dpsite associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a5d04c9635ed2440c171a95f7f804577c}{fwd\_\-piter}
\begin{DoxyCompactList}\small\item\em Forward point iterator associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a4ba8c628830ebb8c0f501e657793fa4c}{lvalue}
\begin{DoxyCompactList}\small\item\em Type returned by the read-\/write pixel value operator. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a7a9e6fcd72ee74010f5323676c76ad4a}{point}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00343}{Site} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_acbbf347a0bc57ff5f15f90226e912151}{pset}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00329}{Point} set associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a2930b4b0a6ecec39274af9d776106020}{psite}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00170}{Point\_\-Site} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_af0cbb7b4ede5159b65a2d03d9ac87ea5}{rvalue}
\begin{DoxyCompactList}\small\item\em Type returned by the read pixel value operator. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a925e06c3b153e7fe1d04cce4f8cf696e}{skeleton}
\begin{DoxyCompactList}\small\item\em Associate type that describes how this type of image is constructed. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_a47b8ca9ce646a9f9ed90537a902b6286}{value}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00418}{Value} associated type. \item\end{DoxyCompactList}\item 
typedef void \hyperlink{a00165_adb1f70b01bddf2be13d6d4a8cb850098}{vset}
\begin{DoxyCompactList}\small\item\em \hyperlink{a00418}{Value} set associated type. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
const \hyperlink{a00135}{box}$<$ \hyperlink{a00165_a7a9e6fcd72ee74010f5323676c76ad4a}{point} $>$ \& \hyperlink{a00165_a1e0c852f4e378bcf9b64a8c93fa7be1e}{bbox} () const 
\begin{DoxyCompactList}\small\item\em Give a bounding box of the image domain. \item\end{DoxyCompactList}\item 
const \hyperlink{a00165_acbbf347a0bc57ff5f15f90226e912151}{pset} \& \hyperlink{a00165_a4466a6b9ddb65960a8eabfade3ccd77b}{domain} () const 
\begin{DoxyCompactList}\small\item\em Give the definition domain of the image. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00165_ab2809972517fede97c393d1e606a5cf6}{has} (const \hyperlink{a00165_a2930b4b0a6ecec39274af9d776106020}{psite} \&p) const 
\begin{DoxyCompactList}\small\item\em Test if the image owns the point site {\ttfamily p}. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00165_ab2809972517fede97c393d1e606a5cf6}{has} (const \hyperlink{a00165_a2930b4b0a6ecec39274af9d776106020}{psite} \&p) const 
\begin{DoxyCompactList}\small\item\em Test if {\ttfamily p} belongs to the image domain. \item\end{DoxyCompactList}\item 
bool \hyperlink{a00165_ad0ea1f19ea14afe1b8f02ebf7e9b0b2b}{is\_\-valid} () const 
\begin{DoxyCompactList}\small\item\em Test if the image have been initialized. \item\end{DoxyCompactList}\item 
unsigned \hyperlink{a00165_a9d376fae0561367261214de264e8738d}{nsites} () const 
\begin{DoxyCompactList}\small\item\em Give the number of points of the image domain. \item\end{DoxyCompactList}\item 
\hyperlink{a00165_af0cbb7b4ede5159b65a2d03d9ac87ea5}{rvalue} \hyperlink{a00165_a210c8bfc60c2ffd85418bb4a75fd9a4c}{operator()} (const \hyperlink{a00165_a2930b4b0a6ecec39274af9d776106020}{psite} \&p) const 
\begin{DoxyCompactList}\small\item\em Read-\/only access to the image value located at {\ttfamily p}. \item\end{DoxyCompactList}\item 
\hyperlink{a00165_a4ba8c628830ebb8c0f501e657793fa4c}{lvalue} \hyperlink{a00165_ac786ef602abee5d96726586f628cb1b4}{operator()} (const \hyperlink{a00165_a2930b4b0a6ecec39274af9d776106020}{psite} \&p)
\begin{DoxyCompactList}\small\item\em Read-\/write access to the image value located at {\ttfamily p}. \item\end{DoxyCompactList}\item 
const \hyperlink{a00165_adb1f70b01bddf2be13d6d4a8cb850098}{vset} \& \hyperlink{a00165_a7540628861765fd18222e46ab5df74de}{values} () const 
\begin{DoxyCompactList}\small\item\em Give the set of values of the image. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename E$>$ struct mln::doc::Image$<$ E $>$}

Documentation class for \hyperlink{a00044}{mln::Image}. \begin{DoxySeeAlso}{See also}
\hyperlink{a00044}{mln::Image} 
\end{DoxySeeAlso}


Definition at line 36 of file core/concept/doc/image.hh.



\subsection{Member Typedef Documentation}
\hypertarget{a00165_a5d6de13b4783dc3fcc044fa1a4c6225d}{
\index{mln::doc::Image@{mln::doc::Image}!bkd\_\-piter@{bkd\_\-piter}}
\index{bkd\_\-piter@{bkd\_\-piter}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{bkd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf bkd\_\-piter}}}
\label{d0/d48/a00165_a5d6de13b4783dc3fcc044fa1a4c6225d}


Backward point iterator associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00345}{mln::Site\_\-Iterator}. 
\end{DoxyInvariant}


Definition at line 147 of file core/concept/doc/image.hh.

\hypertarget{a00165_aa903407b69035b9bdca6bc5225545b93}{
\index{mln::doc::Image@{mln::doc::Image}!coord@{coord}}
\index{coord@{coord}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{coord}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf coord}}}
\label{d0/d48/a00165_aa903407b69035b9bdca6bc5225545b93}


Coordinate associated type. 



Definition at line 131 of file core/concept/doc/image.hh.

\hypertarget{a00165_a090f7a77442a87e3b6e4eb1567165e76}{
\index{mln::doc::Image@{mln::doc::Image}!dpoint@{dpoint}}
\index{dpoint@{dpoint}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{dpoint}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf dpoint}}}
\label{d0/d48/a00165_a090f7a77442a87e3b6e4eb1567165e76}


Dpsite associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00177}{mln::Dpoint}. 
\end{DoxyInvariant}


Definition at line 136 of file core/concept/doc/image.hh.

\hypertarget{a00165_a5d04c9635ed2440c171a95f7f804577c}{
\index{mln::doc::Image@{mln::doc::Image}!fwd\_\-piter@{fwd\_\-piter}}
\index{fwd\_\-piter@{fwd\_\-piter}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{fwd\_\-piter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf fwd\_\-piter}}}
\label{d0/d48/a00165_a5d04c9635ed2440c171a95f7f804577c}


Forward point iterator associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00345}{mln::Site\_\-Iterator}. 
\end{DoxyInvariant}


Definition at line 142 of file core/concept/doc/image.hh.

\hypertarget{a00165_a4ba8c628830ebb8c0f501e657793fa4c}{
\index{mln::doc::Image@{mln::doc::Image}!lvalue@{lvalue}}
\index{lvalue@{lvalue}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{lvalue}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf lvalue}}}
\label{d0/d48/a00165_a4ba8c628830ebb8c0f501e657793fa4c}


Type returned by the read-\/write pixel value operator. 



Definition at line 52 of file core/concept/doc/image.hh.

\hypertarget{a00165_a7a9e6fcd72ee74010f5323676c76ad4a}{
\index{mln::doc::Image@{mln::doc::Image}!point@{point}}
\index{point@{point}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{point}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf point}}}
\label{d0/d48/a00165_a7a9e6fcd72ee74010f5323676c76ad4a}


\hyperlink{a00343}{Site} associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00329}{mln::Point}. 
\end{DoxyInvariant}


Definition at line 121 of file core/concept/doc/image.hh.

\hypertarget{a00165_acbbf347a0bc57ff5f15f90226e912151}{
\index{mln::doc::Image@{mln::doc::Image}!pset@{pset}}
\index{pset@{pset}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{pset}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf pset}}}
\label{d0/d48/a00165_acbbf347a0bc57ff5f15f90226e912151}


\hyperlink{a00329}{Point} set associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00348}{mln::Site\_\-Set}. 
\end{DoxyInvariant}


Definition at line 116 of file core/concept/doc/image.hh.

\hypertarget{a00165_a2930b4b0a6ecec39274af9d776106020}{
\index{mln::doc::Image@{mln::doc::Image}!psite@{psite}}
\index{psite@{psite}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{psite}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf psite}}}
\label{d0/d48/a00165_a2930b4b0a6ecec39274af9d776106020}


\hyperlink{a00170}{Point\_\-Site} associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00331}{mln::Point\_\-Site}. 
\end{DoxyInvariant}


Definition at line 126 of file core/concept/doc/image.hh.

\hypertarget{a00165_af0cbb7b4ede5159b65a2d03d9ac87ea5}{
\index{mln::doc::Image@{mln::doc::Image}!rvalue@{rvalue}}
\index{rvalue@{rvalue}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{rvalue}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf rvalue}}}
\label{d0/d48/a00165_af0cbb7b4ede5159b65a2d03d9ac87ea5}


Type returned by the read pixel value operator. 



Definition at line 48 of file core/concept/doc/image.hh.

\hypertarget{a00165_a925e06c3b153e7fe1d04cce4f8cf696e}{
\index{mln::doc::Image@{mln::doc::Image}!skeleton@{skeleton}}
\index{skeleton@{skeleton}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{skeleton}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf skeleton}}}
\label{d0/d48/a00165_a925e06c3b153e7fe1d04cce4f8cf696e}


Associate type that describes how this type of image is constructed. 



Definition at line 64 of file core/concept/doc/image.hh.

\hypertarget{a00165_a47b8ca9ce646a9f9ed90537a902b6286}{
\index{mln::doc::Image@{mln::doc::Image}!value@{value}}
\index{value@{value}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{value}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf value}}}
\label{d0/d48/a00165_a47b8ca9ce646a9f9ed90537a902b6286}


\hyperlink{a00418}{Value} associated type. 

\begin{DoxyInvariant}{Invariant}
This type is neither qualified by const, nor by reference. 
\end{DoxyInvariant}


Definition at line 44 of file core/concept/doc/image.hh.

\hypertarget{a00165_adb1f70b01bddf2be13d6d4a8cb850098}{
\index{mln::doc::Image@{mln::doc::Image}!vset@{vset}}
\index{vset@{vset}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{vset}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ typedef void {\bf mln::doc::Image}$<$ E $>$::{\bf vset}}}
\label{d0/d48/a00165_adb1f70b01bddf2be13d6d4a8cb850098}


\hyperlink{a00418}{Value} set associated type. 

\begin{DoxyInvariant}{Invariant}
This type has to derive from \hyperlink{a00438}{mln::Value\_\-Set}. 
\end{DoxyInvariant}


Definition at line 57 of file core/concept/doc/image.hh.



\subsection{Member Function Documentation}
\hypertarget{a00165_a1e0c852f4e378bcf9b64a8c93fa7be1e}{
\index{mln::doc::Image@{mln::doc::Image}!bbox@{bbox}}
\index{bbox@{bbox}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{bbox}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf box}$<${\bf point}$>$\& {\bf mln::doc::Image}$<$ E $>$::bbox (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_a1e0c852f4e378bcf9b64a8c93fa7be1e}


Give a bounding box of the image domain. 

This bounding box may be larger than the smallest bounding box (the optimal one). Practically an image type is not obliged to update its bounding box so that it is always optimal.

\begin{DoxyReturn}{Returns}
A bounding box of the image domain. 
\end{DoxyReturn}
\hypertarget{a00165_a4466a6b9ddb65960a8eabfade3ccd77b}{
\index{mln::doc::Image@{mln::doc::Image}!domain@{domain}}
\index{domain@{domain}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{domain}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf pset}\& {\bf mln::doc::Image}$<$ E $>$::domain (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_a4466a6b9ddb65960a8eabfade3ccd77b}


Give the definition domain of the image. 

\begin{DoxyReturn}{Returns}
A reference to the domain point set. 
\end{DoxyReturn}
\hypertarget{a00165_ab2809972517fede97c393d1e606a5cf6}{
\index{mln::doc::Image@{mln::doc::Image}!has@{has}}
\index{has@{has}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{has}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Image}$<$ E $>$::has (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_ab2809972517fede97c393d1e606a5cf6}


Test if the image owns the point site {\ttfamily p}. 

\begin{DoxyReturn}{Returns}
True if accessing the image value at {\ttfamily p} is possible, that is, does not abort the execution. 
\end{DoxyReturn}
\hypertarget{a00165_ab2809972517fede97c393d1e606a5cf6}{
\index{mln::doc::Image@{mln::doc::Image}!has@{has}}
\index{has@{has}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{has}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Image}$<$ E $>$::has (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_ab2809972517fede97c393d1e606a5cf6}


Test if {\ttfamily p} belongs to the image domain. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em p}]A point site.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
True if {\ttfamily p} belongs to the image domain.
\end{DoxyReturn}
\begin{DoxyInvariant}{Invariant}
has(p) is true =$>$ has(p) is also true. 
\end{DoxyInvariant}
\hypertarget{a00165_ad0ea1f19ea14afe1b8f02ebf7e9b0b2b}{
\index{mln::doc::Image@{mln::doc::Image}!is\_\-valid@{is\_\-valid}}
\index{is\_\-valid@{is\_\-valid}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{is\_\-valid}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ bool {\bf mln::doc::Image}$<$ E $>$::is\_\-valid (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_ad0ea1f19ea14afe1b8f02ebf7e9b0b2b}


Test if the image have been initialized. 

\hypertarget{a00165_a9d376fae0561367261214de264e8738d}{
\index{mln::doc::Image@{mln::doc::Image}!nsites@{nsites}}
\index{nsites@{nsites}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{nsites}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ unsigned {\bf mln::doc::Image}$<$ E $>$::nsites (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_a9d376fae0561367261214de264e8738d}


Give the number of points of the image domain. 

\hypertarget{a00165_a210c8bfc60c2ffd85418bb4a75fd9a4c}{
\index{mln::doc::Image@{mln::doc::Image}!operator()@{operator()}}
\index{operator()@{operator()}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ {\bf rvalue} {\bf mln::doc::Image}$<$ E $>$::operator() (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_a210c8bfc60c2ffd85418bb4a75fd9a4c}


Read-\/only access to the image value located at {\ttfamily p}. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em p}]A point site.\end{DoxyParams}
\begin{DoxyPrecond}{Precondition}
The image has to own the site {\ttfamily p}.
\end{DoxyPrecond}
\begin{DoxyReturn}{Returns}
The value at {\ttfamily p} (not assignable). 
\end{DoxyReturn}
\hypertarget{a00165_ac786ef602abee5d96726586f628cb1b4}{
\index{mln::doc::Image@{mln::doc::Image}!operator()@{operator()}}
\index{operator()@{operator()}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ {\bf lvalue} {\bf mln::doc::Image}$<$ E $>$::operator() (
\begin{DoxyParamCaption}
\item[{const {\bf psite} \&}]{ p}
\end{DoxyParamCaption}
)}}
\label{d0/d48/a00165_ac786ef602abee5d96726586f628cb1b4}


Read-\/write access to the image value located at {\ttfamily p}. 


\begin{DoxyParams}{Parameters}
\item[\mbox{\tt[in]} {\em p}]A point site.\end{DoxyParams}
\begin{DoxyPrecond}{Precondition}
The image has to own the site {\ttfamily p}.
\end{DoxyPrecond}
\begin{DoxyReturn}{Returns}
The value at {\ttfamily p} (assignable). 
\end{DoxyReturn}
\hypertarget{a00165_a7540628861765fd18222e46ab5df74de}{
\index{mln::doc::Image@{mln::doc::Image}!values@{values}}
\index{values@{values}!mln::doc::Image@{mln::doc::Image}}
\subsubsection[{values}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename E $>$ const {\bf vset}\& {\bf mln::doc::Image}$<$ E $>$::values (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{d0/d48/a00165_a7540628861765fd18222e46ab5df74de}


Give the set of values of the image. 

\begin{DoxyReturn}{Returns}
A reference to the value set. 
\end{DoxyReturn}
