]> git.uio.no Git - u/mrichter/AliRoot.git/blob - MUON/AliMUONData.h
Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONData.h
1 #ifndef ALIMUONDATA_H
2 #define ALIMUONDATA_H
3 //
4 /*  Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5  * See cxx source for full Copyright notice                               */
6
7 /* $Id$ */
8 // Revision of includes 07/05/2004
9 //
10 /// \ingroup base
11 /// \class AliMUONData
12 /// \brief Class containing MUON data: hits, digits, rawclusters, globaltrigger, 
13 /// localtrigger, etc ...
14 ///
15 //  Author: Gines Martinez, Subatech,  September 2003
16
17 #include <TNamed.h>
18
19 #include "AliLoader.h"
20
21 class AliMUONConstants;
22 class AliMUONRawCluster;
23 class AliMUONTrack;
24 class AliMUONTriggerTrack;
25 class AliMUONDigit;
26 class AliMUONHit;
27 class AliMUONLocalTrigger;
28 class AliMUONRegionalTrigger;
29 class AliMUONGlobalTrigger;
30
31 class AliRunLoader;
32
33 class TClonesArray;
34 class TNamed;
35 class TObjArray;
36 class TTree;
37 class TIterator;
38 class TArrayI;
39
40
41 //__________________________________________________________________
42 /////////////////////////////////////////////////////////////////////
43 //                                                                 //
44 //  class AliMUONData                                              //
45 //                                                                 //
46 /////////////////////////////////////////////////////////////////////
47
48 class AliMUONData : public TNamed 
49 {
50   public:
51   
52   //  enum EChamberIteration { kAllChambers, kTrackingChambers, kTriggerChambers };
53   
54     AliMUONData();
55     AliMUONData(AliLoader * loader, const char* name, const char* title);
56     AliMUONData(const char* galiceFile);
57     virtual ~AliMUONData();  
58     virtual void   AddDigit(Int_t id, const AliMUONDigit& digit); // use copy constructor
59     virtual void   AddSDigit(Int_t id, const AliMUONDigit& digit); // use copy constructor
60     virtual void   AddHit(Int_t fIshunt, Int_t track, Int_t detElemId, 
61                           Int_t idpart, Float_t X, Float_t Y, Float_t Z, 
62                           Float_t tof, Float_t momentum, Float_t theta, 
63                           Float_t phi, Float_t length, Float_t destep, 
64                           Float_t Xref,Float_t Yref,Float_t Zref);
65     
66     virtual void   AddGlobalTrigger(const AliMUONGlobalTrigger& trigger); // use copy constructor
67
68     virtual void   AddLocalTrigger(const AliMUONLocalTrigger& trigger); // use copy constructor
69  
70     virtual void   AddRegionalTrigger(const AliMUONRegionalTrigger& trigger); // use copy constructor
71
72     virtual void   AddRawCluster(Int_t id, const AliMUONRawCluster& clust);
73     virtual void   AddRecTrack(const AliMUONTrack& track);
74     virtual void   AddRecTriggerTrack(const AliMUONTriggerTrack& triggertrack);
75
76     TClonesArray*  Hits() {return fHits;} ///< Return hits
77     TClonesArray*  Digits(Int_t DetectionPlane) const;
78     TClonesArray*  SDigits(Int_t DetectionPlane) const;
79     TClonesArray*  LocalTrigger() const;
80     TClonesArray*  RegionalTrigger() const;
81     TClonesArray*  GlobalTrigger() const;    
82     TClonesArray*  RawClusters(Int_t DetectionPlane);
83     
84                     /// Return reconstructed tracks
85     TClonesArray*  RecTracks() {return fRecTracks;} 
86                    /// Return reconstructed trigger tracks
87     TClonesArray*  RecTriggerTracks() {return fRecTriggerTracks;}
88
89     void           GetTrack(Int_t it) const;
90     Int_t          GetNtracks() const;
91     void           GetDigits() const;
92     void           GetSDigits() const;
93     void           GetRawClusters() const;
94     void           GetTrigger() const;
95     void           GetTriggerD() const;
96     void           GetRecTracks() const;
97     void           GetRecTriggerTracks() const;
98
99     Int_t          GetSplitLevel() const {return fSplitLevel;}
100
101     Bool_t        IsRawClusterBranchesInTree();
102     Bool_t        IsDigitsBranchesInTree();
103     Bool_t        IsTriggerBranchesInTree();
104     Bool_t        IsTriggerBranchesInTreeD();
105     Bool_t        IsTrackBranchesInTree();
106     Bool_t        IsTriggerTrackBranchesInTree();
107
108                        /// Get loader
109     virtual AliLoader* GetLoader() const { return fLoader; }
110                        /// Set loader
111     virtual void       SetLoader(AliLoader * loader) {fLoader=loader;}    
112     
113     virtual void   Fill(Option_t* opt=" ");
114     virtual void   MakeBranch(Option_t *opt=" ");
115     virtual void   SetDataContainer(Option_t *opt=" ");
116     virtual void   SetTreeAddress(Option_t *opt=" ");
117     
118                    /// Set split level
119     void           SetSplitLevel(Int_t SplitLevel) {fSplitLevel=SplitLevel;}
120     
121     virtual void Print(Option_t* opt="") const;
122     
123     virtual void   ResetHits();
124     virtual void   ResetDigits();
125     virtual void   ResetSDigits();
126     virtual void   ResetTrigger();
127     virtual void   ResetRawClusters();
128     virtual void   ResetRecTracks();
129     virtual void   ResetRecTriggerTracks();
130   
131                    /// Return tree with hits
132     TTree*         TreeH() {return fLoader->TreeH(); }
133                    /// Return tree with digits
134     TTree*         TreeD() {return fLoader->TreeD(); }
135                    /// Return tree with summable digits
136     TTree*         TreeS() {return fLoader->TreeS(); }
137                    /// Return tree with raw clusters
138     TTree*         TreeR() {return fLoader->TreeR(); }
139                    /// Return tree with tracks
140     TTree*         TreeT() {return fLoader->TreeT(); }
141                    /// Return tree with particles
142     TTree*         TreeP() {return fLoader->TreeP(); }
143
144                    // Methods to dump data
145     void DumpKine(Int_t event2Check=0);
146     void DumpHits(Int_t event2Check=0, Option_t* opt="full");
147     void DumpDigits(Int_t event2Check=0, Option_t* opt="tracks");
148     void DumpSDigits(Int_t event2Check=0, Option_t* opt="tracks");
149     void DumpRecPoints(Int_t event2Check=0, Option_t* opt="full");
150     void DumpRecTrigger(Int_t event2Check=0, Int_t write = 0, Bool_t readFromRP = kTRUE);
151     
152   protected: 
153     AliMUONData(const AliMUONData& rhs);
154     AliMUONData& operator=(const AliMUONData& rhs);
155
156     AliRunLoader*   fRunLoader; //!< Run loader pointer
157     AliLoader*      fLoader;  //!< Detector Loader pointer
158     TClonesArray*   fHits;    ///< One event in treeH per primary track
159     TObjArray*      fDigits;  ///< One event in treeD and one branch per detection plane
160     TObjArray*      fSDigits; ///< One event in treeS and one branch per detection plane
161     TObjArray*      fRawClusters; ///< One event in TreeR/Rawcluster and one branch per tracking detection plane
162     TClonesArray*   fGlobalTrigger; ///< List of Global Trigger One event in TreeR/GlobalTriggerBranch
163     TClonesArray*   fLocalTrigger;  ///< List of Local Trigger, One event in TreeR/LocalTriggerBranch
164     TClonesArray*   fRegionalTrigger;  ///< List of Regional Trigger, One event in TreeR/LocalTriggerBranch
165
166     TClonesArray*   fRecTracks; ///< pointer to array of reconstructed tracks
167     TClonesArray*   fRecTriggerTracks; ///< pointer to array of reconstructed trigger tracks
168
169     Int_t           fNhits;   //!< Number of Hits
170     Int_t*          fNdigits; //!< Number of Digits
171     Int_t*          fNSdigits;//!< Number of Digits
172     Int_t*          fNrawclusters;  //!< Number of Raw Clusters
173     Int_t           fNglobaltrigger;//!< Number of Global trigger
174     Int_t           fNlocaltrigger; //!< Number of Local trigger
175     Int_t           fNregionaltrigger; //!< Number of regional trigger
176     Int_t           fNrectracks;    //!< Number of reconstructed tracks
177     Int_t           fNrectriggertracks; //!< Number of reconstructed tracks
178     Int_t           fSplitLevel;   ///< Splitting of branches 0 no spitting (root files are smaller) 1 splitting (larger output files)
179
180     mutable Int_t fCurrentEvent; ///< Current event we're dealing with
181     
182 private:  
183
184   ClassDef(AliMUONData,3) // Data accessor for MUON module
185       
186 };
187 // inline functions
188
189
190 /// Load hits for \a i th entry in hits three
191 inline void AliMUONData::GetTrack(Int_t it) const  {
192   if (fLoader && fLoader->TreeH())
193     fLoader->TreeH()->GetEvent(it);
194 }
195
196 /// Load sdigits tree
197 inline void AliMUONData::GetSDigits() const {
198   if (fLoader && fLoader->TreeS())
199     fLoader->TreeS()->GetEvent(0);
200 }
201
202 /// Load raw clusters tree
203 inline void AliMUONData::GetRawClusters() const {
204   if (fLoader && fLoader->TreeR())
205     fLoader->TreeR()->GetEvent(0);
206 }
207
208 /// Load trigger tree
209 inline void AliMUONData::GetTrigger() const {
210   if (fLoader && fLoader->TreeR())
211     fLoader->TreeR()->GetEvent(0);
212 }
213
214 /// Load trigger D tree
215 inline void AliMUONData::GetTriggerD() const {
216   if (fLoader && fLoader->TreeD())
217     fLoader->TreeD()->GetEvent(0);
218 }
219
220 /// Return reconstructed tracks
221 inline void AliMUONData::GetRecTracks() const {
222   if (fLoader && fLoader->TreeT())
223     fLoader->TreeT()->GetBranch("MUONTrack")->GetEvent(0);
224 }
225
226 /// Return reconstructed trigger tracks
227 inline void AliMUONData::GetRecTriggerTracks() const {
228   if (fLoader && fLoader->TreeT())
229     fLoader->TreeT()->GetBranch("MUONTriggerTrack")->GetEvent(0);
230 }
231
232
233
234 #endif
235