]>
Commit | Line | Data |
---|---|---|
a1f80595 | 1 | #ifndef AliFMDInput_H |
2 | #define AliFMDInput_H | |
3 | /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights | |
4 | * reserved. | |
5 | * | |
6 | * See cxx source for full Copyright notice | |
7 | */ | |
02a27b50 | 8 | //___________________________________________________________________ |
9 | // | |
10 | // The classes defined here, are utility classes for reading in data | |
11 | // for the FMD. They are put in a seperate library to not polute the | |
12 | // normal libraries. The classes are intended to be used as base | |
13 | // classes for customized class that do some sort of analysis on the | |
14 | // various types of data produced by the FMD. | |
c2fc1258 | 15 | /** @file AliFMDInput.h |
16 | @author Christian Holm Christensen <cholm@nbi.dk> | |
17 | @date Mon Mar 27 12:42:40 2006 | |
18 | @brief FMD utility classes for reading FMD data | |
19 | */ | |
a1f80595 | 20 | //___________________________________________________________________ |
9f662337 | 21 | /** @defgroup FMD_util Utility classes. |
22 | ||
23 | The classes defined here, are utility classes for reading in data | |
24 | for the FMD. They are put in a seperate library to not polute the | |
25 | normal libraries. The classes are intended to be used as base | |
26 | classes for customized class that do some sort of analysis on the | |
27 | various types of data produced by the FMD. | |
28 | */ | |
8f6ee336 | 29 | #include <TObject.h> |
a1f80595 | 30 | #ifndef ROOT_TString |
31 | # include <TString.h> | |
32 | #endif | |
8f6ee336 | 33 | class AliRunLoader; |
34 | class AliLoader; | |
35 | class AliStack; | |
36 | class AliRun; | |
d760ea03 | 37 | class AliRawReader; |
8f6ee336 | 38 | class AliFMD; |
39 | class AliFMDHit; | |
bf000c32 | 40 | class AliFMDDigit; |
41 | class AliFMDSDigit; | |
42 | class AliFMDRecPoint; | |
43 | class AliESD; | |
44 | class AliESDFMD; | |
8f6ee336 | 45 | class TString; |
46 | class TClonesArray; | |
47 | class TTree; | |
48 | class TGeoManager; | |
49 | class TParticle; | |
bf000c32 | 50 | class TChain; |
a1f80595 | 51 | |
52 | //___________________________________________________________________ | |
9f662337 | 53 | /** @class AliFMDInput |
54 | @brief Base class for reading in various FMD data. | |
55 | The class loops over all found events. For each event the | |
56 | specified data is read in. The class then loops over all | |
57 | elements of the read data, and process these with user defined | |
58 | code. | |
59 | @code | |
60 | struct DigitInput : public AliFMDInput | |
61 | { | |
62 | DigitInput() | |
63 | { | |
64 | // Load digits | |
65 | AddLoad(kDigits); | |
66 | // Make a histogram | |
67 | fHist = new TH1F("adc", "ADC spectra", 1024, -.5, 1023.5); | |
68 | } | |
69 | // Process one digit. | |
70 | Bool_t ProcessDigit(AliFMDDigit* d) | |
71 | { | |
72 | fHist->Fill(d->Counts()); | |
73 | return kTRUE; | |
74 | } | |
75 | // After processing all events, display spectrum | |
76 | Bool_t Finish() | |
77 | { | |
78 | fHist->Draw(); | |
79 | } | |
80 | TH1F* fHist; | |
81 | }; | |
82 | ||
83 | void AdcSpectrum() | |
84 | { | |
85 | DigitInput di; | |
86 | di.Run(); | |
87 | } | |
88 | @endcode | |
89 | This class allows for writing small scripts, that can be compiled | |
90 | with AcLIC, to do all sorts of tests, quick prototyping, and so | |
91 | on. It has proven to be quiet useful. One can load more than | |
92 | one type of data in one derived class, to for example to make | |
93 | comparisons between hits and reconstructed points. See also the | |
94 | various scripts in @c FMD/scripts. | |
95 | @ingroup FMD_util | |
96 | */ | |
a1f80595 | 97 | class AliFMDInput : public TObject |
98 | { | |
99 | public: | |
9f662337 | 100 | /** The kinds of data that can be read in. */ |
a1f80595 | 101 | enum ETrees { |
8f6ee336 | 102 | kHits = 1, // Hits |
103 | kKinematics, // Kinematics (from sim) | |
104 | kDigits, // Digits | |
105 | kSDigits, // Summable digits | |
106 | kHeader, // Header information | |
107 | kRecPoints, // Reconstructed points | |
bf000c32 | 108 | kESD, // Load ESD's |
d760ea03 | 109 | kRaw, // Read raw data |
8f6ee336 | 110 | kGeometry // Not really a tree |
a1f80595 | 111 | }; |
9f662337 | 112 | /** CTOR */ |
a1f80595 | 113 | AliFMDInput(); |
9f662337 | 114 | /** CTOR |
115 | @param gAliceFile galice file */ | |
a1f80595 | 116 | AliFMDInput(const char* gAliceFile); |
9f662337 | 117 | /** DTOR */ |
a1f80595 | 118 | virtual ~AliFMDInput() {} |
119 | ||
9f662337 | 120 | /** Add a data type to load |
121 | @param tree Data to load */ | |
a1f80595 | 122 | virtual void AddLoad(ETrees tree) { SETBIT(fTreeMask, tree); } |
9f662337 | 123 | /** Remove a data type to load |
124 | @param tree Data to @e not load */ | |
a1f80595 | 125 | virtual void RemoveLoad(ETrees tree) { CLRBIT(fTreeMask, tree); } |
9f662337 | 126 | /** @return # of available events */ |
a1f80595 | 127 | virtual Int_t NEvents() const; |
128 | ||
9f662337 | 129 | /** Initialize the class. If a user class overloads this member |
130 | function, then this @e must be explicitly called | |
131 | @return @c false on error */ | |
a1f80595 | 132 | virtual Bool_t Init(); |
9f662337 | 133 | /** Callled at the beginning of each event. If a user class |
134 | overloads this member function, then this @e must be explicitly | |
135 | called. | |
136 | @param event Event number | |
137 | @return @c false on error */ | |
a1f80595 | 138 | virtual Bool_t Begin(Int_t event); |
9f662337 | 139 | /** Process one event. This loops over all the loaded data. Users |
140 | can overload this member function, but then it's @e strongly | |
141 | recommended to explicitly call this classes version. | |
142 | @return @c false on error */ | |
bf000c32 | 143 | virtual Bool_t Event(); |
9f662337 | 144 | /** Called at the end of each event. |
145 | @return @c false on error */ | |
a1f80595 | 146 | virtual Bool_t End(); |
9f662337 | 147 | /** Called at the end of the run. |
148 | @return @c false on error */ | |
a1f80595 | 149 | virtual Bool_t Finish() { return kTRUE; } |
9f662337 | 150 | /** Run a full job. |
151 | @return @c false on error */ | |
a1f80595 | 152 | virtual Bool_t Run(); |
bf000c32 | 153 | |
9f662337 | 154 | /** Loop over all hits, and call ProcessHit with that hit, and |
155 | optionally the corresponding kinematics track. | |
156 | @return @c false on error */ | |
bf000c32 | 157 | virtual Bool_t ProcessHits(); |
9f662337 | 158 | /** Loop over all digits, and call ProcessDigit for each digit. |
159 | @return @c false on error */ | |
bf000c32 | 160 | virtual Bool_t ProcessDigits(); |
9f662337 | 161 | /** Loop over all summable digits, and call ProcessSDigit for each |
162 | digit. | |
163 | @return @c false on error */ | |
bf000c32 | 164 | virtual Bool_t ProcessSDigits(); |
9f662337 | 165 | /** Loop over all digits read from raw data files, and call |
166 | ProcessRawDigit for each digit. | |
167 | @return @c false on error */ | |
d760ea03 | 168 | virtual Bool_t ProcessRawDigits(); |
9f662337 | 169 | /** Loop over all reconstructed points, and call ProcessRecPoint for |
170 | each reconstructed point. | |
171 | @return @c false on error */ | |
bf000c32 | 172 | virtual Bool_t ProcessRecPoints(); |
173 | ||
9f662337 | 174 | /** Process one hit, and optionally it's corresponding kinematics |
175 | track. Users should over this to process each hit. | |
176 | @return @c false on error */ | |
bf000c32 | 177 | virtual Bool_t ProcessHit(AliFMDHit*, TParticle*) { return kTRUE; } |
9f662337 | 178 | /** Process one digit. Users should over this to process each digit. |
179 | @return @c false on error */ | |
bf000c32 | 180 | virtual Bool_t ProcessDigit(AliFMDDigit*) { return kTRUE; } |
9f662337 | 181 | /** Process one summable digit. Users should over this to process |
182 | each summable digit. | |
183 | @return @c false on error */ | |
bf000c32 | 184 | virtual Bool_t ProcessSDigit(AliFMDSDigit*) { return kTRUE; } |
9f662337 | 185 | /** Process one digit from raw data files. Users should over this |
186 | to process each raw digit. | |
187 | @return @c false on error */ | |
d760ea03 | 188 | virtual Bool_t ProcessRawDigit(AliFMDDigit*) { return kTRUE; } |
9f662337 | 189 | /** Process one reconstructed point. Users should over this to |
190 | process each reconstructed point. | |
191 | @return @c false on error */ | |
bf000c32 | 192 | virtual Bool_t ProcessRecPoint(AliFMDRecPoint*) { return kTRUE; } |
9f662337 | 193 | /** Process ESD data for the FMD. Users should overload this to |
194 | deal with ESD data. | |
195 | @return @c false on error */ | |
bf000c32 | 196 | virtual Bool_t ProcessESD(AliESDFMD*) { return kTRUE; } |
197 | ||
a1f80595 | 198 | protected: |
02a27b50 | 199 | /** Copy ctor |
200 | @param o Object to copy from */ | |
b5ee4425 | 201 | AliFMDInput(const AliFMDInput& o) |
202 | : TObject(o), | |
203 | fGAliceFile(""), | |
204 | fLoader(0), | |
205 | fRun(0), | |
206 | fStack(0), | |
207 | fFMDLoader(0), | |
208 | fReader(0), | |
209 | fFMD(0), | |
210 | fMainESD(0), | |
211 | fESD(0), | |
212 | fTreeE(0), | |
213 | fTreeH(0), | |
214 | fTreeD(0), | |
215 | fTreeS(0), | |
216 | fTreeR(0), | |
217 | fTreeA(0), | |
218 | fChainE(0), | |
219 | fArrayE(0), | |
220 | fArrayH(0), | |
221 | fArrayD(0), | |
222 | fArrayS(0), | |
223 | fArrayR(0), | |
224 | fArrayA(0), | |
225 | fGeoManager(0), | |
226 | fTreeMask(0), | |
227 | fIsInit(kFALSE) | |
228 | {} | |
02a27b50 | 229 | /** Assignement operator |
230 | @return REference to this */ | |
231 | AliFMDInput& operator=(const AliFMDInput&) { return *this; } | |
232 | ||
a1f80595 | 233 | TString fGAliceFile; // File name of gAlice file |
234 | AliRunLoader* fLoader; // Loader of FMD data | |
235 | AliRun* fRun; // Run information | |
236 | AliStack* fStack; // Stack of particles | |
237 | AliLoader* fFMDLoader; // Loader of FMD data | |
d760ea03 | 238 | AliRawReader* fReader; // Raw data reader |
a1f80595 | 239 | AliFMD* fFMD; // FMD object |
bf000c32 | 240 | AliESD* fMainESD; // ESD Object |
241 | AliESDFMD* fESD; // FMD ESD data | |
a1f80595 | 242 | TTree* fTreeE; // Header tree |
243 | TTree* fTreeH; // Hits tree | |
244 | TTree* fTreeD; // Digit tree | |
245 | TTree* fTreeS; // SDigit tree | |
246 | TTree* fTreeR; // RecPoint tree | |
d760ea03 | 247 | TTree* fTreeA; // Raw data tree |
bf000c32 | 248 | TChain* fChainE; // Chain of ESD's |
a1f80595 | 249 | TClonesArray* fArrayE; // Event info array |
250 | TClonesArray* fArrayH; // Hit info array | |
251 | TClonesArray* fArrayD; // Digit info array | |
252 | TClonesArray* fArrayS; // SDigit info array | |
d760ea03 | 253 | TClonesArray* fArrayR; // Rec points info array |
254 | TClonesArray* fArrayA; // Raw data (digits) info array | |
8f6ee336 | 255 | TGeoManager* fGeoManager; // Geometry manager |
a1f80595 | 256 | Int_t fTreeMask; // Which tree's to load |
02a27b50 | 257 | Bool_t fIsInit; // Have we been initialized |
a1f80595 | 258 | ClassDef(AliFMDInput,0) //Hits for detector FMD |
259 | }; | |
260 | ||
261 | ||
a1f80595 | 262 | #endif |
263 | //____________________________________________________________________ | |
264 | // | |
265 | // Local Variables: | |
266 | // mode: C++ | |
267 | // End: | |
268 | // | |
269 | // EOF | |
270 | // |