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