Corrections to comply with coding convention

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

diff --git a/PHOS/AliPHOSEmcRecPoint.h b/PHOS/AliPHOSEmcRecPoint.h
index 6a727b13ff153b319b733982ada769db45322624..caf053646e786c297b9ce95c172369429ada12a6 100644 (file)
--- a/PHOS/AliPHOSEmcRecPoint.h
+++ b/PHOS/AliPHOSEmcRecPoint.h
@@ -27,30 +27,50 @@ class AliPHOSEmcRecPoint : public AliPHOSRecPoint  {
 
 public:
 
-  AliPHOSEmcRecPoint(){} ;                    
+  AliPHOSEmcRecPoint(){
+    // default ctor
+  } ;                    
   AliPHOSEmcRecPoint(Float_t W0, Float_t LocMaxCut) ;
   virtual ~AliPHOSEmcRecPoint() ;  
 
   virtual void  AddDigit(AliPHOSDigit & digit, Float_t Energy) ;  // add a digit to the digits list  
   Int_t       Compare(TObject * obj) ;                         // method for sorting  
   
-  Float_t     GetDelta (){ return fDelta ; }    
+  Float_t     GetDelta (){ 
+    // gets the fDelta data member 
+    return fDelta ; }    
   Float_t     GetDispersion() ;                               // computes the dispersion of the shower
   void        GetElipsAxis(Float_t * lambda) ;                // computes the axis of shower ellipsoide
-  Float_t *   GetEnergiesList(){return fEnergyList ;} 
+  Float_t *   GetEnergiesList(){
+    // gets the list of energies makink this recpoint
+    return fEnergyList ;} 
   virtual void ExecuteEvent(Int_t event, Int_t px, Int_t py) ; 
-  Float_t     GetLocMaxCut () {return fLocMaxCut ; }
-  Float_t     GetLogWeightCut (){return fW0 ; }
+  Float_t     GetLocMaxCut () {
+    // gets the cut of the local maximum search 
+    return fLocMaxCut ; }
+  Float_t     GetLogWeightCut (){
+    // gets the logarythmic weight for the center of gravity calculation
+    return fW0 ; }
   Float_t     GetMaximalEnergy(void) ;                        // get the highest energy in the cluster
-  Int_t       GetMaximumMultiplicity() { return   fMaxDigit ; } 
-  Int_t       GetMultiplicity(void) const { return fMulDigit ; } 
+  Int_t       GetMaximumMultiplicity() { 
+    // gets the maximum number of digits allowed
+    return   fMaxDigit ; } 
+  Int_t       GetMultiplicity(void) const { 
+    // gets the number of digits making this recpoint
+    return fMulDigit ; } 
   Int_t       GetMultiplicityAtLevel(const Float_t level) ;   // computes multiplicity of digits with energy above relative level
   Int_t       GetNumberOfLocalMax(Int_t *  maxAt, Float_t * maxAtEnergy) ; // searches for the local maxima 
  
-  Float_t     GetTotalEnergy(void) const { return fAmp ; }    // in EMC RecPoint Amp = Energy
-  void        GetLocalPosition(TVector3 &Lpos) ;              // computes the position in the PHOS module 
-  Bool_t      IsEmc(void) {return kTRUE ; } 
-  Bool_t      IsSortable() const { return kTRUE ; } 
+  Float_t     GetTotalEnergy(void) const { 
+    // gets the total amplitude of this recpoint (in EMC RecPoint Amp = Energy)
+    return fAmp ; }    
+  void        GetLocalPosition(TVector3 &Lpos) ;  // computes the position in the PHOS module 
+  Bool_t      IsEmc(void) {
+    // true if the recpoint is in EMC
+    return kTRUE ; } 
+  Bool_t      IsSortable() const { 
+    // says that emcrecpoints are sortable objects 
+    return kTRUE ; } 
   void        Print(Option_t * opt = "void") ; 
 
 private:
@@ -58,7 +78,7 @@ private:
   Bool_t AreNeighbours(AliPHOSDigit * digit1, AliPHOSDigit * digit2 ) ;
 
   Float_t  fDelta ;          // parameter used to sort the clusters    
-  Float_t  *fEnergyList ;    // energy of digits
+  Float_t  *fEnergyList ;    //[fMulDigit] energy of digits
   Float_t  fLocMaxCut ;      // minimum energy difference to distinguish two maxima 
   Float_t  fW0 ;             // logarithmic weight factor for center of gravity calculation