STEER/STEERBase/AliVEvent.h

   1 // -*- mode: C++ -*-
   2 #ifndef ALIVEVENT_H
   3 #define ALIVEVENT_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 AliVEvent
  12 //
  13 // Origin: Markus Oldenburg, CERN, Markus.Oldenburg@cern.ch
  14 //-------------------------------------------------------------------------
  15
  16 #include <TObject.h>
  17 #include <TTree.h>
  18 #include <TGeoMatrix.h>
  19 #include "AliVHeader.h"
  20 #include "AliVParticle.h"
  21 #include "AliVVertex.h"
  22 #include "AliVCluster.h"
  23 #include "AliVCaloCells.h"
  24 #include "AliVCaloTrigger.h"
  25 #include "TRefArray.h"
  26 #include "AliTOFHeader.h"
  27 #include "AliVTrdTrack.h"
  28 #include "AliVMultiplicity.h"
  29 class AliVfriendEvent;
  30 class AliCentrality;
  31 class AliEventplane;
  32 class AliVVZERO;
  33 class AliVZDC;
  34 class AliVMFT;   // AU
  35 class AliESDkink;
  36 class AliESDv0;
  37 class AliESDVertex;
  38 class AliVTrack;
  39
  40 class AliVEvent : public TObject {
  41
  42 public:
  43   enum EDataLayoutType { kESD, kMC, kAOD, kMixed, kFlat };
  44   enum EOfflineTriggerTypes {
  45       kMB           = BIT(0), // Minimum bias trigger, i.e. interaction trigger, offline SPD or V0 selection
  46       kINT7         = BIT(1), // V0AND trigger, offline V0 selection
  47       kMUON         = BIT(2), // Muon trigger, offline SPD or V0 selection
  48       kHighMult     = BIT(3), // High-multiplicity trigger (threshold defined online), offline SPD or V0 selection
  49       kEMC1         = BIT(4), // EMCAL trigger
  50       kCINT5        = BIT(5), // Minimum bias trigger without SPD. i.e. interaction trigger, offline V0 selection
  51       kCMUS5        = BIT(6), // Muon trigger, offline V0 selection
  52       kMUSPB        = BIT(6), // idem for PbPb
  53       kMUSH7        = BIT(7), // Muon trigger: high pt, single muon, offline V0 selection, CINT7 suite
  54       kMUSHPB       = BIT(7), // idem for PbPb
  55       kMUL7         = BIT(8), // Muon trigger: like sign dimuon, offline V0 selection, CINT7 suite
  56       kMuonLikePB   = BIT(8), // idem for PbPb
  57       kMUU7         = BIT(9), // Muon trigger, unlike sign dimuon, offline V0 selection, CINT7 suite
  58       kMuonUnlikePB = BIT(9), // idem for PbPb
  59       kEMC7         = BIT(10), // EMCAL trigger, CINT7 suite
  60       kEMC8         = BIT(10), // EMCAL trigger, CINT8 suite
  61       kMUS7         = BIT(11), // Muon trigger: low pt, single muon, offline V0 selection, CINT7 suite
  62       kPHI1         = BIT(12), // PHOS trigger, CINT1 suite
  63       kPHI7         = BIT(13), // PHOS trigger, CINT7 suite
  64       kPHI8         = BIT(13), // PHOS trigger, CINT8 suite
  65       kPHOSPb       = BIT(13), // idem for PbPb
  66       kEMCEJE       = BIT(14), // EMCAL jet patch trigger
  67       kEMCEGA       = BIT(15), // EMCAL gamma trigger
  68       kCentral      = BIT(16), // PbPb central collision trigger
  69       kSemiCentral  = BIT(17), // PbPb semicentral collision trigger
  70       kDG5          = BIT(18), // Double gap diffractive
  71       kZED          = BIT(19), // ZDC electromagnetic dissociation
  72       kSPI7         = BIT(20), // Power interaction trigger
  73       kSPI          = BIT(20), // Power interaction trigger
  74       kINT8                 = BIT(21), // CINT8 trigger: 0TVX (T0 vertex) triger
  75       kMuonSingleLowPt8     = BIT(22), // Muon trigger : single muon, low pt, T0 selection, CINT8 suite
  76       kMuonSingleHighPt8    = BIT(23), // Muon trigger : single muon, high pt, T0 selection, CINT8 suite
  77       kMuonLikeLowPt8       = BIT(24), // Muon trigger : like sign muon, low pt, T0 selection, CINT8 suite
  78       kMuonUnlikeLowPt8     = BIT(25), // Muon trigger : unlike sign muon, low pt, T0 selection, CINT8 suite
  79       kMuonUnlikeLowPt0     = BIT(26), // Muon trigger : unlike sign muon, low pt, no additional L0 requirement
  80       kUserDefined  = BIT(27), // Set when custom trigger classes are set in AliPhysicsSelection, offline SPD or V0 selection
  81       kTRD          = BIT(28), // TRD trigger
  82       // Bits 29 and above are reserved for FLAGS
  83       kFastOnly     = BIT(30), // The fast cluster fired. This bit is set in to addition another trigger bit, e.g. kMB
  84       kAny          = 0xffffffff, // to accept any trigger
  85       kAnyINT       = kMB | kINT7 | kCINT5 | kINT8 | kSPI7 // to accept any interaction (aka minimum bias) trigger
  86   };
  87
  88   AliVEvent() { }
  89   virtual ~AliVEvent() { }
  90   AliVEvent(const AliVEvent& vEvnt);
  91   AliVEvent& operator=(const AliVEvent& vEvnt);
  92
  93   // Services
  94   virtual void AddObject(TObject* obj) = 0;
  95   virtual TObject* FindListObject(const char *name) const = 0;
  96   virtual TList* GetList() const = 0;
  97
  98   virtual void CreateStdContent() = 0;
  99   virtual void GetStdContent() = 0;
 100
 101   virtual void ReadFromTree(TTree *tree, Option_t* opt) = 0;
 102   virtual void WriteToTree(TTree* tree) const = 0;
 103
 104   virtual void Reset() = 0;
 105   //virtual void ResetStdContent() = 0;
 106   virtual void SetStdNames() = 0;
 107
 108   virtual void Print(Option_t *option="") const = 0;
 109
 110   // Header
 111   virtual AliVHeader* GetHeader() const = 0;
 112   //
 113   // field initialization
 114   virtual Bool_t InitMagneticField() const {return kFALSE;}
 115
 116   // Delegated methods for fESDRun or AODHeader
 117
 118   virtual void     SetRunNumber(Int_t n) = 0;
 119   virtual void     SetPeriodNumber(UInt_t n) = 0;
 120   virtual void     SetMagneticField(Double_t mf) = 0;
 121
 122   virtual Int_t    GetRunNumber() const = 0;
 123   virtual UInt_t   GetPeriodNumber() const = 0;
 124   virtual Double_t GetMagneticField() const = 0;
 125
 126   virtual Double_t GetDiamondX() const {return -999.;}
 127   virtual Double_t GetDiamondY() const {return -999.;}
 128   virtual void     GetDiamondCovXY(Float_t cov[3]) const
 129              {cov[0]=-999.; return;}
 130
 131   // Delegated methods for fHeader
 132   virtual void      SetOrbitNumber(UInt_t n) = 0;
 133   virtual void      SetBunchCrossNumber(UShort_t n) = 0;
 134   virtual void      SetEventType(UInt_t eventType)= 0;
 135   virtual void      SetTriggerMask(ULong64_t n) = 0;
 136   virtual void      SetTriggerCluster(UChar_t n) = 0;
 137
 138   virtual UInt_t    GetOrbitNumber() const = 0;
 139   virtual UShort_t  GetBunchCrossNumber() const = 0;
 140   virtual UInt_t    GetEventType()  const = 0;
 141   virtual ULong64_t GetTriggerMask() const = 0;
 142   virtual UChar_t   GetTriggerCluster() const = 0;
 143   virtual TString   GetFiredTriggerClasses() const = 0;
 144   virtual Double_t  GetZDCN1Energy() const = 0;
 145   virtual Double_t  GetZDCP1Energy() const = 0;
 146   virtual Double_t  GetZDCN2Energy() const = 0;
 147   virtual Double_t  GetZDCP2Energy() const = 0;
 148   virtual Double_t  GetZDCEMEnergy(Int_t i) const = 0;
 149
 150   // Tracks
 151   virtual AliVParticle *GetTrack(Int_t i) const = 0;
 152   virtual AliVTrack    *GetVTrack(Int_t /*i*/) const {return NULL;}
 153   //virtual AliVTrack    *GetVTrack(Int_t /*i*/) {return NULL;}
 154   //virtual Int_t        AddTrack(const AliVParticle *t) = 0;
 155   virtual Int_t        GetNumberOfTracks() const = 0;
 156   virtual Int_t        GetNumberOfV0s() const = 0;
 157   virtual Int_t        GetNumberOfCascades() const = 0;
 158
 159   // TOF header and T0 methods
 160   virtual const AliTOFHeader *GetTOFHeader() const {return NULL;}
 161   virtual Float_t GetEventTimeSpread() const {return 0.;}
 162   virtual Float_t GetTOFTimeResolution() const {return 0.;}
 163   virtual Double32_t GetT0TOF(Int_t icase) const {return 0.0*icase;}
 164   virtual const Double32_t * GetT0TOF() const {return NULL;}
 165   virtual Float_t GetT0spread(Int_t /*i*/) const {return 0.;}
 166
 167   // Calorimeter Clusters/Cells
 168   virtual AliVCluster *GetCaloCluster(Int_t)   const {return 0;}
 169   virtual Int_t GetNumberOfCaloClusters()      const {return 0;}
 170   virtual Int_t GetEMCALClusters(TRefArray *)  const {return 0;}
 171   virtual Int_t GetPHOSClusters (TRefArray *)  const {return 0;}
 172   virtual AliVCaloCells *GetEMCALCells()       const {return 0;}
 173   virtual AliVCaloCells *GetPHOSCells()        const {return 0;}
 174   const TGeoHMatrix* GetPHOSMatrix(Int_t /*i*/)    const {return NULL;}
 175   const TGeoHMatrix* GetEMCALMatrix(Int_t /*i*/)   const {return NULL;}
 176   virtual AliVCaloTrigger *GetCaloTrigger(TString /*calo*/) const {return NULL;}
 177
 178
 179   // Primary vertex
 180   virtual Bool_t IsPileupFromSPD(Int_t /*minContributors*/,
 181                                  Double_t /*minZdist*/,
 182                                  Double_t /*nSigmaZdist*/,
 183                                  Double_t /*nSigmaDiamXY*/,
 184                                  Double_t /*nSigmaDiamZ*/)
 185                                  const{
 186     return kFALSE;
 187   }
 188
 189   // Tracklets
 190   virtual AliVMultiplicity* GetMultiplicity() const {return 0;}
 191   virtual Int_t             GetNumberOfITSClusters(Int_t) const {return 0;}
 192
 193   virtual Bool_t IsPileupFromSPDInMultBins() const {
 194     return kFALSE;
 195   }
 196   virtual AliCentrality* GetCentrality()                          = 0;
 197   virtual AliEventplane* GetEventplane()                          = 0;
 198   virtual Int_t        EventIndex(Int_t itrack)             const = 0;
 199   virtual Int_t        EventIndexForCaloCluster(Int_t iclu) const = 0;
 200   virtual Int_t        EventIndexForPHOSCell(Int_t icell)   const = 0;
 201   virtual Int_t        EventIndexForEMCALCell(Int_t icell)  const = 0;
 202
 203   virtual AliVVZERO *GetVZEROData() const = 0;
 204   virtual const Float_t* GetVZEROEqFactors() const {return NULL;}
 205   virtual Float_t        GetVZEROEqMultiplicity(Int_t /* i */) const {return -1;}
 206   virtual void           SetVZEROEqFactors(Float_t /* factors */[64]) const {return;}
 207   virtual AliVZDC   *GetZDCData() const = 0;
 208
 209   virtual Int_t GetNumberOfTrdTracks() const { return 0; }
 210   virtual AliVTrdTrack* GetTrdTrack(Int_t /* iTrack */) const { return 0x0; }
 211
 212   virtual Int_t     GetNumberOfESDTracks()  const { return 0; }
 213   virtual Int_t     GetEventNumberInFile() const {return 0;}
 214
 215   //used in calibration:
 216   virtual Int_t            GetV0(AliESDv0&, Int_t /*iv0*/) const {return 0;}
 217   virtual UInt_t           GetTimeStamp() const { return 0; }
 218   virtual AliVfriendEvent* FindFriend() const { return 0; }
 219   virtual UInt_t           GetEventSpecie() const { return 0; }
 220   virtual AliESDkink*      GetKink(Int_t /*i*/) const { return NULL; }
 221   virtual Int_t            GetNumberOfKinks() const { return 0; }
 222
 223   // Primary vertex
 224   virtual const AliVVertex   *GetPrimaryVertex() const {return 0x0;}
 225   //virtual const AliVVertex   *GetPrimaryVertexSPD() const {return 0x0;}
 226   //virtual const AliVVertex   *GetPrimaryVertexTPC() const {return 0x0;}
 227   //virtual const AliVVertex   *GetPrimaryVertexTracks() const {return 0x0;}
 228
 229   virtual Int_t GetPrimaryVertex( AliESDVertex & ) const {return 0;}
 230   virtual Int_t GetPrimaryVertexTPC( AliESDVertex & ) const {return 0;}
 231   virtual Int_t GetPrimaryVertexSPD( AliESDVertex & ) const {return 0;}
 232   virtual Int_t GetPrimaryVertexTracks( AliESDVertex & ) const {return 0;}
 233
 234   virtual void ConnectTracks() {}
 235   virtual EDataLayoutType GetDataLayoutType() const = 0;
 236   const char* Whoami();
 237
 238   ClassDef(AliVEvent, 3)  // base class for AliEvent data
 239 };
 240 #endif
 241