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