Adding comments for inline functions

[u/mrichter/AliRoot.git] / MUON / AliMUONPairLight.h

diff --git a/MUON/AliMUONPairLight.h b/MUON/AliMUONPairLight.h
index e8fec47b6f559dd0aa8e467fb997f1bc7610afef..bbd0c477a3e052760db6bd911591efb30ec61877 100644 (file)
--- a/MUON/AliMUONPairLight.h
+++ b/MUON/AliMUONPairLight.h
@@ -37,36 +37,56 @@ public:
   AliMUONPairLight(AliMUONPairLight &dimuCopy);
   virtual ~AliMUONPairLight();
   virtual void SetMuons(AliMUONTrackLight mu0, AliMUONTrackLight mu1);
-  AliMUONTrackLight* GetMuon(Int_t index) ; 
+  AliMUONTrackLight* GetMuon(Int_t index) ;   
   Int_t GetMuonMotherPDG(Int_t imuon, Int_t mother=0) ; 
+
+  /// returns kTRUE if the creation process of the pair was "open charm" (kFALSE... otherwise)
   Bool_t IsOpenCharm() {return (TMath::Abs(fMu0.GetParentFlavour(0))==4 && TMath::Abs(fMu1.GetParentFlavour(0))==4 && fIsCorrelated && !IsAResonance());}
+  /// returns kTRUE if the creation process of the pair was "open beauty" (kFALSE... otherwise)
   Bool_t IsOpenBeauty() {return (TMath::Abs(fMu0.GetParentFlavour(0))==5 && TMath::Abs(fMu1.GetParentFlavour(0))==5 && fIsCorrelated  && !IsAResonance());}
   Bool_t IsAResonance(); 
+  /// returns kTRUE if at least one of the first hadronised parent is a pi or a K (kFALSE... otherwise)
+  Bool_t IsOneMuonFromPionOrKaon(){return (fMu0.IsParentPionOrKaon(0) || fMu1.IsParentPionOrKaon(0));}
+  /// Return the info if the two muons are of correlated origin
   Bool_t IsCorrelated() const {return fIsCorrelated;}   
+  /// Return the pdg of common mother
   Int_t GetCauseOfCorrelation() const {return fCauseOfCorrelation;}
+  /// Return the info if the process is from feeddown 
   Bool_t IsFeedDown() const {return fIsFeedDown;}   
+  /// returns kTRUE if at least one of the reconstructed tracks is not a muon (kFALSE... otherwise)
   Bool_t IsOneTrackNotAMuon() {return (!( fMu0.IsAMuon() && fMu1.IsAMuon() )) ;}
+  /// returns the charge of the created pair
   Int_t GetCharge() {return fMu0.GetCharge() + fMu1.GetCharge();}
+  /// \brief Return the info ablout creation process
+  ///0: pair creation, 1: gluon splitting, 2: flavour excitation, 3: same fragmented mother, -1: resonance
   Int_t GetCreationProcess() const  {return fCreationProcess;}
+  /// Set the info ablout creation process
   void SetCorrelated(Bool_t answer) {fIsCorrelated = answer; }
+  /// Set the pdg of common mother
   void SetCauseOfCorrelation(Int_t pdg) {fCauseOfCorrelation = pdg; }
+  /// Set the info if the process is from feeddown
   void SetFeedDown(Int_t answer) {fIsFeedDown = answer;}
+  /// returns a TLorentzVector containing the reconstructed kinematics of the pair
   TLorentzVector GetPRec(){return fMu0.GetPRec()+fMu1.GetPRec();}
+  /// returns a TLorentzVector containing the generated kinematics of the pair
   TLorentzVector GetPGen(){return fMu0.GetPGen()+fMu1.GetPGen();}
   Double_t GetOpeningAngle(); 
+  Bool_t IsDimuonFromCorrPiK();
   virtual void PrintInfo(Option_t* opt);//"H" single muons' decay histories
                                            //"K" dimuon kinematics
                                            //"F" dimuon flags
                                            //"A" all variables
+
 protected: 
-  AliMUONTrackLight fMu0;   /// first muon  
-  AliMUONTrackLight fMu1;   /// second muon
-  Int_t fCreationProcess; ///0: pair creation, 1: gluon splitting, 2: flavour excitation, 3: same fragmented mother, -1: resonance
-  Bool_t fIsCorrelated; ///tells if the two muons are of correlated origin
-  Int_t fCauseOfCorrelation; ///pdg of common mother
-  Int_t fIsFeedDown;     /// tells if the process is from feeddown 
+  /// Checks if muons are correlated and assigns
+  void SetProcess();
 
-  void SetProcess();///checks if muons are correlated and assigns
+  AliMUONTrackLight fMu0;   ///< first muon  
+  AliMUONTrackLight fMu1;   ///< second muon
+  Int_t fCreationProcess; ///<0: pair creation, 1: gluon splitting, 2: flavour excitation, 3: same fragmented mother, -1: resonance
+  Bool_t fIsCorrelated; ///<tells if the two muons are of correlated origin
+  Int_t fCauseOfCorrelation; ///<pdg of common mother
+  Int_t fIsFeedDown;     ///< tells if the process is from feeddown 
 
   ClassDef(AliMUONPairLight,1)  /// Dimuon carrying info at generation and reconstruction level
 };