\section{A\-I\-D\-A\-:\-:I\-Cloud2\-D\-R\-O\-O\-T Class Reference}
\label{classAIDA_1_1ICloud2DROOT}\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}


User level interface to a 2\-D Cloud.  




{\ttfamily \#include $<$I\-Cloud2\-D\-R\-O\-O\-T.\-h$>$}

Inheritance diagram for A\-I\-D\-A\-:\-:I\-Cloud2\-D\-R\-O\-O\-T\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=4.000000cm]{classAIDA_1_1ICloud2DROOT}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual {\bf $\sim$\-I\-Cloud2\-D\-R\-O\-O\-T} ()\label{classAIDA_1_1ICloud2DROOT_aeb966d202b663767440d62da625dbbd7}

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
{\bf I\-Cloud2\-D\-R\-O\-O\-T} (const std\-::string \&path, const std\-::string \&{\bf title}, int n\-Max, {\bf I\-Tree} $\ast$used\-Tree, const std\-::string \&options=\char`\"{}\char`\"{})\label{classAIDA_1_1ICloud2DROOT_a256cf03a1a6425e47601438b99a967a2}

\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
{\bfseries I\-Cloud2\-D\-R\-O\-O\-T} (const std\-::string \&path, {\bf I\-Tree} $\ast$used\-Tree, const {\bf I\-Cloud2\-D\-R\-O\-O\-T} \&cloud)\label{classAIDA_1_1ICloud2DROOT_a8ade017ee702ca25982d4c898cc7d9da}

\item 
virtual bool {\bf fill} (double x, double y, double {\bf weight}=1.)
\begin{DoxyCompactList}\small\item\em Fill the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} with a couple of values and a corresponding weight. \end{DoxyCompactList}\item 
virtual double {\bf lower\-Edge\-X} () const 
\begin{DoxyCompactList}\small\item\em Get the lower edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. \end{DoxyCompactList}\item 
virtual double {\bf lower\-Edge\-Y} () const 
\begin{DoxyCompactList}\small\item\em Get the lower edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. \end{DoxyCompactList}\item 
virtual double {\bf upper\-Edge\-X} () const 
\begin{DoxyCompactList}\small\item\em Get the upper edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. \end{DoxyCompactList}\item 
virtual double {\bf upper\-Edge\-Y} () const 
\begin{DoxyCompactList}\small\item\em Get the upper edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. \end{DoxyCompactList}\item 
virtual double {\bf value\-X} (int index) const 
\begin{DoxyCompactList}\small\item\em Get the x value corresponding to a given entry. \end{DoxyCompactList}\item 
virtual double {\bf value\-Y} (int index) const 
\begin{DoxyCompactList}\small\item\em Get the y value corresponding to a given entry. \end{DoxyCompactList}\item 
virtual double {\bf weight} (int index) const 
\begin{DoxyCompactList}\small\item\em Get the weight corresponding to a given entry. \end{DoxyCompactList}\item 
virtual double {\bf mean\-X} () const 
\begin{DoxyCompactList}\small\item\em Get the mean of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. \end{DoxyCompactList}\item 
virtual double {\bf mean\-Y} () const 
\begin{DoxyCompactList}\small\item\em Get the mean of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. \end{DoxyCompactList}\item 
virtual double {\bf rms\-X} () const 
\begin{DoxyCompactList}\small\item\em Get the R\-M\-S of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. \end{DoxyCompactList}\item 
virtual double {\bf rms\-Y} () const 
\begin{DoxyCompactList}\small\item\em Get the R\-M\-S of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. \end{DoxyCompactList}\item 
virtual bool {\bf convert} (int n\-Bins\-X, double {\bf lower\-Edge\-X}, double {\bf upper\-Edge\-X}, int n\-Bins\-Y, double {\bf lower\-Edge\-Y}, double {\bf upper\-Edge\-Y})
\begin{DoxyCompactList}\small\item\em Convert internally the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} to an \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D} with given number of bins, upper edge and lower edge. \end{DoxyCompactList}\item 
virtual bool {\bfseries my\-Convert} (int n\-Bins\-X, double {\bf lower\-Edge\-X}, double {\bf upper\-Edge\-X}, int n\-Bins\-Y, double {\bf lower\-Edge\-Y}, double {\bf upper\-Edge\-Y}) const \label{classAIDA_1_1ICloud2DROOT_a5a6654fe98679f8e1df5c9c4217c4f2b}

\item 
virtual const {\bf I\-Histogram2\-D} \& {\bf histogram} () const 
\begin{DoxyCompactList}\small\item\em Convert internally the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} to an \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D} with given bin edges. \end{DoxyCompactList}\item 
virtual bool {\bf fill\-Histogram} ({\bf I\-Histogram2\-D} \&hist) const 
\begin{DoxyCompactList}\small\item\em Project the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} on an \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D}. \end{DoxyCompactList}\item 
virtual double {\bf sum\-Of\-Weights} () const 
\begin{DoxyCompactList}\small\item\em Get the sum of weights of all the entries. \end{DoxyCompactList}\item 
virtual bool {\bf convert\-To\-Histogram} ()
\begin{DoxyCompactList}\small\item\em Convert the \doxyref{I\-Cloud}{p.}{classAIDA_1_1ICloud} to an \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram} using the default number of bins. \end{DoxyCompactList}\item 
virtual bool {\bfseries my\-Convert\-To\-Histogram} () const \label{classAIDA_1_1ICloud2DROOT_aeb850e048ee78b49b043d0caddd4e099}

\item 
virtual bool {\bf is\-Converted} () const 
\begin{DoxyCompactList}\small\item\em Check if the \doxyref{I\-Cloud}{p.}{classAIDA_1_1ICloud} has been converted to an \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}. \end{DoxyCompactList}\item 
virtual int {\bf max\-Entries} () const 
\begin{DoxyCompactList}\small\item\em Get the number of entries after which the cloud will be converted to an \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}. \end{DoxyCompactList}\item 
virtual bool {\bf scale} (double scale\-Factor)
\begin{DoxyCompactList}\small\item\em Scale the weights by a given factor. \end{DoxyCompactList}\item 
virtual std\-::string {\bf title} () const 
\begin{DoxyCompactList}\small\item\em Get the Histogram's title. \end{DoxyCompactList}\item 
virtual bool {\bf set\-Title} (const std\-::string \&{\bf title})
\begin{DoxyCompactList}\small\item\em Set the histogram title. \end{DoxyCompactList}\item 
virtual int {\bf dimension} () const 
\begin{DoxyCompactList}\small\item\em Get the \doxyref{I\-Annotation}{p.}{classAIDA_1_1IAnnotation} associated with the Histogram. \end{DoxyCompactList}\item 
virtual bool {\bf reset} ()
\begin{DoxyCompactList}\small\item\em Reset the Histogram; as if just created. \end{DoxyCompactList}\item 
virtual int {\bf entries} () const 
\begin{DoxyCompactList}\small\item\em Get the number of in-\/range entries in the Histogram. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
User level interface to a 2\-D Cloud. 

\begin{DoxyAuthor}{Author}
T. Kraemer, D\-E\-S\-Y 
\end{DoxyAuthor}
\begin{DoxyVersion}{Version}

\end{DoxyVersion}
\begin{DoxyParagraph}{Id\-:}
\doxyref{I\-Cloud2\-D\-R\-O\-O\-T.\-h}{p.}{ICloud2DROOT_8h_source},v 1.\-3 2006-\/12-\/04 17\-:24\-:06 tkraemer Exp 
\end{DoxyParagraph}


\subsection{Member Function Documentation}
\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!convert@{convert}}
\index{convert@{convert}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{convert}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::convert (
\begin{DoxyParamCaption}
\item[{int}]{n\-Bins\-X, }
\item[{double}]{lower\-Edge\-X, }
\item[{double}]{upper\-Edge\-X, }
\item[{int}]{n\-Bins\-Y, }
\item[{double}]{lower\-Edge\-Y, }
\item[{double}]{upper\-Edge\-Y}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a55cad6e06b2aecdf9f93e4a495de688f}


Convert internally the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} to an \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D} with given number of bins, upper edge and lower edge. 


\begin{DoxyParams}{Parameters}
{\em n\-Bins\-X} & The number of bins of the x axis. \\
\hline
{\em lower\-Edge\-X} & The lower edge of bins of the x axis. \\
\hline
{\em upper\-Edge\-X} & The upper edge of bins of the x axis. \\
\hline
{\em n\-Bins\-Y} & The number of bins of the y axis. \\
\hline
{\em lower\-Edge\-Y} & The lower edge of bins of the y axis. \\
\hline
{\em upper\-Edge\-Y} & The upper edge of bins of the y axis. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} has already been converted. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_af03fb53e4903eb3639a514cb550a0144}.



Referenced by fill().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!convert\-To\-Histogram@{convert\-To\-Histogram}}
\index{convert\-To\-Histogram@{convert\-To\-Histogram}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{convert\-To\-Histogram}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::convert\-To\-Histogram (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_aabb54728a3414c2b8c48ea1baae9e838}


Convert the \doxyref{I\-Cloud}{p.}{classAIDA_1_1ICloud} to an \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram} using the default number of bins. 

\begin{DoxyReturn}{Returns}
false If the \doxyref{I\-Cloud}{p.}{classAIDA_1_1ICloud} has already been converted. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud} \doxyref{}{p.}{classAIDA_1_1ICloud_abea83c973fa02aaacdc2bf8a716a78eb}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!dimension@{dimension}}
\index{dimension@{dimension}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{dimension}]{\setlength{\rightskip}{0pt plus 5cm}int I\-Cloud2\-D\-R\-O\-O\-T\-::dimension (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a50fe571cd9be0f54f9ece36cc5e9831f}


Get the \doxyref{I\-Annotation}{p.}{classAIDA_1_1IAnnotation} associated with the Histogram. 

\begin{DoxyReturn}{Returns}
The I\-Annotation.\-virtual \doxyref{I\-Annotation}{p.}{classAIDA_1_1IAnnotation} \& annotation() ; virtual const \doxyref{I\-Annotation}{p.}{classAIDA_1_1IAnnotation} \& annotation() const ; Get the Histogram's dimension. 

The Histogram's dimension. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Base\-Histogram} \doxyref{}{p.}{classAIDA_1_1IBaseHistogram_acd76b8615a73f24657c781dc49980cad}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!entries@{entries}}
\index{entries@{entries}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{entries}]{\setlength{\rightskip}{0pt plus 5cm}int I\-Cloud2\-D\-R\-O\-O\-T\-::entries (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_ab9bf3fb106a22ce4ca9bfcaa3eda8c26}


Get the number of in-\/range entries in the Histogram. 

\begin{DoxyReturn}{Returns}
The number of in-\/range entries. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Base\-Histogram} \doxyref{}{p.}{classAIDA_1_1IBaseHistogram_a38c98fefb864892358aa763c4c054652}.



References A\-I\-D\-A\-::\-I\-Base\-Histogram\-::entries().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!fill@{fill}}
\index{fill@{fill}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{fill}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::fill (
\begin{DoxyParamCaption}
\item[{double}]{x, }
\item[{double}]{y, }
\item[{double}]{weight = {\ttfamily 1.}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a0e57ac0b22b95bfb2df1f104d1d6d730}


Fill the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} with a couple of values and a corresponding weight. 


\begin{DoxyParams}{Parameters}
{\em x} & The x value. \\
\hline
{\em y} & The y value. \\
\hline
{\em weight} & The corresponding weight. By default it is 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} is full, if the weight's value is is not between 0 and 1. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a5ff5173e6ef6e4817c544ae2b4d83b2b}.



References convert(), A\-I\-D\-A\-::\-I\-Histogram2\-D\-::fill(), and weight().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!fill\-Histogram@{fill\-Histogram}}
\index{fill\-Histogram@{fill\-Histogram}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{fill\-Histogram}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::fill\-Histogram (
\begin{DoxyParamCaption}
\item[{{\bf I\-Histogram2\-D} \&}]{hist}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_ad4dd3005113b96893ad7ff9c77830de8}


Project the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} on an \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D}. 


\begin{DoxyParams}{Parameters}
{\em hist} & The \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D} to be filled. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} is already converted. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_ab65d3ec171fd5e2d5483eabd8c288a57}.



References A\-I\-D\-A\-::\-I\-Histogram2\-D\-::fill(), and weight().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!histogram@{histogram}}
\index{histogram@{histogram}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{histogram}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf I\-Histogram2\-D} \& I\-Cloud2\-D\-R\-O\-O\-T\-::histogram (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a6d3bd2edf43a79ed3fb9854ca4085656}


Convert internally the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} to an \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D} with given bin edges. 


\begin{DoxyParams}{Parameters}
{\em bin\-Edges\-X} & The bins edges of the x axis. \\
\hline
{\em bin\-Edges\-Y} & The bins edges of the y axis. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} has already been converted.\-virtual bool convert(const std\-::vector$<$double$>$  \& bin\-Edges\-X, const std\-::vector$<$double$>$  \& bin\-Edges\-Y) ; Get the internal \doxyref{I\-Histogram2\-D}{p.}{classAIDA_1_1IHistogram2D} in which the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} converted to. 

The histogram. or because of a \doxyref{convert()}{p.}{classAIDA_1_1ICloud2DROOT_a55cad6e06b2aecdf9f93e4a495de688f} method invocation. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a8a688c4e315e3adfa76e9f96606aa74e}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!is\-Converted@{is\-Converted}}
\index{is\-Converted@{is\-Converted}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{is\-Converted}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::is\-Converted (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_adf9793905aa36d0e5a66b92437a97ba4}


Check if the \doxyref{I\-Cloud}{p.}{classAIDA_1_1ICloud} has been converted to an \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}. 

\begin{DoxyReturn}{Returns}
{\ttfamily true} if it has been converted. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud} \doxyref{}{p.}{classAIDA_1_1ICloud_a5fa2456511325c284614af9b942fa98a}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!lower\-Edge\-X@{lower\-Edge\-X}}
\index{lower\-Edge\-X@{lower\-Edge\-X}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{lower\-Edge\-X}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::lower\-Edge\-X (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a930c02779a2549e41b671faaf711b169}


Get the lower edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. 

\begin{DoxyReturn}{Returns}
The lower edge along the x axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a817b55dda987c849968816751a485462}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!lower\-Edge\-Y@{lower\-Edge\-Y}}
\index{lower\-Edge\-Y@{lower\-Edge\-Y}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{lower\-Edge\-Y}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::lower\-Edge\-Y (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a871ebcad0901c7a32f72d4a8a0ae4394}


Get the lower edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. 

\begin{DoxyReturn}{Returns}
The lower edge along the y axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a0492cc7c762b075f98429db669341d51}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!max\-Entries@{max\-Entries}}
\index{max\-Entries@{max\-Entries}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{max\-Entries}]{\setlength{\rightskip}{0pt plus 5cm}int I\-Cloud2\-D\-R\-O\-O\-T\-::max\-Entries (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_acecf8cb33e6f371d335d1bc288d89437}


Get the number of entries after which the cloud will be converted to an \doxyref{I\-Histogram}{p.}{classAIDA_1_1IHistogram}. 

\begin{DoxyReturn}{Returns}
The number of entries. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud} \doxyref{}{p.}{classAIDA_1_1ICloud_addc03fdb17f9f256c0d951e301d6d1ef}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!mean\-X@{mean\-X}}
\index{mean\-X@{mean\-X}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{mean\-X}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::mean\-X (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_aeb015336742e4315537e73b3cb294a45}


Get the mean of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. 

\begin{DoxyReturn}{Returns}
The mean along the x axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a82d985a8a294fd0cddd40411311c519f}.



References A\-I\-D\-A\-::\-I\-Histogram2\-D\-::mean\-X().



Referenced by rms\-X().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!mean\-Y@{mean\-Y}}
\index{mean\-Y@{mean\-Y}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{mean\-Y}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::mean\-Y (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a6064e323d04c830072c51f8e5bee8c9b}


Get the mean of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. 

\begin{DoxyReturn}{Returns}
The mean along the y axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_aee452a47a5578d75edc8b17940290cbb}.



References A\-I\-D\-A\-::\-I\-Histogram2\-D\-::mean\-Y().



Referenced by rms\-Y().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!reset@{reset}}
\index{reset@{reset}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{reset}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::reset (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a5f44e9b28c3ab32a0fa5e75e27103a14}


Reset the Histogram; as if just created. 

\begin{DoxyReturn}{Returns}
false If something goes wrong. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Base\-Histogram} \doxyref{}{p.}{classAIDA_1_1IBaseHistogram_a32da98a46330b5b8cab4f55d00650472}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!rms\-X@{rms\-X}}
\index{rms\-X@{rms\-X}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{rms\-X}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::rms\-X (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a9145707ec4ccdf7fac1c3b3f49f6895a}


Get the R\-M\-S of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. 

\begin{DoxyReturn}{Returns}
The R\-M\-S along the x axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_af6154a709ad7de1362e8f3e429c39d17}.



References mean\-X(), and A\-I\-D\-A\-::\-I\-Histogram2\-D\-::rms\-X().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!rms\-Y@{rms\-Y}}
\index{rms\-Y@{rms\-Y}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{rms\-Y}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::rms\-Y (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a0466bc7fbe17482e8dc2e4b474038f4c}


Get the R\-M\-S of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. 

\begin{DoxyReturn}{Returns}
The R\-M\-S along the y axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_ad5c70679bfb9eccb6e3eda29fa0ee5ce}.



References mean\-Y(), and A\-I\-D\-A\-::\-I\-Histogram2\-D\-::rms\-Y().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!scale@{scale}}
\index{scale@{scale}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{scale}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::scale (
\begin{DoxyParamCaption}
\item[{double}]{scale\-Factor}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_af3d891f56c3b13d7872d8fc7ebf8f5b9}


Scale the weights by a given factor. 


\begin{DoxyParams}{Parameters}
{\em scale\-Factor} & The scale factor. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If a non-\/positive scale factor is provided. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud} \doxyref{}{p.}{classAIDA_1_1ICloud_a993062a521b38987b13a0936f8a2d170}.



References A\-I\-D\-A\-::\-I\-Tree\-::cd(), A\-I\-D\-A\-::\-I\-Tree\-::pwd(), A\-I\-D\-A\-::\-I\-Histogram\-::scale(), title(), and weight().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!set\-Title@{set\-Title}}
\index{set\-Title@{set\-Title}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{set\-Title}]{\setlength{\rightskip}{0pt plus 5cm}bool I\-Cloud2\-D\-R\-O\-O\-T\-::set\-Title (
\begin{DoxyParamCaption}
\item[{const std\-::string \&}]{title}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a24b0b0965db4192866f6b8be28896833}


Set the histogram title. 


\begin{DoxyParams}{Parameters}
{\em title} & The title. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If title cannot be changed. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Base\-Histogram} \doxyref{}{p.}{classAIDA_1_1IBaseHistogram_a14a7f6ed8fda63589540f787186ed2d7}.



References A\-I\-D\-A\-::\-I\-Base\-Histogram\-::set\-Title().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!sum\-Of\-Weights@{sum\-Of\-Weights}}
\index{sum\-Of\-Weights@{sum\-Of\-Weights}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{sum\-Of\-Weights}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::sum\-Of\-Weights (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a1aee89bb5e6c5151c6964b03b23e4e39}


Get the sum of weights of all the entries. 

\begin{DoxyReturn}{Returns}
The sum of the weights of all the entries. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud} \doxyref{}{p.}{classAIDA_1_1ICloud_a85488a9b962b3e872cbb29160b5d9114}.



References A\-I\-D\-A\-::\-I\-Histogram\-::sum\-All\-Bin\-Heights(), and weight().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!title@{title}}
\index{title@{title}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{title}]{\setlength{\rightskip}{0pt plus 5cm}std\-::string I\-Cloud2\-D\-R\-O\-O\-T\-::title (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a24d048212293e219f983bc9a3410c1a2}


Get the Histogram's title. 

\begin{DoxyReturn}{Returns}
The Histogram's title. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Base\-Histogram} \doxyref{}{p.}{classAIDA_1_1IBaseHistogram_a55bd4bf3c7f32400c24e5a1926ca31ae}.



References A\-I\-D\-A\-::\-I\-Base\-Histogram\-::title().



Referenced by scale().

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!upper\-Edge\-X@{upper\-Edge\-X}}
\index{upper\-Edge\-X@{upper\-Edge\-X}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{upper\-Edge\-X}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::upper\-Edge\-X (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a41d1380f6f332eb6d5ef3cd47eeff95e}


Get the upper edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the x axis. 

\begin{DoxyReturn}{Returns}
The upper edge along the x axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a09102083e9b0947a085e3b4ee033cdc3}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!upper\-Edge\-Y@{upper\-Edge\-Y}}
\index{upper\-Edge\-Y@{upper\-Edge\-Y}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{upper\-Edge\-Y}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::upper\-Edge\-Y (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_aa3d2a13abd72c9730008223cd8cedb89}


Get the upper edge of the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} along the y axis. 

\begin{DoxyReturn}{Returns}
The upper edge along the y axis. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a69fae43f3d061995419a25d2510d0002}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!value\-X@{value\-X}}
\index{value\-X@{value\-X}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{value\-X}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::value\-X (
\begin{DoxyParamCaption}
\item[{int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_aaeaf0ebc8143c923c57e924bafd5eaa3}


Get the x value corresponding to a given entry. 


\begin{DoxyParams}{Parameters}
{\em index} & The entry's index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The x value of the index-\/th entry. If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} has already been converted, 0 is returned. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_aecf553f5bcfeb39fa734524a1e275e14}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!value\-Y@{value\-Y}}
\index{value\-Y@{value\-Y}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{value\-Y}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::value\-Y (
\begin{DoxyParamCaption}
\item[{int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a0008b071758af4b392db47cc6a56bb36}


Get the y value corresponding to a given entry. 


\begin{DoxyParams}{Parameters}
{\em index} & The entry's index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The y value of the index-\/th entry. If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} has already been converted, 0 is returned. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_a633dc841fb5bfdbc69a97e6fbeafc52d}.

\index{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}!weight@{weight}}
\index{weight@{weight}!AIDA::ICloud2DROOT@{A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T}}
\subsubsection[{weight}]{\setlength{\rightskip}{0pt plus 5cm}double I\-Cloud2\-D\-R\-O\-O\-T\-::weight (
\begin{DoxyParamCaption}
\item[{int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [virtual]}}\label{classAIDA_1_1ICloud2DROOT_a4f77f8336a435a85240ce1fa4cd59e2f}


Get the weight corresponding to a given entry. 


\begin{DoxyParams}{Parameters}
{\em index} & The entry's index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The weight of the index-\/th entry. If the \doxyref{I\-Cloud2\-D}{p.}{classAIDA_1_1ICloud2D} has already been converted, 0 is returned. 
\end{DoxyReturn}


Implements {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D} \doxyref{}{p.}{classAIDA_1_1ICloud2D_ac6687666cff41c7326eae33e7e9abd2a}.



Referenced by fill(), fill\-Histogram(), scale(), and sum\-Of\-Weights().



The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
I\-Cloud2\-D\-R\-O\-O\-T.\-h\item 
I\-Cloud2\-D\-R\-O\-O\-T.\-cc\end{DoxyCompactItemize}
