Adding a reminder for coders
[u/mrichter/AliRoot.git] / ANALYSIS / AliPhysicsSelection.h
1 /* $Id: AliPhysicsSelection.h 35782 2009-10-22 11:54:31Z jgrosseo $ */
2
3 #ifndef ALIPHYSICSSELECTION_H
4 #define ALIPHYSICSSELECTION_H
5
6 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
7  * See cxx source for full Copyright notice                               */
8
9 //-------------------------------------------------------------------------
10 //                      Implementation of   Class AliPhysicsSelection
11 // 
12 // This class selects collision candidates from data runs, applying selection cuts on triggers 
13 // and background rejection based on the content of the ESD
14 //
15 //   Origin: Jan Fiete Grosse-Oetringhaus, CERN
16 //           Michele Floris, CERN
17 //-------------------------------------------------------------------------
18
19 #include <AliAnalysisCuts.h>
20 #include <TList.h>
21 #include "TObjString.h"
22 #include "AliVEvent.h"
23 #include "AliLog.h"
24 #include "AliAnalysisManager.h"
25
26 //#define VERBOSE_STAT
27
28 class AliESDEvent;
29 class TH2F;
30 class TH1F;
31 class TCollection;
32 class AliTriggerAnalysis;
33 class AliAnalysisTaskSE;
34 class AliOADBPhysicsSelection ;
35 class AliOADBFillingScheme    ;
36 class AliOADBTriggerAnalysis;
37 class TPRegexp;
38
39 class AliPhysicsSelection : public AliAnalysisCuts
40 {
41 public:
42
43 public:
44   enum {kStatTriggerClass=1,kStatHWTrig,kStatV0ABG,kStatV0CBG,kStatMB1,kStatMB1Prime,kStatLaserCut,kStatFO1,kStatFO2,kStatFO2L1,kStatV0A,kStatV0C,kStatZDCA,kStatZDCC,kStatZDCAC,kStatZDCTime,kStatV0,kStatOffline,kStatBG,kStatAccepted, kStatAcceptedPileUp};
45
46 #ifdef VERBOSE_STAT
47   enum {kStatRowAllB=0, kStatRowAllAC, kStatRowAllE, kStatRowBG,kStatRowAcc,kStatRowBGFrac,kStatRowAccFrac,kStatRowErrGoodFrac,kStatRowGoodFrac,kStatRowErrGood,kStatRowGood}; // offset wrt fBGStatOffset
48 #else
49   enum {kStatRowAllB=0, kStatRowAllAC, kStatRowAllE, kStatRowBG, kStatRowAcc,kStatRowGood}; // offset wrt fBGStatOffset
50 #endif
51
52   enum {kStatIdxAll=0,kStatIdxBin0=1};
53   enum ETriggerLogic { kCINT1 = 0, kCMBS2A, kCMBS2C, kCMBAC, kCMBACS2, kHighMultL1 };
54
55   typedef Bool_t (*Bin0Callback_t)(const AliESDEvent *);
56
57   AliPhysicsSelection();
58   virtual ~AliPhysicsSelection();
59     
60   // AliAnalysisCuts interface
61   virtual UInt_t GetSelectionMask(const TObject* obj) { return IsCollisionCandidate((const AliESDEvent*) obj); }
62   virtual Bool_t IsSelected(TList*) { return kFALSE; }
63   virtual Bool_t IsSelected(TObject*)  {return kFALSE;}
64     
65   Int_t  GetCurrentRun() const {return fCurrentRun;}
66   UInt_t IsCollisionCandidate(const AliESDEvent* aEsd);
67   Bool_t Initialize(const AliESDEvent* aEsd);
68   Bool_t Initialize(Int_t runNumber);
69     
70   void SetAnalyzeMC(Bool_t flag = kTRUE) { fMC = flag; }
71   void SetSkipTriggerClassSelection(Bool_t flag = kTRUE) { fSkipTriggerClassSelection = flag; }
72   void SetSkipV0(Bool_t flag=kTRUE) { AliError ("This method is deprecated! Please change the OADB configuration instead") ; fSkipV0 = flag;}
73    
74   void AddBackgroundIdentification(AliAnalysisCuts* background) { fBackgroundIdentification = background; }
75     
76   virtual void Print(const Option_t* option = "") const;
77   virtual Long64_t Merge(TCollection* list);
78   void SaveHistograms(const char* folder = 0);
79     
80   const TList* GetCollisionTriggerClasses() const { return &fCollTrigClasses; }
81   const TList* GetBGTriggerClasses()        const { return &fBGTrigClasses; }
82   void AddCollisionTriggerClass(const char* className);
83   void AddBGTriggerClass(const char* className)       ;
84   void SetCustomOADBObjects(AliOADBPhysicsSelection * oadbPS, AliOADBFillingScheme * oadbFS, AliOADBTriggerAnalysis * oadbTA = 0) { fPSOADB = oadbPS; fFillOADB = oadbFS; fTriggerOADB = oadbTA; fUsingCustomClasses = kTRUE;}
85   const AliOADBPhysicsSelection * GetOADBPhysicsSelection() const {return fPSOADB;  }
86   const AliOADBFillingScheme    * GetOADBFillingScheme()    const {return fFillOADB;}
87   const AliOADBTriggerAnalysis  * GetOADBTriggerAnalysis()  const {return fTriggerOADB;}
88
89   Int_t GetBGStatOffset() const { return fBGStatOffset; }
90
91
92   AliTriggerAnalysis* GetTriggerAnalysis(Int_t i = 0) { return (fTriggerAnalysis.GetEntries() > 0) ? (AliTriggerAnalysis*) fTriggerAnalysis.At(i) : 0; }    
93     
94   const TH2F* GetStatisticsHistogram(Int_t idx=kStatIdxAll) const { return fHistStatistics[idx]; }
95   const TH2F* GetBunchCrossingHistogram() const { return fHistBunchCrossing; }
96   virtual TObject *GetStatistics(const Option_t *option) const;
97     
98   void SetBIFactors(const AliESDEvent * aESD);
99   
100   void SetUseBXNumbers(Bool_t flag = kTRUE) {fUseBXNumbers = flag;}
101   void SetComputeBG   (UInt_t flag = AliVEvent::kMB) {fComputeBG    = flag; if(flag) fUseBXNumbers = flag;}
102   void SetUseMuonTriggers(Bool_t) { Printf("ERROR: Use of AliPhysicsSelection::SetUseMuonTriggers is deprecated. Use AliVEvent::kMUON selection instead."); }
103   void SetBin0Callback( const char * cb) {fBin0CallBack = cb;} 
104   void SetBin0CallbackViaPointer( Bin0Callback_t cb) {fBin0CallBackPointer = cb;}// WARNING: THIS SHOULD NOT BE USED, WILL BE REMOVED SOON
105   
106   static const char * GetOADBFileName() {   static TString filename; filename.Form("%s/COMMON/PHYSICSSELECTION/data/physicsSelection.root", AliAnalysisManager::GetOADBPath()); return filename.Data();};
107
108 protected:
109   UInt_t CheckTriggerClass(const AliESDEvent* aEsd, const char* trigger, Int_t& triggerLogic) const;
110   Bool_t EvaluateTriggerLogic(const AliESDEvent* aEsd, AliTriggerAnalysis* triggerAnalysis, const char* triggerLogic, Bool_t offline);
111   TH2F * BookHistStatistics(const char * tag) ;
112   Int_t GetStatRow(const char * triggerBXClass, UInt_t offlineTriggerType, UInt_t ** rowIDs) const;
113   const char * GetTriggerString(TObjString * obj);
114
115
116   Int_t fCurrentRun;      // run number for which the object is initialized
117   Bool_t fMC;             // flag if MC is analyzed
118   TList fCollTrigClasses; // trigger class identifying collision candidates
119   TList fBGTrigClasses;   // trigger classes identifying background events
120     
121   TList fTriggerAnalysis; // list of offline trigger objects (several are needed to keep the control histograms separate per trigger class)
122   
123   AliAnalysisCuts* fBackgroundIdentification; // class that performs additional background identification
124     
125   TH2F* fHistStatistics[2];      // how many events are cut away why {all,bin 0}
126   //  TH2F* fHistStatisticsTokens;   // how many events are cut away why (new version, bins for all tokens. Only used tokens are filled)
127   TH2F* fHistBunchCrossing;   // histograms of accepted bunch crossing numbers
128   TH1F* fHistTriggerPattern;  // Pattern of the individual detectors in the MB1 trigger. Can reveal inconsistencies/inefficiencies in the trigger 
129     
130   Bool_t fSkipTriggerClassSelection;  // flag that determines if the trigger classs selection is skipped
131   Bool_t fUsingCustomClasses;         // flag that is set if costum trigger classes are defined
132   Bool_t fSkipV0;                     // ignore information from v0
133
134   Float_t fBIFactorA;                 // ratio of interacting over non interacting bunch intensities for beam 1
135   Float_t fBIFactorC;                 // ratio of interacting over non interacting bunch intensities for beam 2
136   Float_t fBIFactorAC;                // ratio of interacting over non interacting bunch intensities for beam 1&2: 
137                                       // for some trigger classes we do not distinguish betweem 1 and 2
138
139
140   UInt_t fComputeBG; // Switch on computation of background and filling of relevant stat table entries. If you enable this you can only process one run at a time (the relative bunch intensity used to compute this chages from run to run); This is a mask of the trigger types to be used in the selection, as defined in AliVEvent
141   Int_t fBGStatOffset; // Offset of the BG statistics computed at the end of the processing. It depends on how many trigger classes you have selected
142   Bool_t fUseBXNumbers; // Explicitely select "good" bunch crossing numbers (exclude pilot, afterpulses and fakes). If you anable this you can only process  runs within the same filling scheme.
143   Bool_t fUseMuonTriggers;      // if true, also use the muon triggers
144   TString fFillingScheme; // stores the filling scheme of the current run.
145
146   TString fBin0CallBack; // callback used to determine if an event is in the bin0 (name of the task where the callback is implemented);
147   Bin0Callback_t fBin0CallBackPointer; //! don't stream this. TO BE REMOVED SOON
148
149   Bool_t fIsPP; // True if processing pp run, false if heavy ion
150
151   AliOADBPhysicsSelection * fPSOADB; // Physics selection OADB object
152   AliOADBFillingScheme    * fFillOADB; // Filling scheme OADB object
153   AliOADBTriggerAnalysis  * fTriggerOADB; // Trigger analysis OADB object
154
155   TPRegexp* fRegexp; //! regular expression for trigger tokens
156   TList* fCashedTokens; //! trigger token lookup list
157
158   ClassDef(AliPhysicsSelection, 15)
159     
160     private:
161   AliPhysicsSelection(const AliPhysicsSelection&);
162   AliPhysicsSelection& operator=(const AliPhysicsSelection&);
163 };
164
165 #endif