\section{A\-I\-D\-A\-:\-:I\-Histogram1\-D Class Reference}
\label{classAIDA_1_1IHistogram1D}\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}


User level interface to 1\-D Histogram.  




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

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

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual bool {\bf fill} (double x, double weight=1.)=0
\begin{DoxyCompactList}\small\item\em Fill the \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D} with a value and the corresponding weight. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Mean} (int index) const =0
\begin{DoxyCompactList}\small\item\em The weighted mean of a bin. \end{DoxyCompactList}\item 
virtual int {\bf bin\-Entries} (int index) const =0
\begin{DoxyCompactList}\small\item\em Number of entries in the corresponding bin (ie the number of times fill was called for this bin). \end{DoxyCompactList}\item 
virtual double {\bf bin\-Height} (int index) const =0
\begin{DoxyCompactList}\small\item\em Total height of the corresponding bin (ie the sum of the weights in this bin). \end{DoxyCompactList}\item 
virtual double {\bf bin\-Error} (int index) const =0
\begin{DoxyCompactList}\small\item\em The error of a given bin. \end{DoxyCompactList}\item 
virtual double {\bf mean} () const =0
\begin{DoxyCompactList}\small\item\em The mean of the whole \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. \end{DoxyCompactList}\item 
virtual double {\bf rms} () const =0
\begin{DoxyCompactList}\small\item\em The R\-M\-S of the whole \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. \end{DoxyCompactList}\item 
virtual const {\bf I\-Axis} \& {\bf axis} () const =0
\begin{DoxyCompactList}\small\item\em Get the x axis of the \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. \end{DoxyCompactList}\item 
virtual int {\bf coord\-To\-Index} (double coord) const =0
\begin{DoxyCompactList}\small\item\em Get the bin number corresponding to a given coordinate along the x axis. \end{DoxyCompactList}\item 
virtual bool {\bf add} (const {\bf I\-Histogram1\-D} \&hist)=0
\begin{DoxyCompactList}\small\item\em Add to this \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D} the contents of another \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
User level interface to 1\-D 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\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!add@{add}}
\index{add@{add}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{add}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Histogram1\-D\-::add (
\begin{DoxyParamCaption}
\item[{const {\bf I\-Histogram1\-D} \&}]{hist}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_aae4abdb8aed7320948297ca55eac49cf}


Add to this \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D} the contents of another \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. 


\begin{DoxyParams}{Parameters}
{\em hist} & The \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D} to be added to this \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the I\-Histogram1\-Ds binnings are incompatible. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_ad5289eaa6e78a33a730eabee7a237837}.



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

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!axis@{axis}}
\index{axis@{axis}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{axis}]{\setlength{\rightskip}{0pt plus 5cm}virtual const {\bf I\-Axis}\& A\-I\-D\-A\-::\-I\-Histogram1\-D\-::axis (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_ade36e312e9bdcf3904125e28a1151453}


Get the x axis of the \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. 

\begin{DoxyReturn}{Returns}
The x coordinate \doxyref{I\-Axis}{p.}{classAIDA_1_1IAxis}. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_aca5d7a85bd34775bee958ac2be421b15}.



Referenced by A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T\-::add(), A\-I\-D\-A\-::\-I\-Histogram\-Factory\-R\-O\-O\-T\-::add(), A\-I\-D\-A\-::\-I\-Histogram\-Factory\-R\-O\-O\-T\-::create\-Copy(), A\-I\-D\-A\-::\-I\-Histogram\-Factory\-R\-O\-O\-T\-::divide(), A\-I\-D\-A\-::\-I\-Histogram\-Factory\-R\-O\-O\-T\-::multiply(), and A\-I\-D\-A\-::\-I\-Histogram\-Factory\-R\-O\-O\-T\-::subtract().

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


Number of entries in the corresponding bin (ie the number of times fill was called for this bin). 


\begin{DoxyParams}{Parameters}
{\em index} & The bin number (0...N-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The number of entries in the corresponding bin. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_af8928fa8b1292b47e75aa74d3b0fda32}.

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!bin\-Error@{bin\-Error}}
\index{bin\-Error@{bin\-Error}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{bin\-Error}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram1\-D\-::bin\-Error (
\begin{DoxyParamCaption}
\item[{int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_acdb5b5104c4eb9c4e10718fc097c01dd}


The error of a given bin. 


\begin{DoxyParams}{Parameters}
{\em index} & The bin number (0...N-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The error on the corresponding bin. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_ae660babbce617f8e1341afe1c4754dc1}.

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!bin\-Height@{bin\-Height}}
\index{bin\-Height@{bin\-Height}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{bin\-Height}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram1\-D\-::bin\-Height (
\begin{DoxyParamCaption}
\item[{int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_ab1e140ef0c83d77090e5bfb01d9093be}


Total height of the corresponding bin (ie the sum of the weights in this bin). 


\begin{DoxyParams}{Parameters}
{\em index} & The bin number (0...N-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The height of the corresponding bin. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_ad05bd268c6999ac9d036c95ae849548d}.

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!bin\-Mean@{bin\-Mean}}
\index{bin\-Mean@{bin\-Mean}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{bin\-Mean}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram1\-D\-::bin\-Mean (
\begin{DoxyParamCaption}
\item[{int}]{index}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_a0446792b81d34e8476d9ceb4f3c0c67a}


The weighted mean of a bin. 


\begin{DoxyParams}{Parameters}
{\em index} & The bin number (0...N-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The mean of the corresponding bin. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a568ee01a67741164aea03527e24857a3}.

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!coord\-To\-Index@{coord\-To\-Index}}
\index{coord\-To\-Index@{coord\-To\-Index}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{coord\-To\-Index}]{\setlength{\rightskip}{0pt plus 5cm}virtual int A\-I\-D\-A\-::\-I\-Histogram1\-D\-::coord\-To\-Index (
\begin{DoxyParamCaption}
\item[{double}]{coord}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_af0c61da726fda19c9f70b543fa6cf7dd}


Get the bin number corresponding to a given coordinate along the x axis. 

This is a convenience method, equivalent to {\ttfamily \doxyref{axis()}{p.}{classAIDA_1_1IHistogram1D_ade36e312e9bdcf3904125e28a1151453}.coord\-To\-Index(coord)}. \begin{DoxySeeAlso}{See Also}
I\-Axis\-::coord\-To\-Index(double) 
\end{DoxySeeAlso}

\begin{DoxyParams}{Parameters}
{\em coord} & The coordinalte along the x axis. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The corresponding bin number. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_ac34ee092e40bc56d4ad1e2cd4a082adc}.

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!fill@{fill}}
\index{fill@{fill}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{fill}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool A\-I\-D\-A\-::\-I\-Histogram1\-D\-::fill (
\begin{DoxyParamCaption}
\item[{double}]{x, }
\item[{double}]{weight = {\ttfamily 1.}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_a9d26248a793189804bd45b179aa953f9}


Fill the \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D} with a value and the corresponding weight. 


\begin{DoxyParams}{Parameters}
{\em x} & The value to be filled in. \\
\hline
{\em weight} & The corresponding weight (by default 1). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
false If the weight is $<$0 or $>$1 (?). 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a41813a78ef731d5cdbaa85e11ec3ef56}.



Referenced by A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::fill(), A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::fill\-Histogram(), and A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::my\-Convert().

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!mean@{mean}}
\index{mean@{mean}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{mean}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram1\-D\-::mean (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_ab94cb858de9e2a3b518bc5652caaf617}


The mean of the whole \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. 

\begin{DoxyReturn}{Returns}
The mean of the \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a236cce016c97643a7cd76230c219d786}.



Referenced by A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::mean().

\index{A\-I\-D\-A\-::\-I\-Histogram1\-D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}!rms@{rms}}
\index{rms@{rms}!AIDA::IHistogram1D@{A\-I\-D\-A\-::\-I\-Histogram1\-D}}
\subsubsection[{rms}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Histogram1\-D\-::rms (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IHistogram1D_a3f55e4596f53e2b5deb39fef03d9e28d}


The R\-M\-S of the whole \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. 

\begin{DoxyReturn}{Returns}
The R\-M\-S if the \doxyref{I\-Histogram1\-D}{p.}{classAIDA_1_1IHistogram1D}. 
\end{DoxyReturn}


Implemented in {\bf A\-I\-D\-A\-::\-I\-Histogram1\-D\-R\-O\-O\-T} \doxyref{}{p.}{classAIDA_1_1IHistogram1DROOT_a6a5826336b397081c9597b7542a3b1b2}.



Referenced by A\-I\-D\-A\-::\-I\-Cloud1\-D\-R\-O\-O\-T\-::rms().



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