Compilation warnings
[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
08d168d9 117 kTracks, // Hits and tracs - for BG study
118 kTrackRefs // Track references - also for BG study
a1f80595 119 };
9f662337 120 /** CTOR */
a1f80595 121 AliFMDInput();
9f662337 122 /** CTOR
123 @param gAliceFile galice file */
a1f80595 124 AliFMDInput(const char* gAliceFile);
9f662337 125 /** DTOR */
a1f80595 126 virtual ~AliFMDInput() {}
127
9f662337 128 /** Add a data type to load
129 @param tree Data to load */
a1f80595 130 virtual void AddLoad(ETrees tree) { SETBIT(fTreeMask, tree); }
9f662337 131 /** Remove a data type to load
132 @param tree Data to @e not load */
a1f80595 133 virtual void RemoveLoad(ETrees tree) { CLRBIT(fTreeMask, tree); }
9f662337 134 /** @return # of available events */
a1f80595 135 virtual Int_t NEvents() const;
136
9f662337 137 /** Initialize the class. If a user class overloads this member
138 function, then this @e must be explicitly called
139 @return @c false on error */
a1f80595 140 virtual Bool_t Init();
9f662337 141 /** Callled at the beginning of each event. If a user class
142 overloads this member function, then this @e must be explicitly
143 called.
144 @param event Event number
145 @return @c false on error */
a1f80595 146 virtual Bool_t Begin(Int_t event);
9f662337 147 /** Process one event. This loops over all the loaded data. Users
148 can overload this member function, but then it's @e strongly
149 recommended to explicitly call this classes version.
150 @return @c false on error */
bf000c32 151 virtual Bool_t Event();
9f662337 152 /** Called at the end of each event.
153 @return @c false on error */
a1f80595 154 virtual Bool_t End();
9f662337 155 /** Called at the end of the run.
156 @return @c false on error */
a1f80595 157 virtual Bool_t Finish() { return kTRUE; }
9f662337 158 /** Run a full job.
159 @return @c false on error */
a1f80595 160 virtual Bool_t Run();
bf000c32 161
9f662337 162 /** Loop over all hits, and call ProcessHit with that hit, and
163 optionally the corresponding kinematics track.
164 @return @c false on error */
bf000c32 165 virtual Bool_t ProcessHits();
08d168d9 166 /** Loop over all track refs, and call ProcessTrackRef with that hit, and
167 optionally the corresponding kinematics track.
168 @return @c false on error */
169 virtual Bool_t ProcessTrackRefs();
f95a63c4 170 /** Loop over all tracks, and call ProcessTrack with each hit for
171 that track
172 @return @c false on error */
173 virtual Bool_t ProcessTracks();
9f662337 174 /** Loop over all digits, and call ProcessDigit for each digit.
175 @return @c false on error */
bf000c32 176 virtual Bool_t ProcessDigits();
9f662337 177 /** Loop over all summable digits, and call ProcessSDigit for each
178 digit.
179 @return @c false on error */
bf000c32 180 virtual Bool_t ProcessSDigits();
9f662337 181 /** Loop over all digits read from raw data files, and call
182 ProcessRawDigit for each digit.
183 @return @c false on error */
d760ea03 184 virtual Bool_t ProcessRawDigits();
9f662337 185 /** Loop over all reconstructed points, and call ProcessRecPoint for
186 each reconstructed point.
187 @return @c false on error */
bf000c32 188 virtual Bool_t ProcessRecPoints();
a9579262 189 /** Loop over all ESD data, and call ProcessESD for each entry.
190 @return @c false on error */
191 virtual Bool_t ProcessESDs();
bf000c32 192
9f662337 193 /** Process one hit, and optionally it's corresponding kinematics
194 track. Users should over this to process each hit.
a9579262 195 @param h Hit
196 @param p Associated track
9f662337 197 @return @c false on error */
a9579262 198 virtual Bool_t ProcessHit(AliFMDHit* h, TParticle* p);
08d168d9 199 /** Process one track reference, and optionally it's corresponding kinematics
200 track. Users should overload this to process each track reference.
201 @param trackRef Track Reference
202 @param track Associated track
203 @return @c false on error */
204 virtual Bool_t ProcessTrackRef(AliTrackReference* trackRef, TParticle* track);
f95a63c4 205 /** Process one hit per track. Users should over this to process
206 each hit.
207 @param i Track number
208 @param p Track
209 @param h Associated Hit
210 @return @c false on error */
211 virtual Bool_t ProcessTrack(Int_t i, TParticle* p, AliFMDHit* h);
a9579262 212 /** Process one digit. Users should over this to process each
213 digit.
214 @param digit Digit
9f662337 215 @return @c false on error */
a9579262 216 virtual Bool_t ProcessDigit(AliFMDDigit* digit);
9f662337 217 /** Process one summable digit. Users should over this to process
218 each summable digit.
a9579262 219 @param sdigit Summable digit
9f662337 220 @return @c false on error */
a9579262 221 virtual Bool_t ProcessSDigit(AliFMDSDigit* sdigit);
9f662337 222 /** Process one digit from raw data files. Users should over this
223 to process each raw digit.
a9579262 224 @param digit Raw digit
9f662337 225 @return @c false on error */
a9579262 226 virtual Bool_t ProcessRawDigit(AliFMDDigit* digit);
9f662337 227 /** Process one reconstructed point. Users should over this to
228 process each reconstructed point.
a9579262 229 @param point Reconstructed point
9f662337 230 @return @c false on error */
a9579262 231 virtual Bool_t ProcessRecPoint(AliFMDRecPoint* point);
9f662337 232 /** Process ESD data for the FMD. Users should overload this to
233 deal with ESD data.
a9579262 234 @param d Detector number (1-3)
235 @param r Ring identifier ('I' or 'O')
236 @param s Sector number (0-19, or 0-39)
237 @param t Strip number (0-511, or 0-255)
238 @param eta Psuedo-rapidity
239 @param mult Psuedo-multiplicity
9f662337 240 @return @c false on error */
a9579262 241 virtual Bool_t ProcessESD(UShort_t, Char_t, UShort_t, UShort_t,
242 Float_t, Float_t);
69893a66 243 /** Service function to make a logarithmic axis.
244 @param n Number of bins
245 @param min Minimum of axis
246 @param max Maximum of axis.
247 @return An array with the bin boundaries. */
248 static TArrayF MakeLogScale(Int_t n, Double_t min, Double_t max);
039842fe 249
250 /** Set the raw data input
251 @param file File name - if empty, assume simulated raw. */
252 void SetRawFile(const char* file) { if (file) fRawFile = file; }
253
a1f80595 254protected:
02a27b50 255 /** Copy ctor
256 @param o Object to copy from */
b5ee4425 257 AliFMDInput(const AliFMDInput& o)
42f1b2f5 258 : TNamed(o),
b5ee4425 259 fGAliceFile(""),
260 fLoader(0),
261 fRun(0),
262 fStack(0),
263 fFMDLoader(0),
264 fReader(0),
5cf05dbb 265 fFMDReader(0),
b5ee4425 266 fFMD(0),
b5ee4425 267 fESD(0),
df137876 268 fESDEvent(0),
b5ee4425 269 fTreeE(0),
270 fTreeH(0),
08d168d9 271 fTreeTR(0),
b5ee4425 272 fTreeD(0),
273 fTreeS(0),
274 fTreeR(0),
275 fTreeA(0),
276 fChainE(0),
277 fArrayE(0),
278 fArrayH(0),
08d168d9 279 fArrayTR(0),
b5ee4425 280 fArrayD(0),
281 fArrayS(0),
282 fArrayR(0),
283 fArrayA(0),
17e542eb 284 fHeader(0),
b5ee4425 285 fGeoManager(0),
286 fTreeMask(0),
6ce810fc 287 fRawFile(""),
17e542eb 288 fIsInit(kFALSE),
289 fEventCount(0)
b5ee4425 290 {}
02a27b50 291 /** Assignement operator
292 @return REference to this */
293 AliFMDInput& operator=(const AliFMDInput&) { return *this; }
294
5cf05dbb 295 TString fGAliceFile; // File name of gAlice file
296 AliRunLoader* fLoader; // Loader of FMD data
297 AliRun* fRun; // Run information
298 AliStack* fStack; // Stack of particles
299 AliLoader* fFMDLoader; // Loader of FMD data
300 AliRawReader* fReader; // Raw data reader
301 AliFMDRawReader* fFMDReader; // FMD raw reader
302 AliFMD* fFMD; // FMD object
303 AliESDFMD* fESD; // FMD ESD data
304 AliESDEvent* fESDEvent; // ESD Event object.
305 TTree* fTreeE; // Header tree
306 TTree* fTreeH; // Hits tree
08d168d9 307 TTree* fTreeTR; // Track Reference tree
5cf05dbb 308 TTree* fTreeD; // Digit tree
309 TTree* fTreeS; // SDigit tree
310 TTree* fTreeR; // RecPoint tree
311 TTree* fTreeA; // Raw data tree
312 TChain* fChainE; // Chain of ESD's
313 TClonesArray* fArrayE; // Event info array
314 TClonesArray* fArrayH; // Hit info array
08d168d9 315 TClonesArray* fArrayTR; // Hit info array
5cf05dbb 316 TClonesArray* fArrayD; // Digit info array
317 TClonesArray* fArrayS; // SDigit info array
318 TClonesArray* fArrayR; // Rec points info array
319 TClonesArray* fArrayA; // Raw data (digits) info array
320 AliHeader* fHeader; // Header
321 TGeoManager* fGeoManager; // Geometry manager
322 Int_t fTreeMask; // Which tree's to load
323 TString fRawFile; // Raw input file
324 Bool_t fIsInit; // Have we been initialized
325 Int_t fEventCount; // Event counter
a1f80595 326 ClassDef(AliFMDInput,0) //Hits for detector FMD
327};
328
a9579262 329inline Bool_t AliFMDInput::ProcessHit(AliFMDHit*,TParticle*) { return kTRUE; }
faf80567 330inline Bool_t AliFMDInput::ProcessTrackRef(AliTrackReference*,
331 TParticle*) { return kTRUE; }
f95a63c4 332inline Bool_t AliFMDInput::ProcessTrack(Int_t,TParticle*,
333 AliFMDHit*) { return kTRUE; }
a9579262 334inline Bool_t AliFMDInput::ProcessDigit(AliFMDDigit*) { return kTRUE; }
335inline Bool_t AliFMDInput::ProcessSDigit(AliFMDSDigit*) { return kTRUE; }
336inline Bool_t AliFMDInput::ProcessRawDigit(AliFMDDigit*) { return kTRUE; }
337inline Bool_t AliFMDInput::ProcessRecPoint(AliFMDRecPoint*) { return kTRUE; }
338inline Bool_t AliFMDInput::ProcessESD(UShort_t,Char_t,UShort_t,UShort_t,
339 Float_t,Float_t) { return kTRUE; }
340
a1f80595 341
a1f80595 342#endif
343//____________________________________________________________________
344//
345// Local Variables:
346// mode: C++
347// End:
348//
349// EOF
350//