\section{E\-V\-E\-N\-T\-:\-:Cluster Class Reference}
\label{classEVENT_1_1Cluster}\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}


The \doxyref{L\-C\-I\-O}{p.}{classEVENT_1_1LCIO} cluster.  




{\ttfamily \#include $<$pre-\/generated/\-E\-V\-E\-N\-T/\-Cluster.\-h$>$}

Inheritance diagram for E\-V\-E\-N\-T\-:\-:Cluster\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5.000000cm]{classEVENT_1_1Cluster}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef {\bf Cluster} {\bf lcobject\-\_\-type}\label{classEVENT_1_1Cluster_a26f1ceef12cfb268c02914981eea08e7}

\begin{DoxyCompactList}\small\item\em Useful typedef for template programming with \doxyref{L\-C\-I\-O}{p.}{classEVENT_1_1LCIO}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual {\bf $\sim$\-Cluster} ()\label{classEVENT_1_1Cluster_a3b698c6c1752cced6125af4e12255989}

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual int {\bf get\-Type} () const =0
\begin{DoxyCompactList}\small\item\em Flagword that defines the type of cluster. \end{DoxyCompactList}\item 
virtual float {\bf get\-Energy} () const =0\label{classEVENT_1_1Cluster_ad84e7dcb75ec3f8f7ee154b81e3b0c93}

\begin{DoxyCompactList}\small\item\em Energy of the cluster. \end{DoxyCompactList}\item 
virtual float {\bf get\-Energy\-Error} () const =0\label{classEVENT_1_1Cluster_ad801f408bff0110ac48dab04e867e740}

\begin{DoxyCompactList}\small\item\em Returns the error on the energy of the cluster. \end{DoxyCompactList}\item 
virtual const float $\ast$ {\bf get\-Position} () const =0\label{classEVENT_1_1Cluster_a19aa3098cc6bbff418c3cec3b22c418a}

\begin{DoxyCompactList}\small\item\em Position of the cluster. \end{DoxyCompactList}\item 
virtual const {\bf Float\-Vec} \& {\bf get\-Position\-Error} () const =0\label{classEVENT_1_1Cluster_ae6e11a5973b082f15f914e7f9d8d1f9b}

\begin{DoxyCompactList}\small\item\em Covariance matrix of the position (6 Parameters) \end{DoxyCompactList}\item 
virtual float {\bf get\-I\-Phi} () const =0
\begin{DoxyCompactList}\small\item\em Intrinsic direction of cluster at position\-: Phi. \end{DoxyCompactList}\item 
virtual float {\bf get\-I\-Theta} () const =0
\begin{DoxyCompactList}\small\item\em Intrinsic direction of cluster at position\-: Theta. \end{DoxyCompactList}\item 
virtual const {\bf Float\-Vec} \& {\bf get\-Direction\-Error} () const =0
\begin{DoxyCompactList}\small\item\em Covariance matrix of the direction (3 Parameters). \end{DoxyCompactList}\item 
virtual const {\bf Float\-Vec} \& {\bf get\-Shape} () const =0\label{classEVENT_1_1Cluster_ab82edfaf78e992855f626ef6e99cc66b}

\begin{DoxyCompactList}\small\item\em Shape parameters -\/ check/set collection parameter Cluster\-Shape\-Parameters for size and names of parameters. \end{DoxyCompactList}\item 
virtual const {\bf Particle\-I\-D\-Vec} \& {\bf get\-Particle\-I\-Ds} () const =0
\begin{DoxyCompactList}\small\item\em The particle Id's sorted by their likelihood. \end{DoxyCompactList}\item 
virtual const {\bf Cluster\-Vec} \& {\bf get\-Clusters} () const =0\label{classEVENT_1_1Cluster_a1cff94bc07ca9de61a5ed81a4dc3635f}

\begin{DoxyCompactList}\small\item\em The clusters that have been combined to this cluster. \end{DoxyCompactList}\item 
virtual const {\bf Calorimeter\-Hit\-Vec} \& {\bf get\-Calorimeter\-Hits} () const =0
\begin{DoxyCompactList}\small\item\em The hits that have been combined to this cluster. \end{DoxyCompactList}\item 
virtual const {\bf Float\-Vec} \& {\bf get\-Hit\-Contributions} () const =0\label{classEVENT_1_1Cluster_a066fafdb80c88d8c545e672069335760}

\begin{DoxyCompactList}\small\item\em Returns the energy contribution of the hits Runs parallel to the Calorimeter\-Hit\-Vec from \doxyref{get\-Calorimeter\-Hits()}{p.}{classEVENT_1_1Cluster_ae10d6355906a3ce2e5920c19a0520ff6} \end{DoxyCompactList}\item 
virtual const {\bf Float\-Vec} \& {\bf get\-Subdetector\-Energies} () const =0
\begin{DoxyCompactList}\small\item\em A vector that holds the energy observed in a particular subdetectors. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
The \doxyref{L\-C\-I\-O}{p.}{classEVENT_1_1LCIO} cluster. 

\begin{DoxyAuthor}{Author}
gaede 
\end{DoxyAuthor}
\begin{DoxyVersion}{Version}

\end{DoxyVersion}
\begin{DoxyParagraph}{Id\-:}
Cluster.\-aid,v 1.\-14 2006-\/08-\/03 16\-:53\-:34 gaede Exp 
\end{DoxyParagraph}


\subsection{Member Function Documentation}
\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-Calorimeter\-Hits@{get\-Calorimeter\-Hits}}
\index{get\-Calorimeter\-Hits@{get\-Calorimeter\-Hits}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-Calorimeter\-Hits}]{\setlength{\rightskip}{0pt plus 5cm}virtual const {\bf Calorimeter\-Hit\-Vec}\& E\-V\-E\-N\-T\-::\-Cluster\-::get\-Calorimeter\-Hits (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_ae10d6355906a3ce2e5920c19a0520ff6}


The hits that have been combined to this cluster. 

Only available if collection flag bit L\-C\-I\-O\-::\-C\-L\-B\-I\-T\-\_\-\-H\-I\-T\-S==1 and if the \doxyref{Calorimeter\-Hit}{p.}{classEVENT_1_1CalorimeterHit} objects have not been saved with L\-C\-I\-O\-::\-R\-C\-H\-B\-I\-T\-\_\-\-N\-O\-\_\-\-P\-T\-R==1. \begin{DoxySeeAlso}{See Also}
\doxyref{Calorimeter\-Hit}{p.}{classEVENT_1_1CalorimeterHit} 
\end{DoxySeeAlso}


Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_ab948080e526057c615910e4949bfd7c2}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-Direction\-Error@{get\-Direction\-Error}}
\index{get\-Direction\-Error@{get\-Direction\-Error}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-Direction\-Error}]{\setlength{\rightskip}{0pt plus 5cm}virtual const {\bf Float\-Vec}\& E\-V\-E\-N\-T\-::\-Cluster\-::get\-Direction\-Error (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_ab1aa4346729bdbc00a61df1b8ca2b3ef}


Covariance matrix of the direction (3 Parameters). 

Stored as lower triangle matrix where the order of parameters is\-: i\-Phi, i\-Theta. So we have cov(i\-Phi,i\-Phi), cov( i\-Phi, i\-Theta), cov( i\-Theta, i\-Theta). 

Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_aa43fa60a15036a7a67b3ac8c1fc6f419}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-I\-Phi@{get\-I\-Phi}}
\index{get\-I\-Phi@{get\-I\-Phi}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-I\-Phi}]{\setlength{\rightskip}{0pt plus 5cm}virtual float E\-V\-E\-N\-T\-::\-Cluster\-::get\-I\-Phi (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_a04f38a0f6295210cd1ea7d1cd09a9d51}


Intrinsic direction of cluster at position\-: Phi. 

Not to be confused with direction cluster is seen from I\-P. 

Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_a092da3b8e01bf0c815987a5fbbcc2012}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-I\-Theta@{get\-I\-Theta}}
\index{get\-I\-Theta@{get\-I\-Theta}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-I\-Theta}]{\setlength{\rightskip}{0pt plus 5cm}virtual float E\-V\-E\-N\-T\-::\-Cluster\-::get\-I\-Theta (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_a94e44f0bee499b327a19987a93a5e3c5}


Intrinsic direction of cluster at position\-: Theta. 

Not to be confused with direction cluster is seen from I\-P. 

Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_a438243526023d942245d5195215a588b}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-Particle\-I\-Ds@{get\-Particle\-I\-Ds}}
\index{get\-Particle\-I\-Ds@{get\-Particle\-I\-Ds}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-Particle\-I\-Ds}]{\setlength{\rightskip}{0pt plus 5cm}virtual const {\bf Particle\-I\-D\-Vec}\& E\-V\-E\-N\-T\-::\-Cluster\-::get\-Particle\-I\-Ds (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_a1cd0195c77ee14d6cecd1b786d93c3d1}


The particle Id's sorted by their likelihood. 

\begin{DoxySeeAlso}{See Also}
\doxyref{Particle\-I\-D}{p.}{classEVENT_1_1ParticleID} 
\end{DoxySeeAlso}


Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_a09d908fa61c70b89129317f86ab397eb}.



Referenced by U\-T\-I\-L\-::\-L\-C\-T\-O\-O\-L\-S\-::print\-Clusters(), and S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-Subdetector\-Energies@{get\-Subdetector\-Energies}}
\index{get\-Subdetector\-Energies@{get\-Subdetector\-Energies}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-Subdetector\-Energies}]{\setlength{\rightskip}{0pt plus 5cm}virtual const {\bf Float\-Vec}\& E\-V\-E\-N\-T\-::\-Cluster\-::get\-Subdetector\-Energies (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_ab364d5a12275e6e9d15863ddb647ef13}


A vector that holds the energy observed in a particular subdetectors. 

The mapping of indices to subdetectors is implementation dependent. To be used as convenient information or if hits are not stored in the data set, e.\-g. D\-S\-T or Fast\-M\-C. Check/set collection parameter Cluster\-Subdetector\-Names for decoding the indices of the array. 

Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_a18582dfe5f467ad930f09b8d6cfb2ddd}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Cluster@{E\-V\-E\-N\-T\-::\-Cluster}!get\-Type@{get\-Type}}
\index{get\-Type@{get\-Type}!EVENT::Cluster@{E\-V\-E\-N\-T\-::\-Cluster}}
\subsubsection[{get\-Type}]{\setlength{\rightskip}{0pt plus 5cm}virtual int E\-V\-E\-N\-T\-::\-Cluster\-::get\-Type (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1Cluster_a862f193ac7e2908be7cf2d9fb32240dd}


Flagword that defines the type of cluster. 

Bits 0-\/15 can be used to denote the subdetectors that have contributed hits to the cluster. For the definition of the bits check/\-Set the collection variables Cluster\-Type\-Bit\-Names and Cluster\-Type\-Bit\-Indices. Bits 16-\/31 are used internally. 

Implemented in {\bf I\-M\-P\-L\-::\-Cluster\-Impl} \doxyref{}{p.}{classIMPL_1_1ClusterImpl_aaa0fd2675b75271fb1e0334f332c9249}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Cluster\-Handler\-::write().



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