Coding convention

[u/mrichter/AliRoot.git] / PHOS / AliPHOSJet.cxx

diff --git a/PHOS/AliPHOSJet.cxx b/PHOS/AliPHOSJet.cxx
index a3ef8e47efe946e612b2f10f488c0da0292c5ad8..22b85eaf75eba3f5873678984c45f3efc1fe25d2 100644 (file)
--- a/PHOS/AliPHOSJet.cxx
+++ b/PHOS/AliPHOSJet.cxx
@@ -13,9 +13,14 @@
  * provided "as is" without express or implied warranty.                  *
  **************************************************************************/
 
+/* $Id$ */
+
 //_________________________________________________________________________
 // Class to calculate jet chararacteristics
 //
+// This class implements for PHOS a jet finder for PHOS. It depends on a 
+// energy seed
+// minimum energy, cone radius and movement of the cone.
 //*-- Author :  D.Peressounko
 //////////////////////////////////////////////////////////////////////////////
 
@@ -32,6 +37,7 @@ ClassImp(AliPHOSJet)
   
 //____________________________________________________________________________ 
 AliPHOSJet::AliPHOSJet():TObject() {
+  //Inicilize members
   fNpart = 0 ;
   fList = 0 ;
   //  fMode = 0 ;
@@ -52,6 +58,7 @@ AliPHOSJet::AliPHOSJet():TObject() {
 
 //____________________________________________________________________________ 
 AliPHOSJet::~AliPHOSJet(){
+  //dtor
   if(fList){
     delete fList ;
     fList = 0 ;
@@ -59,7 +66,7 @@ AliPHOSJet::~AliPHOSJet(){
   
 }
 //____________________________________________________________________________ 
-void AliPHOSJet::AddParticle(const TParticle * p,const Int_t index){
+void AliPHOSJet::AddParticle(const TParticle * p, Int_t index){
   //adds particle to jet. Calculates change in jet direction, 
   //due to addition of this particle and if it is smaller, than fMaxDev, 
   //add particle, axcept new direction and return true.
@@ -94,7 +101,7 @@ void AliPHOSJet::AddParticle(const TParticle * p,const Int_t index){
   }
 }
 //____________________________________________________________________________ 
-void AliPHOSJet::AddDigit(const Double_t e,const Double_t eta,const Double_t phi, const Int_t index){
+void AliPHOSJet::AddDigit(Double_t e, Double_t eta, Double_t phi, Int_t index){
   //adds particle to jet. Calculates change in jet direction, 
   //due to addition of this particle and if it is smaller, than fMaxDev, 
   //add particle, axcept new direction and return true.
@@ -173,7 +180,7 @@ Bool_t AliPHOSJet::AcceptConeDeviation(const TParticle * p)const
     return kFALSE ;
 }
 //____________________________________________________________________________ 
-Bool_t AliPHOSJet::AcceptConeDeviation(const Double_t e,const Double_t eta,const Double_t phi)const
+Bool_t AliPHOSJet::AcceptConeDeviation(Double_t e, Double_t eta, Double_t phi)const
 { //Calculate cone deviation in case of inclusion of the given
   //particle to jet. 
 
@@ -190,7 +197,8 @@ Bool_t AliPHOSJet::AcceptConeDeviation(const Double_t e,const Double_t eta,const
 }
 //____________________________________________________________________________ 
 Bool_t AliPHOSJet::IsInCone(const TParticle * p)const
-{//
+{
+  //Say if  particle is inside the defined cone
   Double_t dEta ;
   Double_t dPhi ;
   if(!fEnergy){ //Final values not calculated yet, use intermediate
@@ -215,8 +223,9 @@ Bool_t AliPHOSJet::IsInCone(const TParticle * p)const
     return kFALSE ;
 }
 //____________________________________________________________________________ 
-Bool_t AliPHOSJet::IsInCone(const Double_t e,const Double_t eta,const Double_t phi)const
-{//
+Bool_t AliPHOSJet::IsInCone(Double_t eta, Double_t phi)const
+{
+  //Says if particle is inside the defined cone
   Double_t dEta ;
   Double_t dPhi ;
   if(!fEnergy){ //Final values not calculated yet, use intermediate
@@ -260,7 +269,7 @@ Double_t AliPHOSJet::DistanceToJet(const TParticle *p)const{
 }
 //____________________________________________________________________________ 
 void AliPHOSJet::CalculateAll(void){
-
+  //Calculate all jet parameters
   if(fSumEnergy==0)
     return  ; //Nothing to calculate    
   
@@ -273,7 +282,8 @@ void AliPHOSJet::CalculateAll(void){
   fSumPhi = 0. ;
 }
 //____________________________________________________________________________ 
-void AliPHOSJet::Print(Option_t * option){
+void AliPHOSJet::Print(){
+  //Print jet parameters
   printf("-------------- AliPHOSJet ------------\n") ;
   printf(" Energy............. %f \n",fEnergy) ;
   printf(" Eta................ %f \n",fEta ) ;
@@ -284,3 +294,6 @@ void AliPHOSJet::Print(Option_t * option){
   printf(" N particles in jet  %d \n",fNpart) ;
   printf("----------------------------------\n") ;
 }
+
+
+