Separating run-dependent mapping data from data, which are not
[u/mrichter/AliRoot.git] / MUON / AliMUONMCDataInterface.h
CommitLineData
1df4a03e 1#ifndef ALIMUONMCDATAINTERFACE_H
2#define ALIMUONMCDATAINTERFACE_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
9/// \ingroup sim
10/// \class AliMUONMCDataInterface
11/// \brief Easy to use data access to MC information
12///
13// Author Laurent Aphecetche
e8636ba0 14//
15// Moved parts of old AliMUONDataInterface interface to AliMUONMCDataInterface
16// Artur Szostak <artursz@iafrica.com> (University of Cape Town)
1df4a03e 17
18#ifndef ROOT_TObject
19# include "TObject.h"
20#endif
21
e9bef706 22class AliMUONVStore;
e8636ba0 23class AliMUONVHitStore;
24class AliMUONVDigitStore;
e9bef706 25class AliMUONVTriggerStore;
e8636ba0 26class AliMUONHit;
27class AliMUONVDigit;
28class AliMUONLocalTrigger;
29class AliMUONRegionalTrigger;
30class AliMUONGlobalTrigger;
31
32class AliLoader;
e9bef706 33class AliStack;
e8636ba0 34
35class TIterator;
1df4a03e 36class TClonesArray;
e8636ba0 37class TParticle;
1df4a03e 38
39class AliMUONMCDataInterface : public TObject
40{
41public:
42 AliMUONMCDataInterface(const char* filename="galice.root");
43 virtual ~AliMUONMCDataInterface();
e9bef706 44
45 void Open(const char* filename);
1df4a03e 46
e8636ba0 47 /// Returns true if the data interface was able to open the root file correctly.
48 Bool_t IsValid() const { return fIsValid; };
e9bef706 49
1df4a03e 50 Int_t NumberOfEvents() const;
e8636ba0 51 /// Returns the index number of the current event as used int GetEvent(Int_t).
52 Int_t CurrentEvent() const { return fCurrentEvent; }
53
e9bef706 54 Int_t NumberOfTracks(Int_t event);
55 Int_t NumberOfTrackRefs(Int_t event);
1df4a03e 56
e9bef706 57 AliMUONVHitStore* HitStore(Int_t event, Int_t track);
58 AliMUONVDigitStore* SDigitStore(Int_t event);
59 AliMUONVDigitStore* DigitStore(Int_t event);
e8636ba0 60 AliStack* Stack(Int_t event);
e9bef706 61 TClonesArray* TrackRefs(Int_t event, Int_t track);
62 AliMUONVTriggerStore* TriggerStore(Int_t event);
1df4a03e 63
e9bef706 64 void DumpDigits(Int_t event, Bool_t sorted=kTRUE);
65 void DumpSDigits(Int_t event, Bool_t sorted=kTRUE);
66 void DumpHits(Int_t event);
67 void DumpKine(Int_t event);
68 void DumpTrackRefs(Int_t event);
69 void DumpTrigger(Int_t event);
1df4a03e 70
e8636ba0 71 Bool_t GetEvent(Int_t event = 0);
72
73 // Note the following methods can be extremely slow. Remember they are only
74 // here for end user convenience for his/her small tests and macros.
75 // If you want speed then don't use these methods. If you really want peak
76 // performance then you should be talking to the AliRunLoader and Store
77 // objects directly.
78 Int_t NumberOfParticles();
79 TParticle* Particle(Int_t index);
80 Int_t NumberOfTracks();
81 Int_t NumberOfHits(Int_t track);
82 AliMUONHit* Hit(Int_t track, Int_t index);
83 Int_t NumberOfSDigits(Int_t detElemId);
84 AliMUONVDigit* SDigit(Int_t detElemId, Int_t index);
85 Int_t NumberOfSDigits(Int_t chamber, Int_t cathode);
86 AliMUONVDigit* SDigit(Int_t chamber, Int_t cathode, Int_t index);
87 Int_t NumberOfDigits(Int_t detElemId);
88 AliMUONVDigit* Digit(Int_t detElemId, Int_t index);
89 Int_t NumberOfDigits(Int_t chamber, Int_t cathode);
90 AliMUONVDigit* Digit(Int_t chamber, Int_t cathode, Int_t index);
91 Int_t NumberOfLocalTriggers();
92 AliMUONLocalTrigger* LocalTrigger(Int_t index);
93 Int_t NumberOfRegionalTriggers();
94 AliMUONRegionalTrigger* RegionalTrigger(Int_t index);
95 AliMUONGlobalTrigger* GlobalTrigger();
96 Int_t NumberOfTrackRefs();
97 TClonesArray* TrackRefs(Int_t track);
98
1df4a03e 99private:
e8636ba0 100
44c98559 101 /// The various identifiers for the type of iterator constructed.
e8636ba0 102 enum IteratorType
103 {
44c98559 104 kNoIterator, ///< No iterator was constructed.
105 kHitIterator, ///< An iterator to iterate over the hits.
106 kSDigitIteratorByDetectorElement, ///< A summable digit iterator to iterate over the detector elements.
107 kSDigitIteratorByChamberAndCathode, ///< A summable digit iterator to iterate over chambers and cathodes.
108 kDigitIteratorByDetectorElement, ///< An iterator for simulated digits to iterate over the detector elements.
109 kDigitIteratorByChamberAndCathode, ///< An iterator for simulated digits to iterate over chambers and cathodes.
110 kLocalTriggerIterator, ///< An iterator for iterating over the simulated local triggers.
111 kRegionalTriggerIterator ///< An iterator for iterating over the simulated regional triggers.
e8636ba0 112 };
113
1df4a03e 114 /// Not implemented
115 AliMUONMCDataInterface(const AliMUONMCDataInterface&);
116 /// Not implemented
117 AliMUONMCDataInterface& operator=(const AliMUONMCDataInterface&);
118
e9bef706 119 void DumpSorted(const AliMUONVStore& store) const;
e8636ba0 120 Bool_t LoadEvent(Int_t event);
121
122 void ResetStores();
123
124 TIterator* GetIterator(IteratorType type, Int_t x = 0, Int_t y = 0);
125 void ResetIterator();
126
127 Int_t CountObjects(TIterator* iter);
128 TObject* FetchObject(TIterator* iter, Int_t index);
e9bef706 129
1df4a03e 130
e9bef706 131 AliLoader* fLoader; //!< Tree accessor
132 AliMUONVHitStore* fHitStore; //!< current hit store (owner)
133 AliMUONVDigitStore* fSDigitStore; //!< current sdigit store (owner)
134 AliMUONVDigitStore* fDigitStore; //!< current digit store (owner)
135 AliMUONVTriggerStore* fTriggerStore; //!< current trigger store (owner)
136 TClonesArray* fTrackRefs; //!< current trackrefs (owner)
137 Int_t fCurrentEvent; //!< Current event we've read in
138 Bool_t fIsValid; //!< whether we were initialized properly or not
1df4a03e 139
e8636ba0 140 IteratorType fCurrentIteratorType; //!< The type of iterator that is currently set.
141 Int_t fCurrentIndex; //!< A current index number maintained for certain iteration operations.
142 Int_t fDataX; //!< Extra data parameter about the iterator, can be the chamber number, detector element or track number.
143 Int_t fDataY; //!< Extra data parameter about the iterator, can be the cathode number.
144 TIterator* fIterator; //!< Iterator for various iteration operations.
145
e9bef706 146 static Int_t fgInstanceCounter; //!< To build unique folder name for each instance
147
1df4a03e 148 ClassDef(AliMUONMCDataInterface,0) // Easy to use MC data accessor
149};
150
151#endif