[u/mrichter/AliRoot.git] / STEER / STEERBase / AliVEvent.h

// -*- mode: C++ -*- 
#ifndef ALIVEVENT_H
#define ALIVEVENT_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */


/* $Id$ */

//-------------------------------------------------------------------------
//                          Class AliVEvent
//      
// Origin: Markus Oldenburg, CERN, Markus.Oldenburg@cern.ch 
//-------------------------------------------------------------------------

#include <TObject.h>
#include <TTree.h>
#include <TGeoMatrix.h>
#include "AliVHeader.h"
#include "AliVParticle.h"
#include "AliVVertex.h"
#include "AliVCluster.h"
#include "AliVCaloCells.h"
#include "AliVCaloTrigger.h"
#include "TRefArray.h"
#include "AliTOFHeader.h"
#include "AliVTrdTrack.h"
#include "AliVMultiplicity.h"
class AliCentrality;
class AliEventplane;
class AliVVZERO;
class AliVZDC;
class AliVMFT;   // AU

class AliVEvent : public TObject {

public:
  enum EOfflineTriggerTypes { 
      kMB           = BIT(0), // Minimum bias trigger, i.e. interaction trigger, offline SPD or V0 selection
      kINT7         = BIT(1), // V0AND trigger, offline V0 selection
      kMUON         = BIT(2), // Muon trigger, offline SPD or V0 selection
      kHighMult     = BIT(3), // High-multiplicity trigger (threshold defined online), offline SPD or V0 selection
      kEMC1         = BIT(4), // EMCAL trigger
      kCINT5        = BIT(5), // Minimum bias trigger without SPD. i.e. interaction trigger, offline V0 selection
      kCMUS5        = BIT(6), // Muon trigger, offline V0 selection
      kMUSPB        = BIT(6), // idem for PbPb
      kMUSH7        = BIT(7), // Muon trigger: high pt, single muon, offline V0 selection, CINT7 suite
      kMUSHPB       = BIT(7), // idem for PbPb
      kMUL7         = BIT(8), // Muon trigger: like sign dimuon, offline V0 selection, CINT7 suite
      kMuonLikePB   = BIT(8), // idem for PbPb
      kMUU7         = BIT(9), // Muon trigger, unlike sign dimuon, offline V0 selection, CINT7 suite
      kMuonUnlikePB = BIT(9), // idem for PbPb
      kEMC7         = BIT(10), // EMCAL trigger, CINT7 suite
      kEMC8         = BIT(10), // EMCAL trigger, CINT8 suite
      kMUS7         = BIT(11), // Muon trigger: low pt, single muon, offline V0 selection, CINT7 suite
      kPHI1         = BIT(12), // PHOS trigger, CINT1 suite
      kPHI7         = BIT(13), // PHOS trigger, CINT7 suite
      kPHI8         = BIT(13), // PHOS trigger, CINT8 suite
      kPHOSPb       = BIT(13), // idem for PbPb
      kEMCEJE       = BIT(14), // EMCAL jet patch trigger
      kEMCEGA       = BIT(15), // EMCAL gamma trigger
      kCentral      = BIT(16), // PbPb central collision trigger
      kSemiCentral  = BIT(17), // PbPb semicentral collision trigger
      kDG5          = BIT(18), // Double gap diffractive
      kZED          = BIT(19), // ZDC electromagnetic dissociation
      kSPI7         = BIT(20), // Power interaction trigger
      kSPI          = BIT(20), // Power interaction trigger
      kINT8                 = BIT(21), // CINT8 trigger: 0TVX (T0 vertex) triger
      kMuonSingleLowPt8     = BIT(22), // Muon trigger : single muon, low pt, T0 selection, CINT8 suite
      kMuonSingleHighPt8    = BIT(23), // Muon trigger : single muon, high pt, T0 selection, CINT8 suite
      kMuonLikeLowPt8       = BIT(24), // Muon trigger : like sign muon, low pt, T0 selection, CINT8 suite
      kMuonUnlikeLowPt8     = BIT(25), // Muon trigger : unlike sign muon, low pt, T0 selection, CINT8 suite
      kMuonUnlikeLowPt0     = BIT(26), // Muon trigger : unlike sign muon, low pt, no additional L0 requirement
      kUserDefined  = BIT(27), // Set when custom trigger classes are set in AliPhysicsSelection, offline SPD or V0 selection
      kTRD          = BIT(28), // TRD trigger
      // Bits 29 and above are reserved for FLAGS
      kFastOnly     = BIT(30), // The fast cluster fired. This bit is set in to addition another trigger bit, e.g. kMB
      kAny          = 0xffffffff, // to accept any trigger
      kAnyINT       = kMB | kINT7 | kCINT5 | kINT8 | kSPI7 // to accept any interaction (aka minimum bias) trigger
  };

  AliVEvent() { }
  virtual ~AliVEvent() { } 
  AliVEvent(const AliVEvent& vEvnt); 
  AliVEvent& operator=(const AliVEvent& vEvnt);

  // Services
  virtual void AddObject(TObject* obj) = 0;
  virtual TObject* FindListObject(const char *name) const = 0;
  virtual TList* GetList() const = 0;

  virtual void CreateStdContent() = 0;
  virtual void GetStdContent() = 0;

  virtual void ReadFromTree(TTree *tree, Option_t* opt) = 0;
  virtual void WriteToTree(TTree* tree) const = 0;

  virtual void Reset() = 0;
  //virtual void ResetStdContent() = 0;
  virtual void SetStdNames() = 0;

  virtual void Print(Option_t *option="") const = 0;

  // Header
  virtual AliVHeader* GetHeader() const = 0;
  //
  // field initialization
  virtual Bool_t InitMagneticField() const {return kFALSE;}

  // Delegated methods for fESDRun or AODHeader
  
  virtual void     SetRunNumber(Int_t n) = 0;
  virtual void     SetPeriodNumber(UInt_t n) = 0;
  virtual void     SetMagneticField(Double_t mf) = 0;
  
  virtual Int_t    GetRunNumber() const = 0;
  virtual UInt_t   GetPeriodNumber() const = 0;
  virtual Double_t GetMagneticField() const = 0;

  virtual Double_t GetDiamondX() const {return -999.;}
  virtual Double_t GetDiamondY() const {return -999.;}
  virtual void     GetDiamondCovXY(Float_t cov[3]) const
             {cov[0]=-999.; return;}

  // Delegated methods for fHeader
  virtual void      SetOrbitNumber(UInt_t n) = 0;
  virtual void      SetBunchCrossNumber(UShort_t n) = 0;
  virtual void      SetEventType(UInt_t eventType)= 0;
  virtual void      SetTriggerMask(ULong64_t n) = 0;
  virtual void      SetTriggerCluster(UChar_t n) = 0;

  virtual UInt_t    GetOrbitNumber() const = 0;
  virtual UShort_t  GetBunchCrossNumber() const = 0;
  virtual UInt_t    GetEventType()  const = 0;
  virtual ULong64_t GetTriggerMask() const = 0;
  virtual UChar_t   GetTriggerCluster() const = 0;
  virtual TString   GetFiredTriggerClasses() const = 0;
  virtual Double_t  GetZDCN1Energy() const = 0;
  virtual Double_t  GetZDCP1Energy() const = 0;
  virtual Double_t  GetZDCN2Energy() const = 0;
  virtual Double_t  GetZDCP2Energy() const = 0;
  virtual Double_t  GetZDCEMEnergy(Int_t i) const = 0;
 
  // Tracks
  virtual AliVParticle *GetTrack(Int_t i) const = 0;
  //virtual Int_t        AddTrack(const AliVParticle *t) = 0;
  virtual Int_t        GetNumberOfTracks() const = 0;
  virtual Int_t        GetNumberOfV0s() const = 0;
  virtual Int_t        GetNumberOfCascades() const = 0;

  // TOF header and T0 methods
  virtual const AliTOFHeader *GetTOFHeader() const {return NULL;}
  virtual Float_t GetEventTimeSpread() const {return 0.;}
  virtual Float_t GetTOFTimeResolution() const {return 0.;}
  virtual Double32_t GetT0TOF(Int_t icase) const {return 0.0*icase;}
  virtual const Double32_t * GetT0TOF() const {return NULL;}
  virtual Float_t GetT0spread(Int_t /*i*/) const {return 0.;}

  // Calorimeter Clusters/Cells
  virtual AliVCluster *GetCaloCluster(Int_t)   const {return 0;}
  virtual Int_t GetNumberOfCaloClusters()      const {return 0;}
  virtual Int_t GetEMCALClusters(TRefArray *)  const {return 0;}
  virtual Int_t GetPHOSClusters (TRefArray *)  const {return 0;}
  virtual AliVCaloCells *GetEMCALCells()       const {return 0;}
  virtual AliVCaloCells *GetPHOSCells()        const {return 0;}
  const TGeoHMatrix* GetPHOSMatrix(Int_t /*i*/)    const {return NULL;}
  const TGeoHMatrix* GetEMCALMatrix(Int_t /*i*/)   const {return NULL;}
  virtual AliVCaloTrigger *GetCaloTrigger(TString /*calo*/) const {return NULL;} 

	
  // Primary vertex
  virtual const AliVVertex   *GetPrimaryVertex() const {return 0x0;}
  virtual Bool_t IsPileupFromSPD(Int_t /*minContributors*/, 
				 Double_t /*minZdist*/, 
				 Double_t /*nSigmaZdist*/, 
				 Double_t /*nSigmaDiamXY*/, 
				 Double_t /*nSigmaDiamZ*/)
				 const{
    return kFALSE;
  }

  // Tracklets
  virtual AliVMultiplicity* GetMultiplicity() const {return 0;}

  virtual Bool_t IsPileupFromSPDInMultBins() const {
    return kFALSE;    
  }
  virtual AliCentrality* GetCentrality()                          = 0;
  virtual AliEventplane* GetEventplane()                          = 0;
  virtual Int_t        EventIndex(Int_t itrack)             const = 0;
  virtual Int_t        EventIndexForCaloCluster(Int_t iclu) const = 0;
  virtual Int_t        EventIndexForPHOSCell(Int_t icell)   const = 0;
  virtual Int_t        EventIndexForEMCALCell(Int_t icell)  const = 0;  

  virtual AliVVZERO *GetVZEROData() const = 0;   
  virtual const Float_t* GetVZEROEqFactors() const {return NULL;}
  virtual Float_t        GetVZEROEqMultiplicity(Int_t /* i */) const {return -1;}
  virtual void           SetVZEROEqFactors(Float_t /* factors */[64]) const {return;}
  virtual AliVZDC   *GetZDCData() const = 0;

  virtual Int_t GetNumberOfTrdTracks() const { return 0; }
  virtual AliVTrdTrack* GetTrdTrack(Int_t /* iTrack */) const { return 0x0; }

  virtual Int_t     GetNumberOfESDTracks()  const { return 0; }

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