passing max E to global var

[u/mrichter/AliRoot.git] / EMCAL / doc / geometry.tex

\section{EMCAL geometry software - Marco +++}


This page is intended for a description of the EMCAL geometry and the methods to access it.  
{\it This is a very preliminary version that needs work.}

 \subsection {Classes description}

The EMCAL geometry is implemented in several classes : {\color{red} (right now very brief description, it should be completed) }
\begin{itemize}
\item AliEMCALGeoUtils: Steering geometry class.  No dependencies on STEER or EMCAL non geometry classes. Can be called during the analysis without loading all aliroot classes.
\item AliEMCALGeometry: Derives from AliEMCALGeoUtils, contains dependencies on other EMCAL classes (AliEMCALRecPoint).
\item AliEMCALEMCGeometry: Does the geometry initialization. Does all the definitions of the geometry (towers composition, size, Super Modules number ...)
\item AliEMCALGeoParams:  Class container of some of the geometry parameters so that it can be accessed everywhere in the EMCAL code, to avoid "magic numbers". Its use has to be propagated to all the code.
\item AliEMCALShishKebabTrd1Module: Here the modules are defined and the position of the modules in the local super module reference system is calculated
\end{itemize}

\subsection{Accessing the geometry}
One can get the geometry pointer in the following ways:
\begin{itemize}
\item If galice.root is available:

\begin{DDbox}{\linewidth}
\begin{lstlisting}
AliRunLoader *rl = AliRunLoader::Open("galice.root",AliConfig::GetDefaultEventFolderName(),"read"); 
rl->LoadgAlice();//Needed to get geometry
AliEMCALLoader *emcalLoader = dynamic\_cast<AliEMCALLoader*>(rl->GetDetectorLoader("EMCAL"));
AliRun * alirun = rl->GetAliRun();
AliEMCAL * emcal = (AliEMCAL*)alirun->GetDetector("EMCAL"); AliEMCALGeometry * geom = emcal->GetGeometry();
else, if galice.root is not available:
AliEMCALGeometry * geom =  AliEMCALGeometry::GetInstance("EMCAL\_COMPLETE") ;

\end{lstlisting}
\end{DDbox}
\end{itemize}
In this case you might need the file geometry.root if you want to access to certain methods that require local to global position transformations. This file can be generated doing a simple simulation, it just contains the transformation matrix to go from global to local.

The way to load this file is:
%\begin{DDbox}{\linewidth}
\begin{lstlisting}
TGeoManager::Import("geometry.root");
\end{lstlisting}
%\end{DDbox}

The transformation matrices are also stored in the ESDs so if you do not load this file, you can have to load these matrices from the ESDs.

 If you want to see different parameters used in the geometry printed (cells centers, distance to IP, etc), one just has to execute the method PrintGeometry().
 

\subsection{Geometry configuration options}
Right now the following geometry options are implemented:
\begin{itemize}
\item EMCAL\_COMPLETE: 12 Super Modules (2 half Super Modules)
\item EMCAL\_FIRSTYEAR: 4 Super Modules (year 2010)
\item EMCAL\_FIRSTYEARV1: 4 Super Modules, corrected geometry (year 2010)
\item EMCAL\_COMPLETEV1: 10 Super Modules, corrected geometry (year 2011)
\item EMCAL\_COMPLETE12SMV1: 12 Super Modules (10+2/3), corrected geometry (year 2012)
\end{itemize}

Other options exists but need to be removed as they {\bf should not be used}:
\begin{itemize}
\item EMCAL\_PDC06: Old geometry, for reading old data (which do not exist anymore).
\item EMCAL\_WSU: Prototype geometry. 
\end{itemize}

By default, the geometry is loaded with the EMCAL\_COMPLETE12SMV1 configuration.

 
 \subsection{Mapping}
The tower row/column mapping online and offline follows the alice numbering convention. Figures~\ref{fig:Map1} to \ref{fig:Map2} display the position of the super modules from different points of view and the position of the tower index in them.

\begin{figure}[ht]
\begin{center}
\includegraphics[width=1.0\textwidth]{figures/EMCALMap0_0.pdf}
\end{center}
\caption{\label{fig:Map1}Position of the super modules}
\end{figure}

\begin{figure}[ht]
\begin{center}
\includegraphics[width=1.0\textwidth]{figures/EMCALMap1.pdf}
\end{center}
\caption{\label{fig:Map0}EMCal seen from the magnet side with 4 SMs.}
\end{figure}


\begin{figure}[ht]
\begin{center}
\includegraphics[width=1.0\textwidth]{figures/EMCALMap2.pdf}
\end{center}
\caption{\label{fig:Map2}EMCal geometrical numbering.}
\end{figure}


\subsection{Tower index transformation methods}
\subsubsection{Absolute tower ID to Row/Column index}

Each EMCAL supermodule is composed of 24x48 towers (phi,eta), grouped in 4x4 modules. Each tower (even each module) has a unique number assigned, called in the code "absolute ID" number (absId). This number can be transformed into a row (phi direction) or column (eta direction) index. The procedure to go from the absId to the (row, col) formulation or viceversa is as follow:

\begin{itemize}
\item From absId to col-row: 

\begin{DDbox}{\linewidth}
\begin{lstlisting}
Int\_t nSupMod, nModule, nIphi, nIeta, iphi, ieta;
//Check if this absId exists
if(!CheckAbsCellId(absId)) return kFALSE;
// Get from the absId the super module number, the module number and the eta-phi index (0 or 1) in the module
GetCellIndex(absId, nSupMod, nModule, nIphi, nIeta);
// Get from the  the super module number, the module number and the eta-phi index (0 or 1) in the module the tower row (iphi) and column (ieta) 
GetCellPhiEtaIndexInSModule(nSupMod,nModule,nIphi,nIeta, iphi, ieta); 
\end{lstlisting}
\end{DDbox}

\item From col-row to absId, following the same notation as above: 

\begin{DDbox}{\linewidth}
\begin{lstlisting}

absid = GetAbsCellIdFromCellIndexes(nSupMode, iphi, ieta);
\end{lstlisting}
\end{DDbox}

or

\begin{DDbox}{\linewidth}
\begin{lstlisting}

absid = GetAbsCellId(nSupMod, nModule, nIphi, nIeta);
\end{lstlisting}
\end{DDbox}

\item Other interesting method is

\begin{DDbox}{\linewidth}
\begin{lstlisting}

Int\_t   GetSuperModuleNumber(Int\_t absId)  
\end{lstlisting}
\end{DDbox}
\end{itemize}

\subsection{Tower index to local / global reference system position}
\subsubsection{Local coordinates}

To correlate the tower index and its position in local coordinates, the following methods are available:

\begin{DDbox}{\linewidth}
\begin{lstlisting}
  Bool\_t  AliEMCALGeoUtils::RelPosCellInSModule(Int\_t absId, Double\_t \&xr, Double\_t \&yr, Double\_t \&zr) const;

  Bool\_t  AliEMCALGeoUtils::RelPosCellInSModule(Int\_t absId, Double\_t loc[3]) const;

  Bool\_t  AliEMCALGeoUtils::RelPosCellInSModule(Int\_t absId, TVector3 \&vloc) const;
\end{lstlisting}
\end{DDbox}

To which the input is the absId and the output are the coordinates of the center of towers in the local coordinates of the Super Module. This method gets the column and row index of the cell from the absId, independently of the Super Module (like above), and gets the center of the cell from 3 arrays (x,y,z) filled with such quantities. Such central positions are calculated during the initialization of the geometry, where the arrys are filled, in the method :

\begin{DDbox}{\linewidth}
\begin{lstlisting}

  AliEMCALGeoUtils::CreateListOfTrd1Modules()
\end{lstlisting}
\end{DDbox}

{\color{red}<<<<<Someone else should explain how it works>>>>>}

 

In case we calculate the cluster position, things are a bit different.

 

{\color{red}<<<<< This explanation should go to the clusterization section>>>>}

 

This is done in 

\begin{DDbox}{\linewidth}
\begin{lstlisting}
void AliEMCALRecPoint::EvalLocalPosition()
\end{lstlisting}
\end{DDbox}

First we calculate the cell position with the  method 

\begin{DDbox}{\linewidth}
\begin{lstlisting}
AliEMCALGeometry::RelPosCellInSModule(Int\_t absId, Int\_t maxAbsId, Double\_t tmax, Double\_t \&xr, Double\_t \&yr, Double\_t \&zr)
\end{lstlisting}
\end{DDbox}

The calculation of the cell position done here is different in the "x-z" but the same in "y". 

 

{\color{red}<<<<< <<<<<Someone else should explain how it works>>>>>}

 
 

In this particular case the position calculation per tower depends on the position of the maximum cell, and the sum of the energy of the cells of the cluster. The maximum depth (tmax) is calculated with the method

\begin{DDbox}{\linewidth}
\begin{lstlisting}
  Double\_t AliEMCALRecPoint::TmaxInCm(const Double\_t e){

      //e: energy sum of cells

static Double\_t ca = 4.82;// shower max parameter - first guess; ca=TMath::Log(1000./8.07)

      static Double\_t x0 = 1.23; // radiation lenght (cm)

      static Double\_t tmax = 0.; // position of electromagnetic shower max in cm

      tmax = TMath::Log(e) + ca+0.5;

      tmax *= x0; // convert to cm

  }
\end{lstlisting}
\end{DDbox}

After the cells position of the cluster is accessed, the position of the cluster is calculated averaging the cell positions with a logarithmic weight:

\begin{DDbox}{\linewidth}
\begin{lstlisting}
  w(cell i) = TMath::Max( 0., logWeight + TMath::Log( energy[cell i] / summed\_cluster\_cell\_energy ));
\end{lstlisting}
\end{DDbox}

where the logWeight was chosen to be 4.5 (this value was taken from PHOS, never optimized as far as I know)

So in the end the position,  is 

\begin{DDbox}{\linewidth}
\begin{lstlisting}
f = Sum(f(i) * w(i))/Sum(w(i))
\end{lstlisting}
\end{DDbox}

where f=x,y,z.

 

 \subsubsection{Global coordinates}
 

To transform from local to global we have the methods

\begin{DDbox}{\linewidth}
\begin{lstlisting}

  void GetGlobal(const Double\_t *loc, Double\_t *glob, int ind) const;

  void GetGlobal(const TVector3 \&vloc, TVector3 \&vglob, int ind) const;

  void GetGlobal(Int\_t absId, Double\_t glob[3]) const;

  void GetGlobal(Int\_t absId, TVector3 \&vglob) const;
\end{lstlisting}
\end{DDbox}

 

 These methods take the local coordinates and transform them into global coordinates using the transformation matrix of the Super Module.

\begin{DDbox}{\linewidth}
\begin{lstlisting}
 

TGeoHMatrix* m = GetMatrixForSuperModule(nSupMod);

if(m) m->LocalToMaster(loc, glob);

\end{lstlisting}
\end{DDbox}
 

 GetGlobal is called in the following useful methods in the geometry class:

 
\begin{itemize}
\item Return the eta and phi angular position of the cell from the AbsId

\begin{DDbox}{\linewidth}
\begin{lstlisting}
void    EtaPhiFromIndex(Int\_t absId, Double\_t \&eta, Double\_t \&phi) const;
void    EtaPhiFromIndex(Int\_t absId, Float\_t \&eta, Float\_t \&phi) const;
\end{lstlisting}
\end{DDbox}
\item Print information of the cells. For "pri>0" returns more information. "tit" has not much use, this value is printed.

\begin{DDbox}{\linewidth}
\begin{lstlisting}
void PrintCellIndexes(Int\_t absId, int pri, const char *tit)
\end{lstlisting}
\end{DDbox}
\end{itemize} 

\subsection{Geometry Alignment}
AliRoot contains a frame for the correction of the misplacement of geometry objects with respect to the ideal positions which are kept in the STEER/ directory of the following classes:

\begin{DDbox}{\linewidth}
\begin{lstlisting}
AliAlignObj  
AliAlignObjMatrix  
AliAlignObjParams  
AliAlignmentTracks
\end{lstlisting}
\end{DDbox}

The class AliEMCALSurvey creates the corrections to the alignable objects.  The class AliEMCALSurvey was established to take the survey parameters from OCDB, calculate the shift in position of the center of the end faces of the supermodules from the nominal position, and convert this to a transformation matrix for each supermodule which is applied to correct the global position of the supermodules.  All calculations of global positions would then use these corrected supermodule positions to determine their locations within the ALICE global coordinate system.