4945928eb509c38515dcaf0495fe097881f66d10
[u/mrichter/AliRoot.git] / STEER / AliESDEvent.h
1 // -*- mode: C++ -*- 
2 #ifndef ALIESDEVENT_H
3 #define ALIESDEVENT_H
4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5  * See cxx source for full Copyright notice                               */
6
7
8 /* $Id$ */
9
10 //-------------------------------------------------------------------------
11 //                          Class AliESDEvent
12 //   This is the class to deal with during the physics analysis of data.
13 //   It also ensures the backward compatibility with the old ESD format.
14 //      
15 // Origin: Christian Klein-Boesing, CERN, Christian.Klein-Boesing@cern.ch 
16 //-------------------------------------------------------------------------
17
18 #include <TClonesArray.h>
19 #include <TObject.h>
20 #include <TTree.h>
21 #include <TArrayF.h>
22
23 class TList;
24
25 #include "AliVEvent.h"
26 // some includes for delegated methods
27 #include "AliESDCaloTrigger.h"
28 #include "AliESDRun.h"
29 #include "AliESDHeader.h"
30 #include "AliESDTZERO.h"
31 #include "AliESDZDC.h"
32 #include "AliESDACORDE.h"
33
34 // AliESDtrack has to be included so that the compiler 
35 // knows its inheritance tree (= that it is a AliVParticle).
36 #include "AliESDtrack.h"
37 // same for AliESDVertex (which is a AliVVertex)
38 #include "AliESDVertex.h"
39
40 class AliESDfriend;
41 class AliESDVZERO;
42 class AliESDHLTtrack;
43 class AliESDVertex;
44 class AliESDPmdTrack;
45 class AliESDFMD;
46 class AliESDkink;
47 class AliESDCaloCluster;
48 class AliESDCaloCells;
49 class AliESDv0;
50 class AliMultiplicity;
51 class AliRawDataErrorLog;
52 class AliESDRun;
53 class AliESDTrdTrack;
54 class AliESDMuonTrack;
55 class AliESD;
56 class AliESDcascade;
57 class TRefArray;
58 class AliESDACORDE;
59
60 class AliESDEvent : public AliVEvent {
61 public:
62
63
64   enum ESDListIndex   {kESDRun,
65                        kHeader,
66                        kESDZDC,
67                        kESDFMD,
68                        kESDVZERO,
69                        kESDTZERO,
70                        kTPCVertex,
71                        kSPDVertex,
72                        kPrimaryVertex,
73                        kSPDMult,
74                        kPHOSTrigger,
75                        kEMCALTrigger,
76                        kSPDPileupVertices,
77                        kTrkPileupVertices,
78                        kTracks,
79                        kMuonTracks,
80                        kPmdTracks,
81                        kTrdTracks,
82                        kV0s,
83                        kCascades,
84                        kKinks,
85                        kCaloClusters,
86                        kEMCALCells,
87                        kPHOSCells,
88                        kErrorLogs,
89                        kESDACORDE,
90                        kESDListN
91   };
92
93   AliESDEvent();
94   virtual ~AliESDEvent();
95   AliESDEvent &operator=(const AliESDEvent& source); // or make private and use only copy? 
96   virtual void Copy(TObject& obj) const;
97
98   // RUN
99   // move this to the UserData!!!
100   const AliESDRun*    GetESDRun() const {return fESDRun;}
101
102   // Delegated methods for fESDRun
103   void     SetRunNumber(Int_t n) {fESDRun->SetRunNumber(n);}
104   Int_t    GetRunNumber() const {return fESDRun->GetRunNumber();}
105   void     SetPeriodNumber(UInt_t n){fESDRun->SetPeriodNumber(n);}
106   UInt_t   GetPeriodNumber() const {return fESDRun->GetPeriodNumber();}
107   void     SetMagneticField(Double_t mf){fESDRun->SetMagneticField(mf);}
108   Double_t GetMagneticField() const {return fESDRun->GetMagneticField();}
109   void     SetDiamond(const AliESDVertex *vertex) { fESDRun->SetDiamond(vertex);}
110   Double_t  GetDiamondX() const {return fESDRun->GetDiamondX();}
111   Double_t  GetDiamondY() const {return fESDRun->GetDiamondY();}
112   Double_t  GetSigma2DiamondX() const {return  fESDRun->GetSigma2DiamondX();}
113   Double_t  GetSigma2DiamondY() const {return  fESDRun->GetSigma2DiamondY();}
114   void      GetDiamondCovXY(Float_t cov[3]) const {fESDRun->GetDiamondCovXY(cov);}   
115   void     SetTriggerClass(const char*name, Int_t index) {fESDRun->SetTriggerClass(name,index);}
116   void     SetPHOSMatrix(TGeoHMatrix*matrix, Int_t i) {fESDRun->SetPHOSMatrix(matrix,i);}
117   const TGeoHMatrix* GetPHOSMatrix(Int_t i) const {return fESDRun->GetPHOSMatrix(i);}
118   void     SetEMCALMatrix(TGeoHMatrix*matrix, Int_t i) {fESDRun->SetEMCALMatrix(matrix,i);}
119   const TGeoHMatrix* GetEMCALMatrix(Int_t i) const {return fESDRun->GetEMCALMatrix(i);}
120   //
121   void        SetCurrentL3(Float_t cur)           const  {fESDRun->SetCurrentL3(cur);}
122   void        SetCurrentDip(Float_t cur)          const  {fESDRun->SetCurrentDip(cur);}
123   void        SetBeamEnergy(Float_t be)           const  {fESDRun->SetBeamEnergy(be);}
124   void        SetBeamType(const char* bt)         const  {fESDRun->SetBeamType(bt);}
125   void        SetUniformBMap(Bool_t val=kTRUE)    const  {fESDRun->SetBit(AliESDRun::kUniformBMap,val);}
126   void        SetBInfoStored(Bool_t val=kTRUE)    const  {fESDRun->SetBit(AliESDRun::kBInfoStored,val);}
127   //
128   Float_t     GetCurrentL3()                      const  {return fESDRun->GetCurrentL3();}
129   Float_t     GetCurrentDip()                     const  {return fESDRun->GetCurrentDip();}
130   Float_t     GetBeamEnergy()                     const  {return fESDRun->GetBeamEnergy();}
131   const char* GetBeamType()                       const  {return fESDRun->GetBeamType();}
132   Bool_t      IsUniformBMap()                     const  {return fESDRun->TestBit(AliESDRun::kUniformBMap);}
133   //
134   Bool_t      InitMagneticField()                 const  {return fESDRun->InitMagneticField();} 
135   // HEADER
136   AliESDHeader* GetHeader() const {return fHeader;}
137
138   // Delegated methods for fHeader
139   void      SetTriggerMask(ULong64_t n) {fHeader->SetTriggerMask(n);}
140   void      SetOrbitNumber(UInt_t n) {fHeader->SetOrbitNumber(n);}
141   void      SetTimeStamp(UInt_t timeStamp){fHeader->SetTimeStamp(timeStamp);}
142   void      SetEventType(UInt_t eventType){fHeader->SetEventType(eventType);}
143   void      SetEventNumberInFile(Int_t n) {fHeader->SetEventNumberInFile(n);}
144   //  void     SetRunNumber(Int_t n) {fHeader->SetRunNumber(n);}
145   void      SetBunchCrossNumber(UShort_t n) {fHeader->SetBunchCrossNumber(n);}
146   void      SetTriggerCluster(UChar_t n) {fHeader->SetTriggerCluster(n);}
147   
148   ULong64_t GetTriggerMask() const {return fHeader->GetTriggerMask();}
149   TString   GetFiredTriggerClasses() const {return fESDRun->GetFiredTriggerClasses(fHeader->GetTriggerMask());}
150   Bool_t    IsTriggerClassFired(const char *name) const {return fESDRun->IsTriggerClassFired(fHeader->GetTriggerMask(),name);}
151   Bool_t    IsEventSelected(const char *trigExpr) const;
152   TObject*  GetHLTTriggerDecision() const;
153   TString   GetHLTTriggerDescription() const;
154   Bool_t    IsHLTTriggerFired(const char* name=NULL) const;
155   UInt_t    GetOrbitNumber() const {return fHeader->GetOrbitNumber();}
156   UInt_t    GetTimeStamp()  const { return fHeader->GetTimeStamp();}
157   UInt_t    GetEventType()  const { return fHeader->GetEventType();}
158   Int_t     GetEventNumberInFile() const {return fHeader->GetEventNumberInFile();}
159   UShort_t  GetBunchCrossNumber() const {return fHeader->GetBunchCrossNumber();}
160   UChar_t   GetTriggerCluster() const {return fHeader->GetTriggerCluster();}
161
162   // ZDC CKB: put this in the header?
163   AliESDZDC*    GetESDZDC() const {return fESDZDC;}
164
165   // Delegated methods for fESDZDC
166   Double_t GetZDCN1Energy() const {return fESDZDC->GetZDCN1Energy();}
167   Double_t GetZDCP1Energy() const {return fESDZDC->GetZDCP1Energy();}
168   Double_t GetZDCN2Energy() const {return fESDZDC->GetZDCN2Energy();}
169   Double_t GetZDCP2Energy() const {return fESDZDC->GetZDCP2Energy();}
170   Double_t GetZDCEMEnergy(Int_t i=0) const {return fESDZDC->GetZDCEMEnergy(i);}
171   Int_t    GetZDCParticipants() const {return fESDZDC->GetZDCParticipants();}
172   void     SetZDC(Float_t n1Energy, Float_t p1Energy, Float_t em1Energy, Float_t em2Energy,
173                   Float_t n2Energy, Float_t p2Energy, Int_t participants, Int_t nPartA,
174                   Int_t nPartC, Double_t b, Double_t bA, Double_t bC, UInt_t recoflag)
175            {fESDZDC->SetZDC(n1Energy, p1Energy, em1Energy, em2Energy, n2Energy, p2Energy, 
176             participants, nPartA, nPartC, b, bA, bC,  recoflag);}
177   void     SetZDCScaler(UInt_t *counts) {fESDZDC->SetZDCScaler(counts);}
178
179
180   // FMD
181   void SetFMDData(AliESDFMD * obj);
182   AliESDFMD *GetFMDData() const { return fESDFMD; }
183
184
185   // TZERO CKB: put this in the header?
186   const AliESDTZERO*    GetESDTZERO() const {return fESDTZERO;}
187   // delegetated methods for fESDTZERO
188
189   Double_t GetT0zVertex() const {return fESDTZERO->GetT0zVertex();}
190   void SetT0zVertex(Float_t z) {fESDTZERO->SetT0zVertex(z);}
191   Double_t GetT0() const {return fESDTZERO->GetT0();}
192   void SetT0(Float_t timeStart) {fESDTZERO->SetT0(timeStart);}
193   Float_t GetT0clock() const {return fESDTZERO->GetT0clock();}
194   void SetT0clock(Float_t timeStart) {fESDTZERO->SetT0clock(timeStart);}
195   const Double_t * GetT0time() const {return fESDTZERO->GetT0time();}
196   void SetT0time(Float_t time[24]) {fESDTZERO->SetT0time(time);}
197   const Double_t * GetT0amplitude() const {return fESDTZERO->GetT0amplitude();}
198   void SetT0amplitude(Float_t amp[24]){fESDTZERO->SetT0amplitude(amp);}
199
200   // VZERO 
201   AliESDVZERO *GetVZEROData() const { return fESDVZERO; }
202   void SetVZEROData(AliESDVZERO * obj);
203
204  // ACORDE
205   AliESDACORDE *GetACORDEData() const { return fESDACORDE;}
206   void SetACORDEData(AliESDACORDE * obj);
207
208   void SetESDfriend(const AliESDfriend *f) const;
209   void GetESDfriend(AliESDfriend *f) const;
210
211
212
213   void SetPrimaryVertexTPC(const AliESDVertex *vertex); 
214   const AliESDVertex *GetPrimaryVertexTPC() const {return fTPCVertex;}
215
216   void SetPrimaryVertexSPD(const AliESDVertex *vertex); 
217   const AliESDVertex *GetPrimaryVertexSPD() const {return fSPDVertex;}
218   const AliESDVertex *GetVertex() const {
219     //For the backward compatibily only
220      return GetPrimaryVertexSPD();
221   }
222
223   void SetPrimaryVertexTracks(const AliESDVertex *vertex);
224   const AliESDVertex *GetPrimaryVertexTracks() const {return fPrimaryVertex;}
225   AliESDVertex *PrimaryVertexTracksUnconstrained() const;
226
227   const AliESDVertex *GetPrimaryVertex() const;
228
229   void SetMultiplicity(const AliMultiplicity *mul);
230
231   const AliMultiplicity *GetMultiplicity() const {return fSPDMult;}
232
233
234   Bool_t Clean(Float_t *cleanPars);
235   Bool_t RemoveKink(Int_t i)   const;
236   Bool_t RemoveV0(Int_t i)     const;
237   Bool_t RemoveTrack(Int_t i)  const;
238
239   const AliESDVertex *GetPileupVertexSPD(Int_t i) const {
240     return (const AliESDVertex *)fSPDPileupVertices->UncheckedAt(i);
241   }
242   Char_t  AddPileupVertexSPD(const AliESDVertex *vtx);
243   Bool_t  IsPileupFromSPD(Int_t ncont=2, Double_t nSigmaDeltaZ=3., Double_t nSigmaXY=2., Int_t option=0) const;
244
245   const AliESDVertex *GetPileupVertexTracks(Int_t i) const {
246     return (const AliESDVertex *)fTrkPileupVertices->UncheckedAt(i);
247   }
248   Char_t  AddPileupVertexTracks(const AliESDVertex *vtx);
249
250   AliESDtrack *GetTrack(Int_t i) const {
251     return (AliESDtrack *)fTracks->UncheckedAt(i);
252   }
253   Int_t  AddTrack(const AliESDtrack *t);
254
255   
256   AliESDHLTtrack *GetHLTConfMapTrack(Int_t /*i*/) const {
257     //    return (AliESDHLTtrack *)fHLTConfMapTracks->UncheckedAt(i);
258     return 0;
259   }
260   void AddHLTConfMapTrack(const AliESDHLTtrack */*t*/) {
261     printf("ESD:: AddHLTConfMapTrack do nothing \n");
262     //    TClonesArray &fhlt = *fHLTConfMapTracks;
263     //  new(fhlt[fHLTConfMapTracks->GetEntriesFast()]) AliESDHLTtrack(*t);
264   }
265   
266
267   AliESDHLTtrack *GetHLTHoughTrack(Int_t /*i*/) const {
268     //    return (AliESDHLTtrack *)fHLTHoughTracks->UncheckedAt(i);
269     return 0;
270   }
271   void AddHLTHoughTrack(const AliESDHLTtrack */*t*/) {
272     printf("ESD:: AddHLTHoughTrack do nothing \n");
273     //    TClonesArray &fhlt = *fHLTHoughTracks;
274     //     new(fhlt[fHLTHoughTracks->GetEntriesFast()]) AliESDHLTtrack(*t);
275   }
276   
277   AliESDMuonTrack *GetMuonTrack(Int_t i) const {
278     return (AliESDMuonTrack *)fMuonTracks->UncheckedAt(i);
279   }
280
281   void AddMuonTrack(const AliESDMuonTrack *t);
282
283   AliESDPmdTrack *GetPmdTrack(Int_t i) const {
284     return (AliESDPmdTrack *)fPmdTracks->UncheckedAt(i);
285   }
286
287   void AddPmdTrack(const AliESDPmdTrack *t);
288
289
290   AliESDTrdTrack *GetTrdTrack(Int_t i) const {
291     return (AliESDTrdTrack *)fTrdTracks->UncheckedAt(i);
292   }
293
294   
295   void AddTrdTrack(const AliESDTrdTrack *t);
296
297   AliESDv0 *GetV0(Int_t i) const {
298     return (AliESDv0*)fV0s->UncheckedAt(i);
299   }
300   Int_t AddV0(const AliESDv0 *v);
301
302   AliESDcascade *GetCascade(Int_t i) const {
303     return (AliESDcascade *)fCascades->UncheckedAt(i);
304   }
305
306   void AddCascade(const AliESDcascade *c);
307
308   AliESDkink *GetKink(Int_t i) const {
309     return (AliESDkink *)fKinks->UncheckedAt(i);
310   }
311   Int_t AddKink(const AliESDkink *c);
312
313   AliESDCaloCluster *GetCaloCluster(Int_t i) const {
314     return (AliESDCaloCluster *)fCaloClusters->UncheckedAt(i);
315   }
316
317   Int_t AddCaloCluster(const AliESDCaloCluster *c);
318
319   AliESDCaloCells *GetEMCALCells() const {return fEMCALCells; }  
320   AliESDCaloCells *GetPHOSCells() const {return fPHOSCells; }  
321
322   AliRawDataErrorLog *GetErrorLog(Int_t i) const {
323     return (AliRawDataErrorLog *)fErrorLogs->UncheckedAt(i);
324   }
325   void  AddRawDataErrorLog(const AliRawDataErrorLog *log) const;
326
327   Int_t GetNumberOfErrorLogs()   const {return fErrorLogs->GetEntriesFast();}
328
329     
330   void AddPHOSTriggerPosition(TArrayF array)   { fPHOSTrigger->AddTriggerPosition(array); }
331   void AddPHOSTriggerAmplitudes(TArrayF array) { fPHOSTrigger->AddTriggerAmplitudes(array);}
332   void AddEMCALTriggerPosition(TArrayF array)  { fEMCALTrigger->AddTriggerPosition(array); }
333   void AddEMCALTriggerAmplitudes(TArrayF array){ fEMCALTrigger->AddTriggerAmplitudes(array); }
334
335   Int_t GetNumberOfPileupVerticesSPD() const {
336     return (fSPDPileupVertices?fSPDPileupVertices->GetEntriesFast():0);
337   }
338   Int_t GetNumberOfPileupVerticesTracks() const {
339     return (fTrkPileupVertices?fTrkPileupVertices->GetEntriesFast():0);
340   }
341   Int_t GetNumberOfTracks()     const {return fTracks->GetEntriesFast();}
342   Int_t GetNumberOfHLTConfMapTracks()     const {return 0;} 
343   // fHLTConfMapTracks->GetEntriesFast();}
344   Int_t GetNumberOfHLTHoughTracks()     const {return  0;  }
345   //  fHLTHoughTracks->GetEntriesFast();  }
346
347   Int_t GetNumberOfMuonTracks() const {return fMuonTracks->GetEntriesFast();}
348   Int_t GetNumberOfPmdTracks() const {return fPmdTracks->GetEntriesFast();}
349   Int_t GetNumberOfTrdTracks() const {return fTrdTracks->GetEntriesFast();}
350   Int_t GetNumberOfV0s()      const {return fV0s->GetEntriesFast();}
351   Int_t GetNumberOfCascades() const {return fCascades->GetEntriesFast();}
352   Int_t GetNumberOfKinks() const {return fKinks->GetEntriesFast();}
353   
354   Int_t GetEMCALClusters(TRefArray *clusters) const;
355   Int_t GetPHOSClusters(TRefArray *clusters) const;
356   Int_t GetNumberOfCaloClusters() const {return fCaloClusters->GetEntriesFast();}
357
358   void SetUseOwnList(Bool_t b){fUseOwnList = b;}
359   Bool_t GetUseOwnList() const {return fUseOwnList;}
360   
361   // Remove this stuff CKB?
362   //---------------------------------------------------
363   Int_t GetNumberOfEMCALClusters() const {return fEMCALClusters;}
364   void  SetNumberOfEMCALClusters(Int_t clus) {fEMCALClusters = clus;}
365   Int_t GetFirstEMCALCluster() const {return fFirstEMCALCluster;}
366   void  SetFirstEMCALCluster(Int_t index) {fFirstEMCALCluster = index;}
367  
368   Int_t GetNumberOfPHOSClusters() const {return fPHOSClusters;}
369   void  SetNumberOfPHOSClusters(Int_t part) { fPHOSClusters = part ; }
370   void  SetFirstPHOSCluster(Int_t index) { fFirstPHOSCluster = index ; } 
371   Int_t GetFirstPHOSCluster() const  { return fFirstPHOSCluster ; }
372   //-------------------------------------------------------
373
374   TArrayF *GetEMCALTriggerPosition() const {return  fEMCALTrigger->GetTriggerPosition();}
375   TArrayF *GetEMCALTriggerAmplitudes() const {return  fEMCALTrigger->GetTriggerAmplitudes();}
376   TArrayF *GetPHOSTriggerPosition() const {return  fPHOSTrigger->GetTriggerPosition();}
377   TArrayF *GetPHOSTriggerAmplitudes() const {return  fPHOSTrigger->GetTriggerAmplitudes();}
378
379   void ResetV0s() { fV0s->Clear(); }
380   void ResetCascades() { fCascades->Clear(); }
381   void Reset();
382
383   void  Print(Option_t *option="") const;
384
385   void AddObject(TObject* obj);
386   void ReadFromTree(TTree *tree, Option_t* opt = "");
387   TObject* FindListObject(const char *name);
388   AliESD *GetAliESDOld(){return fESDOld;}
389   void WriteToTree(TTree* tree) const;
390   void GetStdContent();
391   void ResetStdContent();
392   void CreateStdContent();
393   void CreateStdContent(Bool_t bUseThisList);
394   void SetStdNames();
395   void CopyFromOldESD();
396   TList* GetList() const {return fESDObjects;}
397
398 protected:
399   AliESDEvent(const AliESDEvent&);
400   static Bool_t ResetWithPlacementNew(TObject *pObject);
401
402   TList *fESDObjects;             // List of esd Objects
403
404   AliESDRun       *fESDRun;           //! Run information tmp put in the Userdata
405   AliESDHeader    *fHeader;           //! ESD Event Header
406   AliESDZDC       *fESDZDC;           //! ZDC information
407   AliESDFMD       *fESDFMD;           //! FMD object containing rough multiplicity
408   AliESDVZERO     *fESDVZERO;         //! VZERO object containing rough multiplicity
409   AliESDTZERO     *fESDTZERO;         //! TZEROObject
410   AliESDVertex    *fTPCVertex;        //! Primary vertex estimated by the TPC
411   AliESDVertex    *fSPDVertex;        //! Primary vertex estimated by the SPD
412   AliESDVertex    *fPrimaryVertex;    //! Primary vertex estimated using ESD tracks
413   AliMultiplicity *fSPDMult;          //! SPD tracklet multiplicity
414   AliESDCaloTrigger* fPHOSTrigger;     //! PHOS Trigger information
415   AliESDCaloTrigger* fEMCALTrigger;    //! PHOS Trigger information
416   AliESDACORDE    *fESDACORDE;        //! ACORDE ESD object caontaining bit pattern
417
418   TClonesArray *fSPDPileupVertices;//! Pileup primary vertices reconstructed by SPD 
419   TClonesArray *fTrkPileupVertices;//! Pileup primary vertices reconstructed using the tracks 
420   TClonesArray *fTracks;           //! ESD tracks 
421   TClonesArray *fMuonTracks;       //! MUON ESD tracks
422   TClonesArray *fPmdTracks;        //! PMD ESD tracks
423   TClonesArray *fTrdTracks;        //! TRD ESD tracks (triggered)
424   TClonesArray *fV0s;              //! V0 vertices
425   TClonesArray *fCascades;         //! Cascade vertices
426   TClonesArray *fKinks;            //! Kinks
427   TClonesArray *fCaloClusters;     //! Calorimeter clusters for PHOS/EMCAL
428   AliESDCaloCells *fEMCALCells;     //! EMCAL cell info
429   AliESDCaloCells *fPHOSCells;     //! PHOS cell info
430   TClonesArray *fErrorLogs;        //! Raw-data reading error messages
431  
432
433
434   AliESD       *fESDOld;           //! Old esd Structure
435   AliESDfriend *fESDFriendOld;     //! Old friend esd Structure
436   Bool_t    fConnected;            //! flag if leaves are alreday connected
437   Bool_t    fUseOwnList;           //! Do not use the list from the esdTree but use the one created by this class 
438
439   static const char* fgkESDListName[kESDListN]; //!
440
441   // Remove this stuff CKB
442   Int_t        fEMCALClusters;   // Number of EMCAL clusters (subset of caloclusters)
443   Int_t        fFirstEMCALCluster; // First EMCAL cluster in the fCaloClusters list 
444
445   Int_t        fPHOSClusters;     // Number of PHOS clusters (subset of caloclusters)
446   Int_t        fFirstPHOSCluster; // First PHOS cluster in the fCaloClusters list 
447
448   ClassDef(AliESDEvent,10)  //ESDEvent class 
449 };
450 #endif 
451