]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - MUON/AliMUONData.h
- Adapted comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONData.h
index ebf12306f2a9ead55accb9a17bd3c4cc32aac055..a912f041b759afef97f1dfaa508009fccaa06ae8 100644 (file)
@@ -48,7 +48,7 @@ class AliMUONData : public TNamed
 {
   public:
   
-  enum EChamberIteration { kAllChambers, kTrackingChambers, kTriggerChambers };
+  //  enum EChamberIteration { kAllChambers, kTrackingChambers, kTriggerChambers };
   
     AliMUONData();
     AliMUONData(AliLoader * loader, const char* name, const char* title);
@@ -71,36 +71,44 @@ class AliMUONData : public TNamed
                          Float_t phi, Float_t length, Float_t destep, 
                          Float_t Xref,Float_t Yref,Float_t Zref);
     
-    virtual void   AddGlobalTrigger(Int_t *singlePlus, Int_t *singleMinus,
-                                   Int_t *singleUndef, Int_t *pairUnlike, 
-                                   Int_t *pairLike);
     virtual void   AddGlobalTrigger(const AliMUONGlobalTrigger& trigger); // use copy constructor
 
-    virtual void   AddLocalTrigger(const Int_t* ltrigger, const TArrayI& digits);
     virtual void   AddLocalTrigger(const AliMUONLocalTrigger& trigger); // use copy constructor
 
     virtual void   AddRawCluster(Int_t id, const AliMUONRawCluster& clust);
     virtual void   AddRecTrack(const AliMUONTrack& track);
     virtual void   AddRecTriggerTrack(const AliMUONTriggerTrack& triggertrack);
 
-    TClonesArray*  Hits() {return fHits;}
+    TClonesArray*  Hits() {return fHits;} ///< Return hits
     TClonesArray*  Digits(Int_t DetectionPlane) const;
     TClonesArray*  SDigits(Int_t DetectionPlane) const;
     TClonesArray*  LocalTrigger() const;
     TClonesArray*  GlobalTrigger() const;    
     TClonesArray*  RawClusters(Int_t DetectionPlane);
-    TClonesArray*  RecTracks() {return fRecTracks;}
+    
+                    /// Return reconstructed tracks
+    TClonesArray*  RecTracks() {return fRecTracks;} 
+                   /// Return reconstructed trigger tracks
     TClonesArray*  RecTriggerTracks() {return fRecTriggerTracks;}
 
+                    /// Load hits for \a i th entry in hits three
     void           GetTrack(Int_t it) const  {fLoader->TreeH()->GetEvent(it);}
+                   /// Get number of entries in hits three
     Int_t          GetNtracks() const      {return (Int_t) fLoader->TreeH()->GetEntries();}
     void           GetDigits() const;
+                   /// Load sdigits tree
     void           GetSDigits() const {fLoader->TreeS()->GetEvent(0);}
+                   /// Load raw clusters tree
     void           GetRawClusters() const {fLoader->TreeR()->GetEvent(0);}
+                   /// Load trigger tree
     void           GetTrigger() const {fLoader->TreeR()->GetEvent(0);}
+                   /// Load trigger D tree
     void           GetTriggerD() const {fLoader->TreeD()->GetEvent(0);}
+                   /// Return split level
     Int_t          GetSplitLevel() const {return fSplitLevel;}
+                   /// Return reconstructed tracks
     void           GetRecTracks() const {fLoader->TreeT()->GetEvent(0);}
+                   /// Return reconstructed trigger tracks
     void           GetRecTriggerTracks() const {fLoader->TreeT()->GetEvent(0);}
 
     Bool_t        IsRawClusterBranchesInTree();
@@ -110,13 +118,16 @@ class AliMUONData : public TNamed
     Bool_t        IsTrackBranchesInTree();
     Bool_t        IsTriggerTrackBranchesInTree();
 
+                       /// Get loader
     virtual AliLoader* GetLoader() const { return fLoader; }
+                       /// Set loader
     virtual void       SetLoader(AliLoader * loader) {fLoader=loader;}    
     
     virtual void   Fill(Option_t* opt=" ");
     virtual void   MakeBranch(Option_t *opt=" ");
     virtual void   SetTreeAddress(Option_t *opt=" ");
     
+                   /// Set split level
     void           SetSplitLevel(Int_t SplitLevel) {fSplitLevel=SplitLevel;}
     
     virtual void Print(Option_t* opt="") const;
@@ -129,40 +140,46 @@ class AliMUONData : public TNamed
     virtual void   ResetRecTracks();
     virtual void   ResetRecTriggerTracks();
   
+                   /// Return tree with hits
     TTree*         TreeH() {return fLoader->TreeH(); }
+                   /// Return tree with digits
     TTree*         TreeD() {return fLoader->TreeD(); }
+                   /// Return tree with summable digits
     TTree*         TreeS() {return fLoader->TreeS(); }
+                   /// Return tree with raw clusters
     TTree*         TreeR() {return fLoader->TreeR(); }
+                   /// Return tree with tracks
     TTree*         TreeT() {return fLoader->TreeT(); }
+                   /// Return tree with particles
     TTree*         TreeP() {return fLoader->TreeP(); }
 
-    TIterator* CreateDigitIterator(EChamberIteration type);
+    //    TIterator* CreateDigitIterator(AliMUONData::EChamberIteration type);
     
   protected: 
     AliMUONData(const AliMUONData& rhs);
     AliMUONData& operator=(const AliMUONData& rhs);
 
-    AliLoader*  fLoader; //! Detector Loader pointer
-    TClonesArray*   fHits;  // One event in treeH per primary track
-    TObjArray*      fDigits; // One event in treeD and one branch per detection plane
-    TObjArray*      fSDigits; // One event in treeS and one branch per detection plane
-    TObjArray*      fRawClusters; //One event in TreeR/Rawcluster and one branch per tracking detection plane
-    TClonesArray*   fGlobalTrigger;  // List of Global Trigger One event in TreeR/GlobalTriggerBranch
-    TClonesArray*   fLocalTrigger;  // List of Local Trigger, One event in TreeR/LocalTriggerBranch
-    TClonesArray*   fRecTracks; // pointer to array of reconstructed tracks
-    TClonesArray*   fRecTriggerTracks; // pointer to array of reconstructed trigger tracks
-
-    Int_t           fNhits; //!  Number of Hits
-    Int_t*          fNdigits;//! Number of Digits
-    Int_t*          fNSdigits;//! Number of Digits
-    Int_t*          fNrawclusters;//! Number of Raw Clusters
-    Int_t           fNglobaltrigger;//! Number of Global trigger
-    Int_t           fNlocaltrigger;//! Number of Local trigger
-    Int_t           fNrectracks; //! Number of reconstructed tracks
-    Int_t           fNrectriggertracks; //! Number of reconstructed tracks
-    Int_t           fSplitLevel; // Splitting of branches 0 no spitting (root files are smaller) 1 splitting (larger output files)
-
-    mutable Int_t fCurrentEvent; // Current event we're dealing with\13
+    AliLoader*      fLoader;  //!< Detector Loader pointer
+    TClonesArray*   fHits;    ///< One event in treeH per primary track
+    TObjArray*      fDigits;  ///< One event in treeD and one branch per detection plane
+    TObjArray*      fSDigits; ///< One event in treeS and one branch per detection plane
+    TObjArray*      fRawClusters; ///< One event in TreeR/Rawcluster and one branch per tracking detection plane
+    TClonesArray*   fGlobalTrigger; ///< List of Global Trigger One event in TreeR/GlobalTriggerBranch
+    TClonesArray*   fLocalTrigger;  ///< List of Local Trigger, One event in TreeR/LocalTriggerBranch
+    TClonesArray*   fRecTracks; ///< pointer to array of reconstructed tracks
+    TClonesArray*   fRecTriggerTracks; ///< pointer to array of reconstructed trigger tracks
+
+    Int_t           fNhits;   //!< Number of Hits
+    Int_t*          fNdigits; //!< Number of Digits
+    Int_t*          fNSdigits;//!< Number of Digits
+    Int_t*          fNrawclusters;  //!< Number of Raw Clusters
+    Int_t           fNglobaltrigger;//!< Number of Global trigger
+    Int_t           fNlocaltrigger; //!< Number of Local trigger
+    Int_t           fNrectracks;    //!< Number of reconstructed tracks
+    Int_t           fNrectriggertracks; //!< Number of reconstructed tracks
+    Int_t           fSplitLevel;   ///< Splitting of branches 0 no spitting (root files are smaller) 1 splitting (larger output files)
+
+    mutable Int_t fCurrentEvent; ///< Current event we're dealing with
     
 private: