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