bug fix
[u/mrichter/AliRoot.git] / FMD / AliFMDInput.h
CommitLineData
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*/
42f1b2f5 29#include <TNamed.h>
a1f80595 30#ifndef ROOT_TString
31# include <TString.h>
32#endif
7003fbd0 33#ifndef ROOT_TArrayF
34# include <TArrayF.h>
35#endif
08d168d9 36class AliTrackReference;
8f6ee336 37class AliRunLoader;
38class AliLoader;
39class AliStack;
40class AliRun;
d760ea03 41class AliRawReader;
5cf05dbb 42class AliFMDRawReader;
8f6ee336 43class AliFMD;
44class AliFMDHit;
bf000c32 45class AliFMDDigit;
46class AliFMDSDigit;
47class AliFMDRecPoint;
df137876 48class AliESDEvent;
bf000c32 49class AliESDFMD;
9b98d361 50class AliHeader;
8f6ee336 51class TString;
52class TClonesArray;
53class TTree;
54class TGeoManager;
55class TParticle;
bf000c32 56class TChain;
a1f80595 57
58//___________________________________________________________________
9f662337 59/** @class AliFMDInput
60 @brief Base class for reading in various FMD data.
61 The class loops over all found events. For each event the
62 specified data is read in. The class then loops over all
63 elements of the read data, and process these with user defined
64 code.
65 @code
66 struct DigitInput : public AliFMDInput
67 {
68 DigitInput()
69 {
70 // Load digits
71 AddLoad(kDigits);
72 // Make a histogram
73 fHist = new TH1F("adc", "ADC spectra", 1024, -.5, 1023.5);
74 }
75 // Process one digit.
76 Bool_t ProcessDigit(AliFMDDigit* d)
77 {
78 fHist->Fill(d->Counts());
79 return kTRUE;
80 }
81 // After processing all events, display spectrum
82 Bool_t Finish()
83 {
84 fHist->Draw();
85 }
86 TH1F* fHist;
87 };
88
89 void AdcSpectrum()
90 {
91 DigitInput di;
92 di.Run();
93 }
94 @endcode
95 This class allows for writing small scripts, that can be compiled
96 with AcLIC, to do all sorts of tests, quick prototyping, and so
97 on. It has proven to be quiet useful. One can load more than
98 one type of data in one derived class, to for example to make
99 comparisons between hits and reconstructed points. See also the
100 various scripts in @c FMD/scripts.
101 @ingroup FMD_util
102 */
42f1b2f5 103class AliFMDInput : public TNamed
a1f80595 104{
105public:
9f662337 106 /** The kinds of data that can be read in. */
a1f80595 107 enum ETrees {
8f6ee336 108 kHits = 1, // Hits
109 kKinematics, // Kinematics (from sim)
110 kDigits, // Digits
111 kSDigits, // Summable digits
112 kHeader, // Header information
113 kRecPoints, // Reconstructed points
bf000c32 114 kESD, // Load ESD's
d760ea03 115 kRaw, // Read raw data
f95a63c4 116 kGeometry, // Not really a tree
e064ab4a 117 kTrackRefs, // Track references - also for BG study
506dc39d 118 kRawCalib, // Read raws and calibrate them
119 kUser
a1f80595 120 };
9f662337 121 /** CTOR */
a1f80595 122 AliFMDInput();
9f662337 123 /** CTOR
124 @param gAliceFile galice file */
a1f80595 125 AliFMDInput(const char* gAliceFile);
9f662337 126 /** DTOR */
a1f80595 127 virtual ~AliFMDInput() {}
128
9f662337 129 /** Add a data type to load
130 @param tree Data to load */
a1f80595 131 virtual void AddLoad(ETrees tree) { SETBIT(fTreeMask, tree); }
9f662337 132 /** Remove a data type to load
133 @param tree Data to @e not load */
a1f80595 134 virtual void RemoveLoad(ETrees tree) { CLRBIT(fTreeMask, tree); }
9f662337 135 /** @return # of available events */
a1f80595 136 virtual Int_t NEvents() const;
137
9f662337 138 /** Initialize the class. If a user class overloads this member
139 function, then this @e must be explicitly called
140 @return @c false on error */
a1f80595 141 virtual Bool_t Init();
9f662337 142 /** Callled at the beginning of each event. If a user class
143 overloads this member function, then this @e must be explicitly
144 called.
145 @param event Event number
146 @return @c false on error */
a1f80595 147 virtual Bool_t Begin(Int_t event);
9f662337 148 /** Process one event. This loops over all the loaded data. Users
149 can overload this member function, but then it's @e strongly
150 recommended to explicitly call this classes version.
151 @return @c false on error */
bf000c32 152 virtual Bool_t Event();
9f662337 153 /** Called at the end of each event.
154 @return @c false on error */
a1f80595 155 virtual Bool_t End();
9f662337 156 /** Called at the end of the run.
157 @return @c false on error */
a1f80595 158 virtual Bool_t Finish() { return kTRUE; }
9f662337 159 /** Run a full job.
160 @return @c false on error */
a1f80595 161 virtual Bool_t Run();
bf000c32 162
9f662337 163 /** Loop over all hits, and call ProcessHit with that hit, and
164 optionally the corresponding kinematics track.
165 @return @c false on error */
bf000c32 166 virtual Bool_t ProcessHits();
08d168d9 167 /** Loop over all track refs, and call ProcessTrackRef with that hit, and
168 optionally the corresponding kinematics track.
169 @return @c false on error */
170 virtual Bool_t ProcessTrackRefs();
f95a63c4 171 /** Loop over all tracks, and call ProcessTrack with each hit for
172 that track
173 @return @c false on error */
174 virtual Bool_t ProcessTracks();
5632c898 175 /** Loop over all tracks, and call ProcessTrack with each hit for
176 that track
177 @return @c false on error */
178 virtual Bool_t ProcessStack();
9f662337 179 /** Loop over all digits, and call ProcessDigit for each digit.
180 @return @c false on error */
bf000c32 181 virtual Bool_t ProcessDigits();
9f662337 182 /** Loop over all summable digits, and call ProcessSDigit for each
183 digit.
184 @return @c false on error */
bf000c32 185 virtual Bool_t ProcessSDigits();
9f662337 186 /** Loop over all digits read from raw data files, and call
187 ProcessRawDigit for each digit.
188 @return @c false on error */
d760ea03 189 virtual Bool_t ProcessRawDigits();
e064ab4a 190 /** Loop over all digits read from raw data files, and call
191 ProcessRawDigit for each digit.
192 @return @c false on error */
193 virtual Bool_t ProcessRawCalibDigits();
9f662337 194 /** Loop over all reconstructed points, and call ProcessRecPoint for
195 each reconstructed point.
196 @return @c false on error */
bf000c32 197 virtual Bool_t ProcessRecPoints();
a9579262 198 /** Loop over all ESD data, and call ProcessESD for each entry.
199 @return @c false on error */
200 virtual Bool_t ProcessESDs();
506dc39d 201 /** Loop over all strips and ask user routine to supply the data.
202 @return @c false on error */
203 virtual Bool_t ProcessUsers();
bf000c32 204
9f662337 205 /** Process one hit, and optionally it's corresponding kinematics
206 track. Users should over this to process each hit.
a9579262 207 @param h Hit
208 @param p Associated track
9f662337 209 @return @c false on error */
a9579262 210 virtual Bool_t ProcessHit(AliFMDHit* h, TParticle* p);
08d168d9 211 /** Process one track reference, and optionally it's corresponding kinematics
212 track. Users should overload this to process each track reference.
213 @param trackRef Track Reference
214 @param track Associated track
215 @return @c false on error */
216 virtual Bool_t ProcessTrackRef(AliTrackReference* trackRef, TParticle* track);
f95a63c4 217 /** Process one hit per track. Users should over this to process
218 each hit.
219 @param i Track number
220 @param p Track
221 @param h Associated Hit
222 @return @c false on error */
223 virtual Bool_t ProcessTrack(Int_t i, TParticle* p, AliFMDHit* h);
5632c898 224 /** Process stack particle
225 @param i Track number
226 @param p Track
227 @return @c false on error */
228 virtual Bool_t ProcessParticle(Int_t i , TParticle* p);
a9579262 229 /** Process one digit. Users should over this to process each
230 digit.
231 @param digit Digit
9f662337 232 @return @c false on error */
a9579262 233 virtual Bool_t ProcessDigit(AliFMDDigit* digit);
9f662337 234 /** Process one summable digit. Users should over this to process
235 each summable digit.
a9579262 236 @param sdigit Summable digit
9f662337 237 @return @c false on error */
a9579262 238 virtual Bool_t ProcessSDigit(AliFMDSDigit* sdigit);
9f662337 239 /** Process one digit from raw data files. Users should over this
240 to process each raw digit.
a9579262 241 @param digit Raw digit
9f662337 242 @return @c false on error */
a9579262 243 virtual Bool_t ProcessRawDigit(AliFMDDigit* digit);
e064ab4a 244 /** Process one digit from raw data files. Users should over this
245 to process each raw digit.
246 @param digit Raw digit
247 @return @c false on error */
248 virtual Bool_t ProcessRawCalibDigit(AliFMDDigit* digit);
9f662337 249 /** Process one reconstructed point. Users should over this to
250 process each reconstructed point.
a9579262 251 @param point Reconstructed point
9f662337 252 @return @c false on error */
a9579262 253 virtual Bool_t ProcessRecPoint(AliFMDRecPoint* point);
9f662337 254 /** Process ESD data for the FMD. Users should overload this to
255 deal with ESD data.
a9579262 256 @param d Detector number (1-3)
257 @param r Ring identifier ('I' or 'O')
258 @param s Sector number (0-19, or 0-39)
259 @param t Strip number (0-511, or 0-255)
260 @param eta Psuedo-rapidity
261 @param mult Psuedo-multiplicity
9f662337 262 @return @c false on error */
506dc39d 263 virtual Bool_t ProcessESD(UShort_t d, Char_t r, UShort_t s, UShort_t t,
264 Float_t eta, Float_t mult);
265 /** Process User data for the FMD. Users should overload this to
266 deal with ESD data.
267 @param d Detector number (1-3)
268 @param r Ring identifier ('I' or 'O')
269 @param s Sector number (0-19, or 0-39)
270 @param t Strip number (0-511, or 0-255)
271 @param v Value
272 @return @c false on error */
273 virtual Bool_t ProcessUser(UShort_t d, Char_t r, UShort_t s, UShort_t t,
274 Float_t v);
69893a66 275 /** Service function to make a logarithmic axis.
276 @param n Number of bins
277 @param min Minimum of axis
278 @param max Maximum of axis.
279 @return An array with the bin boundaries. */
280 static TArrayF MakeLogScale(Int_t n, Double_t min, Double_t max);
039842fe 281
282 /** Set the raw data input
283 @param file File name - if empty, assume simulated raw. */
284 void SetRawFile(const char* file) { if (file) fRawFile = file; }
285
a1f80595 286protected:
02a27b50 287 /** Copy ctor
288 @param o Object to copy from */
b5ee4425 289 AliFMDInput(const AliFMDInput& o)
42f1b2f5 290 : TNamed(o),
b5ee4425 291 fGAliceFile(""),
292 fLoader(0),
293 fRun(0),
294 fStack(0),
295 fFMDLoader(0),
296 fReader(0),
5cf05dbb 297 fFMDReader(0),
b5ee4425 298 fFMD(0),
b5ee4425 299 fESD(0),
df137876 300 fESDEvent(0),
b5ee4425 301 fTreeE(0),
302 fTreeH(0),
08d168d9 303 fTreeTR(0),
b5ee4425 304 fTreeD(0),
305 fTreeS(0),
306 fTreeR(0),
307 fTreeA(0),
308 fChainE(0),
309 fArrayE(0),
310 fArrayH(0),
08d168d9 311 fArrayTR(0),
b5ee4425 312 fArrayD(0),
313 fArrayS(0),
314 fArrayR(0),
315 fArrayA(0),
17e542eb 316 fHeader(0),
b5ee4425 317 fGeoManager(0),
318 fTreeMask(0),
6ce810fc 319 fRawFile(""),
17e542eb 320 fIsInit(kFALSE),
321 fEventCount(0)
b5ee4425 322 {}
02a27b50 323 /** Assignement operator
324 @return REference to this */
325 AliFMDInput& operator=(const AliFMDInput&) { return *this; }
506dc39d 326 /**
327 * Get user supplued data
328 *
329 * @param d Detector
330 * @param r Ring
331 * @param s Sector
332 * @param t Strip
333 *
334 * @return Value
335 */
336 virtual Float_t GetSignal(UShort_t d, Char_t r, UShort_t s, UShort_t t);
02a27b50 337
5cf05dbb 338 TString fGAliceFile; // File name of gAlice file
339 AliRunLoader* fLoader; // Loader of FMD data
340 AliRun* fRun; // Run information
341 AliStack* fStack; // Stack of particles
342 AliLoader* fFMDLoader; // Loader of FMD data
343 AliRawReader* fReader; // Raw data reader
344 AliFMDRawReader* fFMDReader; // FMD raw reader
345 AliFMD* fFMD; // FMD object
346 AliESDFMD* fESD; // FMD ESD data
347 AliESDEvent* fESDEvent; // ESD Event object.
348 TTree* fTreeE; // Header tree
349 TTree* fTreeH; // Hits tree
08d168d9 350 TTree* fTreeTR; // Track Reference tree
5cf05dbb 351 TTree* fTreeD; // Digit tree
352 TTree* fTreeS; // SDigit tree
353 TTree* fTreeR; // RecPoint tree
354 TTree* fTreeA; // Raw data tree
355 TChain* fChainE; // Chain of ESD's
356 TClonesArray* fArrayE; // Event info array
357 TClonesArray* fArrayH; // Hit info array
08d168d9 358 TClonesArray* fArrayTR; // Hit info array
5cf05dbb 359 TClonesArray* fArrayD; // Digit info array
360 TClonesArray* fArrayS; // SDigit info array
361 TClonesArray* fArrayR; // Rec points info array
362 TClonesArray* fArrayA; // Raw data (digits) info array
363 AliHeader* fHeader; // Header
364 TGeoManager* fGeoManager; // Geometry manager
365 Int_t fTreeMask; // Which tree's to load
366 TString fRawFile; // Raw input file
367 Bool_t fIsInit; // Have we been initialized
368 Int_t fEventCount; // Event counter
a1f80595 369 ClassDef(AliFMDInput,0) //Hits for detector FMD
370};
371
a9579262 372inline Bool_t AliFMDInput::ProcessHit(AliFMDHit*,TParticle*) { return kTRUE; }
faf80567 373inline Bool_t AliFMDInput::ProcessTrackRef(AliTrackReference*,
374 TParticle*) { return kTRUE; }
f95a63c4 375inline Bool_t AliFMDInput::ProcessTrack(Int_t,TParticle*,
376 AliFMDHit*) { return kTRUE; }
5632c898 377inline Bool_t AliFMDInput::ProcessParticle(Int_t,TParticle*) { return kTRUE; }
a9579262 378inline Bool_t AliFMDInput::ProcessDigit(AliFMDDigit*) { return kTRUE; }
379inline Bool_t AliFMDInput::ProcessSDigit(AliFMDSDigit*) { return kTRUE; }
380inline Bool_t AliFMDInput::ProcessRawDigit(AliFMDDigit*) { return kTRUE; }
e064ab4a 381inline Bool_t AliFMDInput::ProcessRawCalibDigit(AliFMDDigit*) { return kTRUE; }
a9579262 382inline Bool_t AliFMDInput::ProcessRecPoint(AliFMDRecPoint*) { return kTRUE; }
383inline Bool_t AliFMDInput::ProcessESD(UShort_t,Char_t,UShort_t,UShort_t,
384 Float_t,Float_t) { return kTRUE; }
506dc39d 385inline Bool_t AliFMDInput::ProcessUser(UShort_t,Char_t,UShort_t,UShort_t,
386 Float_t) { return kTRUE; }
387inline Float_t AliFMDInput::GetSignal(UShort_t, Char_t, UShort_t, UShort_t) {
388 return 0.; }
a9579262 389
a1f80595 390
a1f80595 391#endif
392//____________________________________________________________________
393//
394// Local Variables:
395// mode: C++
396// End:
397//
398// EOF
399//