<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">\section{A\-I\-D\-A\-:\-:I\-Profile2\-D Class Reference}
\label{classAIDA_1_1IProfile2D}\index{A\-I\-D\-A\-::\-I\-Profile2\-D@{A\-I\-D\-A\-::\-I\-Profile2\-D}}


User level interface to a 2-\/dimensional profile histogram.  




{\ttfamily \#include $&lt;$I\-Profile2\-D.\-h$&gt;$}

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

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual bool {\bf fill} (double x, double y, double z, double weight=1)=0\label{classAIDA_1_1IProfile2D_acb5042deee03e8173e01e5a1294d5b7f}

\begin{DoxyCompactList}\small\item\em Fill the \doxyref{I\-Profile2\-D}{p.}{classAIDA_1_1IProfile2D}. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Mean\-X} (int index\-X, int index\-Y) const =0
\begin{DoxyCompactList}\small\item\em The weighted mean along x of a given bin. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Mean\-Y} (int index\-X, int index\-Y) const =0
\begin{DoxyCompactList}\small\item\em The weighted mean along y of a given bin. \end{DoxyCompactList}\item 
virtual int {\bf bin\-Entries} (int index\-X, int index\-Y) const =0
\begin{DoxyCompactList}\small\item\em The number of entries (ie the number of times fill was called for this bin). \end{DoxyCompactList}\item 
virtual int {\bf bin\-Entries\-X} (int index\-X) const =0\label{classAIDA_1_1IProfile2D_a868dc1a6e84322c45195765a6aa08142}

\begin{DoxyCompactList}\small\item\em Equivalent to {\ttfamily projection\-X().bin\-Entries(index\-X)}. \end{DoxyCompactList}\item 
virtual int {\bf bin\-Entries\-Y} (int index\-Y) const =0\label{classAIDA_1_1IProfile2D_aec2fa1b5fdc5d67c814529b863cfb4e3}

\begin{DoxyCompactList}\small\item\em Equivalent to {\ttfamily projection\-Y().bin\-Entries(index\-Y)}. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Height} (int index\-X, int index\-Y) 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\-Height\-X} (int index\-X) const =0\label{classAIDA_1_1IProfile2D_a5fd31bd76baa422f7f4ffba91c805764}

\begin{DoxyCompactList}\small\item\em Equivalent to {\ttfamily projection\-X().bin\-Height(index\-X)}. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Height\-Y} (int index\-Y) const =0\label{classAIDA_1_1IProfile2D_aaaf629d30596ed0138749aa979c10571}

\begin{DoxyCompactList}\small\item\em Equivalent to {\ttfamily projection\-Y().bin\-Height(index\-Y)}. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Error} (int index\-X, int index\-Y) const =0
\begin{DoxyCompactList}\small\item\em The error on this bin. \end{DoxyCompactList}\item 
virtual double {\bf bin\-Rms} (int index\-X, int index\-Y) const =0
\begin{DoxyCompactList}\small\item\em The spread (R\-M\-S) of this bin. \end{DoxyCompactList}\item 
virtual double {\bf mean\-X} () const =0\label{classAIDA_1_1IProfile2D_aa45b64d33752a912f3962a413103da00}

\begin{DoxyCompactList}\small\item\em Returns the mean of the profile, as calculated on filling-\/time projected on the X axis. \end{DoxyCompactList}\item 
virtual double {\bf mean\-Y} () const =0\label{classAIDA_1_1IProfile2D_a638f797c3a29ca06beba24dbe76702fe}

\begin{DoxyCompactList}\small\item\em Returns the mean of the profile, as calculated on filling-\/time projected on the Y axis. \end{DoxyCompactList}\item 
virtual double {\bf rms\-X} () const =0\label{classAIDA_1_1IProfile2D_a257db57bae20184be69cf2901f929b28}

\begin{DoxyCompactList}\small\item\em Returns the rms of the profile as calculated on filling-\/time projected on the X axis. \end{DoxyCompactList}\item 
virtual double {\bf rms\-Y} () const =0\label{classAIDA_1_1IProfile2D_aa24b1438b8629eb586811a5b0552df9b}

\begin{DoxyCompactList}\small\item\em Returns the rms of the profile as calculated on filling-\/time projected on the Y axis. \end{DoxyCompactList}\item 
virtual const {\bf I\-Axis} \&amp; {\bf x\-Axis} () const =0\label{classAIDA_1_1IProfile2D_a148f2f73ce8633b2637f12a73eaeb5f3}

\begin{DoxyCompactList}\small\item\em Return the X axis. \end{DoxyCompactList}\item 
virtual const {\bf I\-Axis} \&amp; {\bf y\-Axis} () const =0\label{classAIDA_1_1IProfile2D_a8d72ce3c9ae696b8d5f271f17512aa20}

\begin{DoxyCompactList}\small\item\em Return the Y axis. \end{DoxyCompactList}\item 
virtual int {\bf coord\-To\-Index\-X} (double coord\-X) const =0
\begin{DoxyCompactList}\small\item\em Convenience method, equivalent to {\ttfamily \doxyref{x\-Axis()}{p.}{classAIDA_1_1IProfile2D_a148f2f73ce8633b2637f12a73eaeb5f3}.coord\-To\-Index(coord)}. \end{DoxyCompactList}\item 
virtual int {\bf coord\-To\-Index\-Y} (double coord\-Y) const =0
\begin{DoxyCompactList}\small\item\em Convenience method, equivalent to {\ttfamily \doxyref{y\-Axis()}{p.}{classAIDA_1_1IProfile2D_a8d72ce3c9ae696b8d5f271f17512aa20}.coord\-To\-Index(coord)}. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
User level interface to a 2-\/dimensional profile 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\-Profile2\-D@{A\-I\-D\-A\-::\-I\-Profile2\-D}!bin\-Entries@{bin\-Entries}}
\index{bin\-Entries@{bin\-Entries}!AIDA::IProfile2D@{A\-I\-D\-A\-::\-I\-Profile2\-D}}
\subsubsection[{bin\-Entries}]{\setlength{\rightskip}{0pt plus 5cm}virtual int A\-I\-D\-A\-::\-I\-Profile2\-D\-::bin\-Entries (
\begin{DoxyParamCaption}
\item[{int}]{index\-X, }
\item[{int}]{index\-Y}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IProfile2D_adeacd79e652fcdf9096d374fb92e8c92}


The number of entries (ie the number of times fill was called for this bin). 


\begin{DoxyParams}{Parameters}
{\em index\-X} &amp; the x bin number (0...Nx-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
{\em index\-Y} &amp; the y bin number (0...Ny-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}


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

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


The error on this bin. 


\begin{DoxyParams}{Parameters}
{\em index\-X} &amp; the x bin number (0...Nx-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
{\em index\-Y} &amp; the y bin number (0...Ny-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}


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

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


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


\begin{DoxyParams}{Parameters}
{\em index\-X} &amp; the x bin number (0...Nx-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
{\em index\-Y} &amp; the y bin number (0...Ny-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}


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

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


The weighted mean along x of a given bin. 


\begin{DoxyParams}{Parameters}
{\em index\-X} &amp; The x 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
{\em index\-Y} &amp; The y 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 along the x axis. 
\end{DoxyReturn}


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

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


The weighted mean along y of a given bin. 


\begin{DoxyParams}{Parameters}
{\em index\-X} &amp; The x 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
{\em index\-Y} &amp; The y 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 along the x axis. 
\end{DoxyReturn}


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

\index{A\-I\-D\-A\-::\-I\-Profile2\-D@{A\-I\-D\-A\-::\-I\-Profile2\-D}!bin\-Rms@{bin\-Rms}}
\index{bin\-Rms@{bin\-Rms}!AIDA::IProfile2D@{A\-I\-D\-A\-::\-I\-Profile2\-D}}
\subsubsection[{bin\-Rms}]{\setlength{\rightskip}{0pt plus 5cm}virtual double A\-I\-D\-A\-::\-I\-Profile2\-D\-::bin\-Rms (
\begin{DoxyParamCaption}
\item[{int}]{index\-X, }
\item[{int}]{index\-Y}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classAIDA_1_1IProfile2D_a38af9294bd3d207a212c7bb2bc9a916c}


The spread (R\-M\-S) of this bin. 


\begin{DoxyParams}{Parameters}
{\em index\-X} &amp; the x bin number (0...Nx-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
{\em index\-Y} &amp; the y bin number (0...Ny-\/1) or O\-V\-E\-R\-F\-L\-O\-W or U\-N\-D\-E\-R\-F\-L\-O\-W. \\
\hline
\end{DoxyParams}


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

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


Convenience method, equivalent to {\ttfamily \doxyref{x\-Axis()}{p.}{classAIDA_1_1IProfile2D_a148f2f73ce8633b2637f12a73eaeb5f3}.coord\-To\-Index(coord)}. 

\begin{DoxySeeAlso}{See Also}
I\-Axis\-::coord\-To\-Index(double) 
\end{DoxySeeAlso}


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

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


Convenience method, equivalent to {\ttfamily \doxyref{y\-Axis()}{p.}{classAIDA_1_1IProfile2D_a8d72ce3c9ae696b8d5f271f17512aa20}.coord\-To\-Index(coord)}. 

\begin{DoxySeeAlso}{See Also}
I\-Axis\-::coord\-To\-Index(double) 
\end{DoxySeeAlso}


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



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
I\-Profile2\-D.\-h\end{DoxyCompactItemize}
</pre></body></html>