reviewing typos, re-writting parts -- Cath
[u/mrichter/AliRoot.git] / EMCAL / doc / analysis.tex
index 39a868a1fae2ff4dddb0c9085ff3bf3d43aa0029..70f39b61f97059a537e7b09ce6c7803dfb435a71 100644 (file)
@@ -1,25 +1,16 @@
 \section{Analysis format and code}
 
-All the reconstructed particles of all the detectors will be kept
+All the reconstructed particles of all the detectors are kept
 in a file called \textbf{AliESDs.root}. The detectors must store there
 the most relevant information which will be used in the analysis. 
-Together with the AliESDs.root file, another
-file is created with some reference tags of the simulated events,
-containing for example the number of events per run. This file is
+Together with the AliESDs.root file, another file is created with some reference tags of the simulated events, containing for example the number of events per run. This file is
 named \textbf{Run0.Event0\_1.ESD.tag.root} (1 means that only 1 event
 was simulated). 
 
-In order to do the analysis with the data contained in the ESDs, you
-only need the file \textbf{AliESDs.root} in your local directories or a grid collection. It is
-not necessary that in your working directory you keep other files
-like galice.root or EMCAL.{*}.root or any other. Anyway, we may want
-to access to the primary particles generated during the simulation,
-in that case we must have also the \textbf{galice.root} and \textbf{Kinematics.root}
-file.  Also, if you want to access to some information of the detector geometry, you need
-to keep the \textbf{geometry.root} file. 
+In order to do the analysis with the data contained in the ESDs, the only file needed is \textbf{AliESDs.root} in the local directories or a grid collection. No other files are needed in the working directory (such as galice.root nor EMCAL.{*}.root) unless one needs to access the primary particles generated during the simulation. In that case, the files \textbf{galice.root} and \textbf{Kinematics.root} are needed locally.  Also, if one want to access to some information of the detector geometry, the \textbf{geometry.root} file is needed.
 
-There are other data analysis container file created from the ESD, the
-AOD (Analysis Object Data) with smaller quantity of data for most of the subsystems but for the calorimeters, where we copy all the information\footnote{until half 2012 everything but the time of the cells was not stored}.
+There are other data analysis containers created from the ESD, the
+AOD (Analysis Object Data) with smaller quantity of data for most of the subsystems but for the calorimeters, where we copy all the information\footnote{until half 2012 everything but the time of the cells was stored}.
 
 
 \subsection{Calorimeter information in ESDs/AODs}
@@ -29,7 +20,7 @@ The basic calorimeter information needed for analysis is stored in the ESDs or A
 
 \subsubsection{AliVEvent (AliESDEvent, AliAODEvent)}
 
-Those are manager classes for the event information retrieval. Regarding the calorimeters they have the following access information (getter) methods (there are the equivalent setters just have a look to the header file of the class):
+Those are manager classes for the event information retrieval. Regarding the calorimeters they have the following access information (getters) methods\footnote{There are the equivalent setters just have a look to the header file of the class}:
 \begin{itemize}
 
 \item AliVCaloCluster *GetCaloCluster(Int\_t i) : Returns a CaloCluster listed in position "i" in the array of CaloClusters. It can be either PHOS or EMCal (PHOS list of clusters is before the EMCal list).
@@ -174,30 +165,36 @@ They   contain an array with  the amplitude or time of all the cells that fired
 
 \subsection{Macros}
 You can find example macros to run on ESDs or AODs in 
-
-\$ALICE\_ROOT/EMCAL/macros/TestESD.C or TestAOD.C
+\begin{lstlisting}
+$ALICE_ROOT/EMCAL/macros/TestESD.C or TestAOD.C
+\end{lstlisting}
 
  All the ESDs information is filled via the AliEMCALReconstructor/AliPHOSReconstructor class, in the method FillESD(). The AODs are created via the analysis class 
 
-\$ALICE\_ROOT/ANALYSIS/AliAnalysisTaskESDfilter.cxx,.h
+\begin{lstlisting}
+$ALICE_ROOT/ANALYSIS/AliAnalysisTaskESDfilter.cxx,.h
+\end{lstlisting}
 
-and as already mentioned, for the calorimeters it basically just copies all the information from ESD format to AOD format. In the lines below I will try to explain what is the information stored and how to retrieve it. The location of the classes that I am going to describe below is 
+and as already mentioned, for the calorimeters it basically just copies all the information from ESD format to AOD format. 
 
-\$ALICE\_ROOT/STEER
+Below is a description of what information is stored and how to retrieve it. The location of the corresponding classes is
+\begin{lstlisting}
+$ALICE_ROOT/STEER
+\end{lstlisting}
 
 
 
-\subsection{Example code}
+\subsection{Code example}
 
-The analysis is done using the data stored in the ESD. The macro\\
- \textbf{\$ALICE\_ROOT/EMCAL/macros/TestESD.C}\\
+The analysis is done using the data stored in the ESD. The macro
+\begin{lstlisting}
+$ALICE_ROOT/EMCAL/macros/TestESD.C
+\end{lstlisting}
 is an example of how to read the data for the calorimeters PHOS and
 EMCal (just replace where it says EMCAL by PHOS in the macro to obtain
-PHOS data). For these detectors we have to use the ESD class AliESDCaloCluster or AliESDCaloCells
-to retrieve all the calorimeters information. For the tracking detectors,
+PHOS data). For these detectors we have to use the ESD class AliESDCaloCluster or AliESDCaloCells to retrieve all the calorimeters information. For the tracking detectors,
 the class is called AliESDtrack, but the way to use it is very similar
-(see {}``\$ALICE\_ROOT/STEER/AliESDtrack.{*} '' and {}``\$ALICE\_ROOT/STEER/AliESDCaloCluster{*}
-'' for more details). In AliESDCaloCluster we keep the following
+(see ``\$ALICE\_ROOT/STEER/AliESDtrack.*''\\ and ``\$ALICE\_ROOT/STEER/AliESDCaloCluster*'' for more details). In AliESDCaloCluster we keep the following
 cluster information: energy, position, number of Digits that belong
 to the cluster, list of the cluster Digits indeces, shower dispersion, shower lateral axis and a few more parameters. In AliESDCaloCells we keep the following
 tower information: amplitude (GeV), time (seconds), absolute cell number.
@@ -206,8 +203,7 @@ The structure of the ESD testing macro (TestESD.C) is the
 following:
 
 \begin{itemize}
-\item Lines 0-29: This macro is prepared to be compiled so it has \texttt{{}``includes''}
-to all the Root and AliRoot classes used.
+\item Lines 0-29: This macro is prepared to be compiled so it has ``includes'' to all the Root and AliRoot classes used.
 
 \item Lines 30-36: This macro prints some information on screen, the kind of information is set here. We  print by default clusters information and optionally, the cells information, the matches information, the cells in the clusters information or the MonteCarlo original particle kinematics.