merge
[u/mrichter/AliRoot.git] / STEER / AOD / AliAODEvent.h
1 #ifndef AliAODEvent_H
2 #define AliAODEvent_H
3 /* Copyright(c) 1998-2007, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id$ */
7
8 //-------------------------------------------------------------------------
9 //     AOD base class
10 //     Author: Markus Oldenburg, CERN
11 //-------------------------------------------------------------------------
12
13 #include <TBuffer.h>
14 #include <TClonesArray.h>
15 #include <TList.h>
16 #include <TTree.h>
17 #include <TNamed.h>
18
19 #include "AliVEvent.h"
20 #include "AliVParticle.h"
21 #include "AliAODHeader.h"
22 #include "AliAODTrack.h"
23 #include "AliAODVertex.h"
24 #include "AliAODv0.h"
25 #include "AliAODcascade.h"
26 #include "AliAODTracklets.h"
27 #include "AliAODJet.h"
28 #include "AliAODCaloCells.h"
29 #include "AliAODCaloCluster.h"
30 #include "AliAODCaloTrigger.h"
31 #include "AliAODPmdCluster.h"
32 #include "AliAODFmdCluster.h"
33 #include "AliAODDimuon.h"
34 #include "AliAODTZERO.h"
35 #include "AliAODVZERO.h"
36 #include "AliAODHMPIDrings.h"
37 #include "AliAODZDC.h"
38 #include "AliAODTrdTrack.h"
39
40 class TTree;
41 class TFolder;
42 class AliCentrality;
43 class AliEventplane;
44
45 class AliAODEvent : public AliVEvent {
46
47  public :
48   enum AODListIndex_t {kAODHeader,
49                        kAODTracks,
50                        kAODVertices,
51                        kAODv0,
52                        kAODcascade,
53                        kAODTracklets,
54                        kAODJets,
55                        kAODEmcalCells,
56                        kAODPhosCells,
57                        kAODCaloClusters,
58                    kAODEMCALTrigger,
59                    kAODPHOSTrigger,
60                        kAODFmdClusters,
61                        kAODPmdClusters,
62                        kAODHMPIDrings,
63                        kAODDimuons,
64                        kAODTZERO,
65                        kAODVZERO,
66                        kAODZDC,
67                        kTOFHeader,                       
68                        kAODTrdTracks,
69                        kAODListN
70   };
71
72   AliAODEvent();
73   virtual ~AliAODEvent();
74
75   AliAODEvent(const AliAODEvent& aodevent);
76   AliAODEvent& operator=(const AliAODEvent& aodevent);
77
78   void          AddObject(TObject *obj);
79   void          RemoveObject(TObject *obj);
80   TObject      *FindListObject(const char *objName) const;
81   TList        *GetList()                const { return fAODObjects; }
82   void          SetConnected(Bool_t conn=kTRUE) {fConnected=conn;}
83   Bool_t        GetConnected() const {return fConnected;}
84   Bool_t        AreTracksConnected() const {return fTracksConnected;}
85
86   // -- Header
87   AliAODHeader *GetHeader()              const { return fHeader; }
88   void          AddHeader(const AliAODHeader* hdx)
89     {
90         delete fHeader; fHeader = new AliAODHeader(*hdx);
91         (fAODObjects->FirstLink())->SetObject(fHeader);
92     }
93
94   virtual  Bool_t InitMagneticField() const {return fHeader ? fHeader->InitMagneticField() : kFALSE;}
95
96   // setters and getters for header information
97   void     SetRunNumber(Int_t n) {if (fHeader) fHeader->SetRunNumber(n);}
98   void     SetPeriodNumber(UInt_t n){if (fHeader) fHeader->SetPeriodNumber(n);}
99   void     SetOrbitNumber(UInt_t n) {if (fHeader) fHeader->SetOrbitNumber(n);}
100   void     SetBunchCrossNumber(UShort_t n) {if (fHeader) fHeader->SetBunchCrossNumber(n);}
101   void     SetMagneticField(Double_t mf){if (fHeader) fHeader->SetMagneticField(mf);}
102   void     SetMuonMagFieldScale(Double_t mf){if (fHeader) fHeader->SetMuonMagFieldScale(mf);}
103   void     SetDiamond(Float_t xy[2],Float_t cov[3]){if (fHeader) fHeader->SetDiamond(xy,cov);}
104   void     SetDiamondZ(Float_t z, Float_t sig2z){if (fHeader) fHeader->SetDiamondZ(z,sig2z);}
105   Int_t    GetRunNumber() const {return fHeader ? fHeader->GetRunNumber() : -999;}
106   UInt_t   GetPeriodNumber() const {return fHeader ? fHeader->GetPeriodNumber() : 0;}
107   UInt_t   GetOrbitNumber() const {return fHeader ? fHeader->GetOrbitNumber() : 0;}
108   UShort_t GetBunchCrossNumber() const {return fHeader ? fHeader->GetBunchCrossNumber() : 0;}
109   Double_t GetMagneticField() const {return fHeader ? fHeader->GetMagneticField() : -999.;}
110   Double_t GetMuonMagFieldScale() const {return fHeader ? fHeader->GetMuonMagFieldScale() : -999.;}
111   Double_t GetDiamondX() const {return fHeader ? fHeader->GetDiamondX() : -999.;}
112   Double_t GetDiamondY() const {return fHeader ? fHeader->GetDiamondY() : -999.;}
113   Double_t GetDiamondZ() const {return fHeader ? fHeader->GetDiamondZ() : -999.;}
114   void     GetDiamondCovXY(Float_t cov[3]) const {cov[0]=-999.; if(fHeader) fHeader->GetDiamondCovXY(cov);}
115   Double_t GetSigma2DiamondX() const {return fHeader ? fHeader->GetSigma2DiamondX() : -999.;}
116   Double_t GetSigma2DiamondY() const {return fHeader ? fHeader->GetSigma2DiamondY() : -999.;}
117   Double_t GetSigma2DiamondZ() const {return fHeader ? fHeader->GetSigma2DiamondZ() : -999.;}
118   
119   void      SetEventType(UInt_t eventType){fHeader->SetEventType(eventType);}
120   void      SetTriggerMask(ULong64_t n) {fHeader->SetTriggerMask(n);}
121   void      SetTriggerCluster(UChar_t n) {fHeader->SetTriggerCluster(n);}
122
123   UInt_t    GetEventType()          const { return fHeader ? fHeader->GetEventType() : 0;}
124   ULong64_t GetTriggerMask()        const { return fHeader ? fHeader->GetTriggerMask() : 0;}
125   UChar_t   GetTriggerCluster()     const { return fHeader ? fHeader->GetTriggerCluster() : 0;}
126   TString   GetFiredTriggerClasses()const { return fHeader->GetFiredTriggerClasses();};
127   Double_t  GetZDCN1Energy()        const { return fHeader ? fHeader->GetZDCN1Energy() : -999.; }
128   Double_t  GetZDCP1Energy()        const { return fHeader ? fHeader->GetZDCP1Energy() : -999.; }
129   Double_t  GetZDCN2Energy()        const { return fHeader ? fHeader->GetZDCN2Energy() : -999.; }
130   Double_t  GetZDCP2Energy()        const { return fHeader ? fHeader->GetZDCP2Energy() : -999.; }
131   Double_t  GetZDCEMEnergy(Int_t i) const { return fHeader ? fHeader->GetZDCEMEnergy(i) : -999.; }
132   Int_t     GetNumberOfESDTracks()  const { return fHeader ? fHeader->GetNumberOfESDTracks() : 0; }
133   Int_t     GetNumberOfITSClusters(Int_t lr) const {return fHeader ? (int)fHeader->GetNumberOfITSClusters(lr) : 0;}
134   void SetTOFHeader(const AliTOFHeader * tofEventTime);
135   const AliTOFHeader *GetTOFHeader() const {return fTOFHeader;}
136   Float_t GetEventTimeSpread() const {if (fTOFHeader) return fTOFHeader->GetT0spread(); else return 0.;}
137   Float_t GetTOFTimeResolution() const {if (fTOFHeader) return fTOFHeader->GetTOFResolution(); else return 0.;}
138   Float_t GetT0spread(Int_t i) const {return fHeader->GetT0spread(i);}
139
140
141   // -- Tracks
142   TClonesArray *GetTracks()              const { return fTracks; }
143   void          ConnectTracks();
144   Int_t         GetNTracks()             const { return fTracks? fTracks->GetEntriesFast() : 0; }
145   Int_t         GetNumberOfTracks()      const { return GetNTracks(); }
146   AliAODTrack  *GetTrack(Int_t nTrack)   const { return fTracks ? (AliAODTrack*)fTracks->UncheckedAt(nTrack):0; }
147   Int_t         AddTrack(const AliAODTrack* trk);
148   Int_t         GetMuonTracks(TRefArray *muonTracks) const;
149   Int_t         GetNumberOfMuonTracks() const;
150   Int_t         GetMuonGlobalTracks(TRefArray *muonGlobalTracks) const;    // AU
151   Int_t         GetNumberOfMuonGlobalTracks() const;                       // AU
152
153   // -- Vertex
154   TClonesArray *GetVertices()            const { return fVertices; }
155   Int_t         GetNumberOfVertices()    const { return fVertices?fVertices->GetEntriesFast():0; }
156   AliAODVertex *GetVertex(Int_t nVertex) const { return fVertices?(AliAODVertex*)fVertices->At(nVertex):0; }
157   Int_t         AddVertex(const AliAODVertex* vtx)
158   {new((*fVertices)[fVertices->GetEntriesFast()]) AliAODVertex(*vtx); return fVertices->GetEntriesFast()-1;}
159   
160   // primary vertex
161   using AliVEvent::GetPrimaryVertex;
162   using AliVEvent::GetPrimaryVertexSPD;
163   virtual AliAODVertex *GetPrimaryVertex() const { return GetVertex(0); }
164   virtual AliAODVertex *GetPrimaryVertexSPD() const;
165
166   // -- Pileup vertices 
167   Int_t         GetNumberOfPileupVerticesTracks()   const;
168   Int_t         GetNumberOfPileupVerticesSPD()    const;
169   virtual AliAODVertex *GetPileupVertexSPD(Int_t iV=0) const;
170   virtual AliAODVertex *GetPileupVertexTracks(Int_t iV=0) const;
171   virtual Bool_t  IsPileupFromSPD(Int_t minContributors=3, Double_t minZdist=0.8, Double_t nSigmaZdist=3., Double_t nSigmaDiamXY=2., Double_t nSigmaDiamZ=5.) const;
172   virtual Bool_t IsPileupFromSPDInMultBins() const;
173
174
175   // V0
176   TClonesArray *GetV0s()                 const { return fV0s; }
177   Int_t         GetNumberOfV0s()         const { return fV0s->GetEntriesFast(); }
178   using AliVEvent::GetV0;
179   AliAODv0     *GetV0(Int_t nV0)         const { return (AliAODv0*)fV0s->UncheckedAt(nV0); }
180   Int_t         AddV0(const AliAODv0* v0)
181   {new((*fV0s)[fV0s->GetEntriesFast()]) AliAODv0(*v0); return fV0s->GetEntriesFast()-1;}
182
183   // Cascades
184   TClonesArray  *GetCascades()            const { return fCascades; }
185   Int_t          GetNumberOfCascades()    const { return fCascades->GetEntriesFast(); }
186   AliAODcascade *GetCascade(Int_t nCasc)  const { return (AliAODcascade*)fCascades->UncheckedAt(nCasc); }
187   Int_t          AddCascade(const AliAODcascade* cascade)
188   {new((*fCascades)[fCascades->GetEntriesFast()]) AliAODcascade(*cascade); return fCascades->GetEntriesFast()-1;}
189
190   // -- EMCAL and PHOS Cluster
191   TClonesArray *GetCaloClusters()          const { return fCaloClusters; }
192   Int_t         GetNumberOfCaloClusters()  const { return fCaloClusters?fCaloClusters->GetEntriesFast():0; }
193   AliAODCaloCluster *GetCaloCluster(Int_t nCluster) const { return fCaloClusters?(AliAODCaloCluster*)fCaloClusters->UncheckedAt(nCluster):0x0; }
194   Int_t         AddCaloCluster(const AliAODCaloCluster* clus)
195   {new((*fCaloClusters)[fCaloClusters->GetEntriesFast()]) AliAODCaloCluster(*clus); return fCaloClusters->GetEntriesFast()-1;}
196   AliAODCaloTrigger *GetCaloTrigger(TString calo) const 
197   {       
198      if (calo.Contains("EMCAL")) return fEMCALTrigger;
199      else
200      return fPHOSTrigger; 
201   }     
202         
203   Int_t GetEMCALClusters(TRefArray *clusters) const;
204   Int_t GetPHOSClusters(TRefArray *clusters) const;
205
206
207   // -- FMD Cluster
208   TClonesArray *GetFmdClusters()        const { return fFmdClusters; }
209   Int_t         GetNFmdClusters()       const { return fFmdClusters->GetEntriesFast(); }
210   AliAODFmdCluster *GetFmdCluster(Int_t nCluster) const { return (AliAODFmdCluster*)fFmdClusters->UncheckedAt(nCluster); }
211   Int_t         AddFmdCluster(const AliAODFmdCluster* clus)
212   {new((*fFmdClusters)[fFmdClusters->GetEntriesFast()]) AliAODFmdCluster(*clus); return fFmdClusters->GetEntriesFast()-1;}
213
214   // -- PMD Cluster
215   TClonesArray *GetPmdClusters()        const { return fPmdClusters; }
216   Int_t         GetNPmdClusters()       const { return fPmdClusters->GetEntriesFast(); }
217   AliAODPmdCluster *GetPmdCluster(Int_t nCluster) const { return (AliAODPmdCluster*)fPmdClusters->UncheckedAt(nCluster); }
218   Int_t         AddPmdCluster(const AliAODPmdCluster* clus)
219   {new((*fPmdClusters)[fPmdClusters->GetEntriesFast()]) AliAODPmdCluster(*clus); return fPmdClusters->GetEntriesFast()-1;}
220
221   // -- HMPID objects 
222   TClonesArray *GetHMPIDrings()       const {return fHMPIDrings; } 
223   Int_t         GetNHMPIDrings()      const;
224   AliAODHMPIDrings *GetHMPIDring(Int_t nRings) const;
225   Int_t         AddHMPIDrings(const  AliAODHMPIDrings* ring) 
226   {new((*fHMPIDrings)[fHMPIDrings->GetEntriesFast()]) AliAODHMPIDrings(*ring); return fHMPIDrings->GetEntriesFast()-1;}
227   
228   AliAODHMPIDrings *GetHMPIDringForTrackID(Int_t trackID) const;
229   
230   
231   // -- Jet
232   TClonesArray *GetJets()            const { return fJets; }
233   Int_t         GetNJets()           const { return fJets?fJets->GetEntriesFast():0; }
234   AliAODJet    *GetJet(Int_t nJet) const { return fJets?(AliAODJet*)fJets->UncheckedAt(nJet):0; }
235   Int_t         AddJet(const AliAODJet* vtx)
236     {new((*fJets)[fJets->GetEntriesFast()]) AliAODJet(*vtx); return fJets->GetEntriesFast()-1;}
237
238   // -- Tracklets
239   AliAODTracklets *GetTracklets() const { return fTracklets; }  
240   AliAODTracklets *GetMultiplicity() const {return GetTracklets();}
241   // -- Calorimeter Cells
242   AliAODCaloCells *GetEMCALCells() const { return fEmcalCells; }
243   AliAODCaloCells *GetPHOSCells() const { return fPhosCells; }
244   const TGeoHMatrix* GetPHOSMatrix(Int_t /*i*/) const { return NULL; }
245   const TGeoHMatrix* GetEMCALMatrix(Int_t /*i*/)const { return NULL; }
246
247
248   // -- Dimuons
249   TClonesArray *GetDimuons()              const { return fDimuons; }
250   Int_t         GetNDimuons()             const { return fDimuons->GetEntriesFast(); }
251   Int_t         GetNumberOfDimuons()      const { return GetNDimuons(); }
252   AliAODDimuon *GetDimuon(Int_t nDimu)    const { return (AliAODDimuon*)fDimuons->UncheckedAt(nDimu); }
253   Int_t         AddDimuon(const AliAODDimuon* dimu)
254     {new((*fDimuons)[fDimuons->GetEntriesFast()]) AliAODDimuon(*dimu); return fDimuons->GetEntriesFast()-1;}
255   
256   // // -- TRD
257   Int_t GetNumberOfTrdTracks() const { return fTrdTracks ? fTrdTracks->GetEntriesFast() : 0; }
258   AliAODTrdTrack* GetTrdTrack(Int_t i) const {
259     return (AliAODTrdTrack *) (fTrdTracks ? fTrdTracks->At(i) : 0x0);
260   }
261   AliAODTrdTrack& AddTrdTrack(const AliVTrdTrack *track);
262
263   // -- Services
264   void    CreateStdContent();
265   void    SetStdNames();
266   void    GetStdContent();
267   void    CreateStdFolders();
268   void    ResetStd(Int_t trkArrSize = 0, 
269                    Int_t vtxArrSize = 0, 
270                    Int_t v0ArrSize = 0, 
271                    Int_t cascadeArrSize = 0,
272                    Int_t jetSize = 0, 
273                    Int_t caloClusSize = 0, 
274                    Int_t fmdClusSize = 0, 
275                    Int_t pmdClusSize = 0,
276                    Int_t hmpidRingsSize = 0,
277                    Int_t dimuonArrsize =0,
278                    Int_t nTrdTracks = 0
279                    );
280   void    ClearStd();
281   void    Reset(); 
282   void    ReadFromTree(TTree *tree, Option_t* opt = "");
283   void    WriteToTree(TTree* tree) const {tree->Branch(fAODObjects);}
284
285   void  Print(Option_t *option="") const;
286   void  MakeEntriesReferencable();
287   static void AssignIDtoCollection(const TCollection* col);
288   
289     //Following needed only for mixed event
290   virtual Int_t        EventIndex(Int_t)       const {return 0;}
291   virtual Int_t        EventIndexForCaloCluster(Int_t) const {return 0;}
292   virtual Int_t        EventIndexForPHOSCell(Int_t)    const {return 0;}
293   virtual Int_t        EventIndexForEMCALCell(Int_t)   const {return 0;} 
294   AliCentrality*       GetCentrality() {return fHeader->GetCentralityP();} 
295   AliEventplane*       GetEventplane() {return fHeader->GetEventplaneP();}
296
297   // TZERO 
298   AliAODTZERO *GetTZEROData() const { return fAODTZERO; }
299   Double32_t GetT0TOF(Int_t icase) const { return fAODTZERO?fAODTZERO->GetT0TOF(icase):999999;}
300   const Double32_t * GetT0TOF() const { return fAODTZERO?fAODTZERO->GetT0TOF():0x0;}
301  
302   // VZERO 
303   AliAODVZERO *GetVZEROData() const { return fAODVZERO; }
304   virtual const Float_t* GetVZEROEqFactors() const {return fHeader?fHeader->GetVZEROEqFactors():0x0;}
305   virtual Float_t        GetVZEROEqMultiplicity(Int_t i) const;
306   virtual void   SetVZEROEqFactors(Float_t factors[64]) const {
307     SetVZEROEqFactors(&factors[0]);}
308   void           SetVZEROEqFactors(const Float_t *factors) const {
309     if(fHeader && factors)
310       fHeader->SetVZEROEqFactors(factors);}
311
312   //ZDC
313   AliAODZDC   *GetZDCData() const { return fAODZDC; }
314
315   virtual AliVEvent::EDataLayoutType GetDataLayoutType() const;
316
317   private :
318
319   TList   *fAODObjects; //  list of AODObjects
320   TFolder *fAODFolder;  //  folder structure of branches
321   Bool_t   fConnected;  //! flag if leaves are alreday connected 
322   Bool_t   fTracksConnected;      //! flag if tracks have already pointer to event set
323   // standard content
324   AliAODHeader    *fHeader;       //! event information
325   TClonesArray    *fTracks;       //! charged tracks
326   TClonesArray    *fVertices;     //! vertices
327   TClonesArray    *fV0s;          //! V0s
328   TClonesArray    *fCascades;     //! Cascades
329   AliAODTracklets *fTracklets;    //! SPD tracklets
330   TClonesArray    *fJets;         //! jets
331   AliAODCaloCells *fEmcalCells;   //! EMCAL calorimenter cells
332   AliAODCaloCells *fPhosCells;    //! PHOS calorimenter cells
333   TClonesArray    *fCaloClusters; //! calorimeter clusters
334   AliAODCaloTrigger *fEMCALTrigger; //! EMCAL Trigger information
335   AliAODCaloTrigger *fPHOSTrigger;  //! PHOS Trigger information
336   TClonesArray    *fFmdClusters;  //! FMDclusters
337   TClonesArray    *fPmdClusters;  //! PMDclusters
338   TClonesArray    *fHMPIDrings;   //! HMPID signals
339   TClonesArray    *fDimuons;      //! dimuons
340   AliAODTZERO     *fAODTZERO;     //! TZERO AOD
341   AliAODVZERO     *fAODVZERO;     //! VZERO AOD
342   AliAODZDC       *fAODZDC;       //! ZDC AOD
343   AliTOFHeader    *fTOFHeader;  //! event times (and sigmas) as estimated by TOF
344                              //  combinatorial algorithm.
345                              //  It contains also TOF time resolution
346                              //  and T0spread as written in OCDB
347   TClonesArray    *fTrdTracks;    //! TRD AOD tracks (triggered)
348   
349   static const char* fAODListName[kAODListN]; //!
350
351   ClassDef(AliAODEvent,91);
352 };
353
354 #endif