Improve documentation

[u/mrichter/AliRoot.git] / PHOS / AliPHOSv1.h

diff --git a/PHOS/AliPHOSv1.h b/PHOS/AliPHOSv1.h
index f4a4d358653cb8cf195e18ded33c5c88f308d63b..d843edb7e6707e7c01689737c894dd79b6e34382 100644 (file)
--- a/PHOS/AliPHOSv1.h
+++ b/PHOS/AliPHOSv1.h
@@ -1,29 +1,48 @@
-#ifndef PHOSv1_H
-#define PHOSv1_H
+#ifndef ALIPHOSV1_H
+#define ALIPHOSV1_H
 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
  * See cxx source for full Copyright notice                               */
 
-/* $Id$ */
+//_________________________________________________________________________
+// Implementation version v0 of PHOS Manager class 
+// Layout EMC + PPSD has name GPS2  
+// The main goal of this version of AliPHOS is to calculte the 
+//  induced charged in the PIN diode, taking into account light
+//  tracking in the PbWO4 crystal, induced signal in the 
+//  PIN due to MIPS particle and electronic noise.
+// This is done in the StepManager 
+//                  
+//*-- Author:  Odd Harald Oddland & Gines Martinez (SUBATECH)
 
-////////////////////////////////////////////////////////
-//  Manager and hits classes for set:PHOS version 1   //
-////////////////////////////////////////////////////////
+// --- ROOT system ---
 
-// --- galice header files ---
-#include "AliPHOS.h"
+
+// --- AliRoot header files ---
+#include "AliPHOSv0.h"
+
+
+class AliPHOSv1 : public AliPHOSv0 {
+
+public:
+
+  AliPHOSv1(void) : AliPHOSv0() {} // ctor 
+  AliPHOSv1(const char *name, const char *title="") ;
+  AliPHOSv1(AliPHOSReconstructioner * Reconstructioner, const char *name, const char *title="") ;
+  virtual ~AliPHOSv1(void) {} 
+                            
+  virtual void   StepManager(void) ;                                // does the tracking through PHOS and a preliminary digitalization
  
-class AliPHOSv1 : public AliPHOS {
+  
+private:
+  
+  Float_t fLightYieldMean ;         // Mean lightyield in the PbOW4 xtal per GeV (Poisson distribution)
+  Float_t fIntrinsicPINEfficiency ; // Photo efficiency of the PIN diode   
+  Float_t fLightYieldAttenuation ;  // Attenuation of the light through the crystal
+  Float_t fRecalibrationFactor ;    // Recalibration factor
+  Float_t fElectronsPerGeV ;        // Number of electrons per GeV created in the PIN by a ionizing particle
 
- public:
-                        AliPHOSv1();
-                        AliPHOSv1(const char *name, const char *title);
-  virtual              ~AliPHOSv1(){}
-  virtual void          CreateGeometry();
-  virtual Int_t         IsVersion() const {return 1;}
-  virtual void          StepManager();
+  ClassDef(AliPHOSv1,1)  // Implementation of PHOS manager class for layout EMC+PPSD with light transport, MIPS in PIN and electronic noise
 
- ClassDef(AliPHOSv1,1)  //Hits manager for set:PHOS version 1
 };
- 
-#endif
 
+#endif // AliPHOSV1_H