Extending the functionality of the physics selection. Instead of providing a yes...
[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
23 #define VERBOSE_STAT
24
25 class AliESDEvent;
26 class TH2F;
27 class TH1F;
28 class TCollection;
29 class AliTriggerAnalysis;
30 class AliAnalysisTaskSE;
31
32 class AliPhysicsSelection : public AliAnalysisCuts
33 {
34 public:
35
36 public:
37   enum {kStatTriggerClass=1,kStatHWTrig,kStatV0ABG,kStatV0CBG,kStatMB1,kStatMB1Prime,kStatFMD,kStatFO1,kStatFO2,kStatV0A,kStatV0C,kStatSSD1,kStatFO1AndV0,kStatV0,kStatAny2Hits,kStatOffline,kStatBG,kStatAccepted};
38
39 #ifdef VERBOSE_STAT
40   enum {kStatRowBG=5,kStatRowAcc,kStatRowBGFrac,kStatRowAccFrac,kStatRowErrGoodFrac,kStatRowGoodFrac,kStatRowErrGood,kStatRowGood};
41 #else
42   enum {kStatRowBG=5,kStatRowAcc,kStatRowGood};
43 #endif
44
45   enum {kStatIdxAll=0,kStatIdxBin0=1};
46
47
48   typedef Bool_t (*Bin0Callback_t)(const AliESDEvent *);
49
50   AliPhysicsSelection();
51   virtual ~AliPhysicsSelection();
52     
53   // AliAnalysisCuts interface
54   virtual UInt_t GetSelectionMask(const TObject* obj) { return IsCollisionCandidate((const AliESDEvent*) obj); }
55   virtual Bool_t IsSelected(TList*) { return kFALSE; }
56   virtual Bool_t IsSelected(TObject*)  {return kFALSE;}
57     
58   UInt_t IsCollisionCandidate(const AliESDEvent* aEsd);
59   Bool_t Initialize(Int_t runNumber);
60     
61   void SetAnalyzeMC(Bool_t flag = kTRUE) { fMC = flag; }
62   void SetSkipTriggerClassSelection(Bool_t flag = kTRUE) { fSkipTriggerClassSelection = flag; }
63   void SetSkipV0(Bool_t flag=kTRUE) { fSkipV0 = flag;}
64    
65   void AddBackgroundIdentification(AliAnalysisCuts* background) { fBackgroundIdentification = background; }
66     
67   virtual void Print(Option_t* option = "") const;
68   virtual Long64_t Merge(TCollection* list);
69   void SaveHistograms(const char* folder = 0) const;
70     
71   const TList* GetCollisionTriggerClasses() const { return &fCollTrigClasses; }
72   const TList* GetBGTriggerClasses()        const { return &fBGTrigClasses; }
73   void AddCollisionTriggerClass(const char* className){ fCollTrigClasses.Add(new TObjString(className)); fUsingCustomClasses = kTRUE; }
74   void AddBGTriggerClass(const char* className)       { fBGTrigClasses.Add(new TObjString(className));  fUsingCustomClasses = kTRUE; }
75   
76   AliTriggerAnalysis* GetTriggerAnalysis(Int_t i = 0) { return (fTriggerAnalysis.GetEntries() > 0) ? (AliTriggerAnalysis*) fTriggerAnalysis.At(i) : 0; }    
77     
78   const TH2F* GetStatisticsHistogram(Int_t idx=kStatIdxAll) const { return fHistStatistics[idx]; }
79   const TH2F* GetBunchCrossingHistogram() const { return fHistBunchCrossing; }
80     
81   void SetBIFactors(Int_t run);
82   
83   void SetUseBXNumbers(Bool_t flag = kTRUE) {fUseBXNumbers = flag;}
84   void SetComputeBG   (Bool_t flag = kTRUE) {fComputeBG    = flag; if(flag) fUseBXNumbers = flag;}
85   void SetUseMuonTriggers(Bool_t flag = kTRUE) {fUseMuonTriggers = flag;}
86   void SetBin0Callback( const char * cb) {fBin0CallBack = cb;} 
87   void SetBin0CallbackViaPointer( Bin0Callback_t cb) {fBin0CallBackPointer = cb;}// WARNING: THIS SHOULD NOT BE USED, WILL BE REMOVED SOON
88   
89
90 protected:
91   UInt_t CheckTriggerClass(const AliESDEvent* aEsd, const char* trigger) const;
92   Int_t GetTriggerScheme(UInt_t runNumber) const;
93   const char * GetBXIDs(UInt_t runNumber, const char * trigger ) ;
94   const char * GetFillingScheme(UInt_t runNumber) ;
95   TH2F * BookHistStatistics(const char * tag) ;
96
97   Int_t fCurrentRun;      // run number for which the object is initialized
98   Bool_t fMC;             // flag if MC is analyzed
99   TList fCollTrigClasses; // trigger class identifying collision candidates
100   TList fBGTrigClasses;   // trigger classes identifying background events
101     
102   TList fTriggerAnalysis; // list of offline trigger objects (several are needed to keep the control histograms separate per trigger class)
103   
104   AliAnalysisCuts* fBackgroundIdentification; // class that performs additional background identification
105     
106   TH2F* fHistStatistics[2];      // how many events are cut away why {all,bin 0}
107   TH2F* fHistBunchCrossing;   // histograms of accepted bunch crossing numbers
108   TH1F* fHistTriggerPattern;  // Pattern of the individual detectors in the MB1 trigger. Can reveal inconsistencies/inefficiencies in the trigger 
109     
110   Bool_t fSkipTriggerClassSelection;  // flag that determines if the trigger classs selection is skipped
111   Bool_t fUsingCustomClasses;         // flag that is set if costum trigger classes are defined
112   Bool_t fSkipV0;                     // ignore information from v0
113
114   Float_t fBIFactorA;                 // ratio of interacting over non interacting bunch intensities for beam 1
115   Float_t fBIFactorC;                 // ratio of interacting over non interacting bunch intensities for beam 2
116
117
118   Bool_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)
119   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.
120   Bool_t fUseMuonTriggers;      // if true, also use the muon triggers
121   TString fFillingScheme; // stores the filling scheme of the current run.
122
123   TString fBin0CallBack; // callback used to determine if an event is in the bin0 (name of the task where the callback is implemented);
124   Bin0Callback_t fBin0CallBackPointer; //! don't stream this. TO BE REMOVED SOON
125
126   ClassDef(AliPhysicsSelection, 9)
127     
128     private:
129   AliPhysicsSelection(const AliPhysicsSelection&);
130   AliPhysicsSelection& operator=(const AliPhysicsSelection&);
131 };
132
133 #endif