\section{A\-I\-D\-A\-:\-:I\-Cloud Class Reference}
\label{classAIDA_1_1ICloud}\index{A\-I\-D\-A\-::\-I\-Cloud@{A\-I\-D\-A\-::\-I\-Cloud}}


User level interface to a Cloud.  




{\ttfamily \#include $<$I\-Cloud.\-h$>$}

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

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual double {\bf sum\-Of\-Weights} () const =0
\begin{DoxyCompactList}\small\item\em Get the sum of weights of all the entries. \end{DoxyCompactList}\item 
virtual bool {\bf convert\-To\-Histogram} ()=0
\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 {\bf is\-Converted} () const =0
\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 =0
\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)=0
\begin{DoxyCompactList}\small\item\em Scale the weights by a given factor. \end{DoxyCompactList}\end{DoxyCompactItemize}


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

A Cloud is an unbinned collection of points. It can be used to represent scatter plots or dynamically rebinnable histograms. If they number of entries in the cloud exceeds some threshold they may be automatically converted to a binned histogram.

\begin{DoxyAuthor}{Author}
The \doxyref{A\-I\-D\-A}{p.}{namespaceAIDA} team ({\tt http\-://aida.\-freehep.\-org/}) 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\index{A\-I\-D\-A\-::\-I\-Cloud@{A\-I\-D\-A\-::\-I\-Cloud}!convert\-To\-Histogram@{convert\-To\-Histogram}}
\index{convert\-To\-Histogram@{convert\-To\-Histogram}!AIDA::ICloud@{A\-I\-D\-A\-::\-I\-Cloud}}
\subsubsection[{convert\-To\-Histogram}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Cloud\-::convert\-To\-Histogram (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1ICloud_abea83c973fa02aaacdc2bf8a716a78eb}


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}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud3DROOT_a36a32be325ef8b445c6706cd3eb1dd72}, {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud2DROOT_aabb54728a3414c2b8c48ea1baae9e838}, and {\bf A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud1DROOT_aad82320a4e11f9c7969ad920653fd4e2}.

\index{A\-I\-D\-A\-::\-I\-Cloud@{A\-I\-D\-A\-::\-I\-Cloud}!is\-Converted@{is\-Converted}}
\index{is\-Converted@{is\-Converted}!AIDA::ICloud@{A\-I\-D\-A\-::\-I\-Cloud}}
\subsubsection[{is\-Converted}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Cloud\-::is\-Converted (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1ICloud_a5fa2456511325c284614af9b942fa98a}


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}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud3DROOT_a654938ca494781e5cd72afa78185f977}, {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud2DROOT_adf9793905aa36d0e5a66b92437a97ba4}, and {\bf A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud1DROOT_a98a849ff69348beb8257000fbf08e64a}.

\index{A\-I\-D\-A\-::\-I\-Cloud@{A\-I\-D\-A\-::\-I\-Cloud}!max\-Entries@{max\-Entries}}
\index{max\-Entries@{max\-Entries}!AIDA::ICloud@{A\-I\-D\-A\-::\-I\-Cloud}}
\subsubsection[{max\-Entries}]{\setlength{\rightskip}{0pt plus 5cm}virtual int A\-I\-D\-A\-::\-I\-Cloud\-::max\-Entries (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1ICloud_addc03fdb17f9f256c0d951e301d6d1ef}


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}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud3DROOT_a3f5a9b00888625adb730846baf117b83}, {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud2DROOT_acecf8cb33e6f371d335d1bc288d89437}, and {\bf A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud1DROOT_a59ad7465a5ecc7d2006624483d3a9451}.



Referenced by A\-I\-D\-A\-::\-I\-Histogram\-Factory\-R\-O\-O\-T\-::create\-Copy().

\index{A\-I\-D\-A\-::\-I\-Cloud@{A\-I\-D\-A\-::\-I\-Cloud}!scale@{scale}}
\index{scale@{scale}!AIDA::ICloud@{A\-I\-D\-A\-::\-I\-Cloud}}
\subsubsection[{scale}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Cloud\-::scale (
\begin{DoxyParamCaption}
\item[{double}]{scale\-Factor}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1ICloud_a993062a521b38987b13a0936f8a2d170}


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}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud3DROOT_aee65945bfbac22dfe304ff4d52d1c11e}, {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud2DROOT_af3d891f56c3b13d7872d8fc7ebf8f5b9}, and {\bf A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud1DROOT_a4c23af1551be821042788b26023fad5a}.

\index{A\-I\-D\-A\-::\-I\-Cloud@{A\-I\-D\-A\-::\-I\-Cloud}!sum\-Of\-Weights@{sum\-Of\-Weights}}
\index{sum\-Of\-Weights@{sum\-Of\-Weights}!AIDA::ICloud@{A\-I\-D\-A\-::\-I\-Cloud}}
\subsubsection[{sum\-Of\-Weights}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Cloud\-::sum\-Of\-Weights (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1ICloud_a85488a9b962b3e872cbb29160b5d9114}


Get the sum of weights of all the entries. 

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


Implemented in {\bf A\-I\-D\-A\-::\-I\-Cloud3\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud3DROOT_a5fd0c59b9425be42d1ee2939ca99260b}, {\bf A\-I\-D\-A\-::\-I\-Cloud2\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud2DROOT_a1aee89bb5e6c5151c6964b03b23e4e39}, and {\bf A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1ICloud1DROOT_ac238244587338292a7224bdbe392ffa9}.



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
I\-Cloud.\-h\end{DoxyCompactItemize}
