Modifications needed to use PID framework based mass during tracking and
[u/mrichter/AliRoot.git] / STEER / STEER / AliReconstruction.h
1 #ifndef ALIRECONSTRUCTION_H
2 #define ALIRECONSTRUCTION_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id: AliReconstruction.h 63911 2013-08-19 16:46:41Z hristov $ */
7
8 ///////////////////////////////////////////////////////////////////////////////
9 //                                                                           //
10 // class for running the reconstruction                                      //
11 // Clusters and tracks are created for all detectors and all events by       //
12 // typing:                                                                   //
13 //                                                                           //
14 //   AliReconstruction rec;                                                  //
15 //   rec.Run();                                                              //
16 //                                                                           //
17 ///////////////////////////////////////////////////////////////////////////////
18
19
20 #include <TSelector.h>
21 #include <TString.h>
22 #include <TObjArray.h>
23
24 class AliReconstructor;
25 class AliRunLoader;
26 class AliRawReader;
27 class AliLoader;
28 class AliTracker;
29 class AliMagF;
30 class AliVertexer;
31 class AliTrackleter;
32 class AliESDVertex;
33 class AliESDEvent;
34 class AliESDfriend;
35 class AliESDpid;
36 class AliVertexerTracks;
37 class TFile;
38 class TTree;
39 class TList;
40 class AliQAManager; 
41 class TMap;
42 class AliRecoParam;
43 class AliDetectorRecoParam;
44 class AliRunInfo;
45 class AliGRPObject;
46 class THashTable;
47 class AliTriggerRunScalers;
48 class AliCTPTimeParams;
49 class AliAnalysisManager;
50 class AliRecoInputHandler;
51
52 #include "AliQAv1.h"
53 #include "AliEventInfo.h"
54 #include "AliRecoParam.h"
55
56 using std::ofstream;
57
58 class AliReconstruction: public TSelector {
59 public:
60   AliReconstruction(const char* gAliceFilename = "galice.root");
61   virtual ~AliReconstruction();
62
63   void           SetGAliceFile(const char* fileName);
64   void           SetInput(const char* input);
65   void           SetOutput(const char* output);
66
67   void           SetEquipmentIdMap(const char *mapFile) {fEquipIdMap = mapFile;};
68   void           SetEventRange(Int_t firstEvent = 0, Int_t lastEvent = -1) 
69     {fFirstEvent = firstEvent; fLastEvent = lastEvent;};
70   void           SetNumberOfEventsPerFile(UInt_t nEvents)
71     {fNumberOfEventsPerFile = nEvents;};
72   void           SetFractionFriends(Double32_t frac = 0.04)
73     {fFractionFriends = frac;};
74   void           SetOption(const char* detector, const char* option);
75   void           SetRecoParam(const char* detector, AliDetectorRecoParam *par);
76
77   void           SetRunLocalReconstruction(const char* detectors) {
78     fRunLocalReconstruction = detectors;};
79   void           SetRunTracking(const char* detectors) {
80     fRunTracking = detectors;};
81   void           SetFillESD(const char* detectors) {fFillESD = detectors;};
82   void           SetRunReconstruction(const char* detectors) {
83     SetRunLocalReconstruction(detectors); 
84     SetRunTracking(detectors);
85     SetFillESD(detectors);};
86   void           SetDeleteRecPoints(const char* dets) {fDeleteRecPoints = dets;}
87   void           SetDeleteDigits(const char* dets)    {fDeleteDigits = dets;}
88   void           SetUseTrackingErrorsForAlignment(const char* detectors) 
89     {fUseTrackingErrorsForAlignment = detectors;};
90   void           SetLoadAlignFromCDB(Bool_t load)  {fLoadAlignFromCDB = load;};
91   void           SetLoadAlignData(const char* detectors) 
92     {fLoadAlignData = detectors;};
93
94   void           SetTreeBuffSize(Long64_t sz=30000000) {fTreeBuffSize = sz;}
95   //*** Global reconstruction flag setters
96   void SetRunMultFinder(Bool_t flag=kTRUE) {fRunMultFinder=flag;};
97   void SetRunVertexFinder(Bool_t flag=kTRUE) {fRunVertexFinder=flag;};
98   void SetRunVertexFinderTracks(Bool_t flag=kTRUE) {fRunVertexFinderTracks=flag;};
99   void SetRunV0Finder(Bool_t flag=kTRUE) {fRunV0Finder=flag;};
100   void SetRunCascadeFinder(Bool_t flag=kTRUE) {fRunCascadeFinder=flag;};
101   void SetStopOnError(Bool_t flag=kTRUE) {fStopOnError=flag;}
102   void SetStopOnMissingTriggerFile(Bool_t flag=kTRUE) {fStopOnMissingTriggerFile=flag;}
103   void SetWriteAlignmentData(Bool_t flag=kTRUE){fWriteAlignmentData=flag;}
104   void SetWriteESDfriend(Bool_t flag=kTRUE){fWriteESDfriend=flag;}
105   void SetFillTriggerESD(Bool_t flag=kTRUE){fFillTriggerESD=flag;}
106   void SetDiamondProfileSPD(AliESDVertex *dp) {fDiamondProfileSPD=dp;}
107   void SetDiamondProfile(AliESDVertex *dp) {fDiamondProfile=dp;}
108   void SetDiamondProfileTPC(AliESDVertex *dp) {fDiamondProfileTPC=dp;}
109                    
110   void SetCleanESD(Bool_t flag=kTRUE){fCleanESD=flag;}
111   void SetUseHLTData(const char* detectors){fUseHLTData=detectors;}
112   void SetV0DCAmax(Float_t d) {fV0DCAmax=d;}
113   void SetV0CsPmin(Float_t d) {fV0CsPmin=d;}
114   void SetDmax(Float_t d) {fDmax=d;}
115   void SetZmax(Float_t z) {fZmax=z;}
116   Float_t GetV0DCAmax() const {return fV0DCAmax;}
117   Float_t GetV0CsPmin() const {return fV0CsPmin;}
118   Float_t GetDmax() const {return fDmax;}
119   Float_t GetZmax() const {return fZmax;}
120   
121   Bool_t HasNextEventAfter(Int_t eventId);
122   
123   //
124   Bool_t  IsRunMultFinder()   const {return fRunMultFinder;}
125   
126   // CDB storage activation
127   void SetDefaultStorage(const char* uri);
128   void SetSpecificStorage(const char* calibType, const char* uri);
129   void SetCDBSnapshotMode(const char* snapshotFileName);
130
131   Bool_t MisalignGeometry(const TString& detectors);
132
133   void           SetAlignObjArray(TObjArray *array)
134                    {fAlignObjArray = array;
135                    fLoadAlignFromCDB = kFALSE;}
136
137   virtual Int_t  Version() const {return 2;}
138   virtual void   Begin(TTree*);
139   virtual void   SlaveBegin(TTree*);
140   virtual void   Init(TTree *tree);
141   virtual Bool_t Process(Long64_t entry);
142   virtual Bool_t ProcessEvent(Int_t iEvent);
143   virtual void   SlaveTerminate();
144   virtual void   Terminate();
145   virtual Bool_t Run(const char* input = NULL);
146   void           Abort(const char *method, EAbort what);
147   virtual void   SetOption(const char* option) {
148     TSelector::SetOption(option);
149   }
150
151   // Trackers
152   AliTracker* GetTracker(Int_t idx) const { return fTracker[idx]; }
153   Bool_t      CreateTrackers(const TString& detectors);
154   void        ImportRunLoader(AliRunLoader* rl) { fRunLoader = rl; }
155
156   // Quality Assurance 
157   void    SetQACycles(AliQAv1::DETECTORINDEX_t det, Int_t cycles) { fQACycles[det] = cycles ; }
158   void    SetQAWriteExpert(AliQAv1::DETECTORINDEX_t det) { fQAWriteExpert[det] = kTRUE ; }
159   Bool_t  SetRunQA(TString detAndAction="ALL:ALL") ; 
160   void    SetRunGlobalQA(Bool_t flag=kTRUE){fRunGlobalQA = flag;}
161   void    SetQARefDefaultStorage(const char* uri);
162   void    InitQA();
163   void    MergeQA(const char *fileName = NULL); 
164   void    SetWriteQAExpert() { fWriteQAExpertData = kTRUE ; }
165   Bool_t  IsRunQA() const { return fRunQA ; } 
166   Bool_t  IsRunGlobalQA() const { return fRunGlobalQA ; }
167   Bool_t  IsInTasks(AliQAv1::TASKINDEX_t tsk) { return fQATasks.Contains(Form("%d", tsk)) ; }
168   
169   // Plane Efficiency Evaluation
170   void    SetRunPlaneEff(Bool_t flag=kFALSE)  {fRunPlaneEff = flag;}
171
172   enum {
173 // #ifdef MFT_UPGRADE 
174 //     kNDetectors = 16   // number of detectors
175 // #else
176 //     kNDetectors = 15   // number of detectors
177 // #endif 
178     //kNDetectors = 16   // number of detectors    // AU
179     kNDetectors = 17   // number of detectors    + AD
180   };
181   static Int_t   GetDetIndex(const char * detector);
182   static const char** GetDetectorNames() { return fgkDetectorName; }
183
184   // Upgrade
185  void SetUpgradeModule(const char* detectors)  {fUpgradeModule = detectors; MatchUpgradeDetector() ; }
186  void MatchUpgradeDetector();
187
188   // Connection to analysis manager. 
189   // If a macro is set it should contain a function returning an analysis 
190   // manager object. The macro is ignored in case the analysis manager is 
191   // set via SetAnalysisManager
192   void        SetAnalysisMacro(const char *macropath) {fAnalysisMacro = macropath;}
193   const char *GetAnalysisMacro() const {return fAnalysisMacro.Data();}
194   void        SetAnalysisManager(AliAnalysisManager *mgr) {fAnalysis = mgr;}
195   AliAnalysisManager *GetAnalysisManager() const {return fAnalysis;}
196
197   // A method to declare defined trigger classes even if they are not
198   // present in the run, needed for proper event selection based on trigger
199   void        DeclareTriggerClasses(const char *trClasses) {fDeclTriggerClasses = trClasses;}
200   //
201   //
202   void                                   CleanProcessedEvent();
203    
204   AliESDEvent* GetESDEvent() const { return fesd; }
205   AliESDfriend* GetESDfriend() const { return fesdf; }
206   AliRunLoader* GetRunLoader() const { return fRunLoader;}
207   AliRawReader* GetRawReader() const { return fRawReader; }
208   
209   Bool_t       HasEnoughResources(int ev);
210   void         SetStopOnResourcesExcess(int vRSS=3000,int vVMEM=4000);
211   //
212   //
213   virtual Bool_t ProcessEvent(void* event);
214   void           InitRun(const char* input);
215
216 protected:
217   // Functions needed to select events for which we store the ESD friends
218   Bool_t IsHighPt() const;
219   Bool_t IsCosmicOrCalibSpecie() const;
220   void WriteESDfriend();
221
222 private:
223   AliReconstruction(const AliReconstruction& rec);
224   AliReconstruction& operator = (const AliReconstruction& rec);
225
226   void           InitRawReader(const char* input);
227   void           InitCDB();
228   Bool_t         InitGRP();
229   void           SetCDBLock();
230   Bool_t         SetRunNumberFromData();
231   Bool_t         LoadCDB();
232   Bool_t         LoadTriggerScalersCDB();
233   Bool_t         LoadCTPTimeParamsCDB();
234   Bool_t         ReadIntensityInfoCDB();
235   Bool_t         RunLocalEventReconstruction(const TString& detectors);
236   Bool_t         RunVertexFinder(AliESDEvent*& esd);
237   Bool_t         RunMuonTracking(AliESDEvent*& esd);
238   Bool_t         RunSPDTrackleting(AliESDEvent*& esd);
239   Bool_t         RunMultFinder(AliESDEvent*& esd);
240   Bool_t         RunTracking(AliESDEvent*& esd, AliESDpid &PID);
241   Bool_t         CleanESD(AliESDEvent *esd);
242   Bool_t         FillESD(AliESDEvent*& esd, const TString& detectors);
243   Bool_t         FillTriggerESD(AliESDEvent*& esd);
244   Bool_t         FillTriggerScalers(AliESDEvent*& esd);
245   Bool_t         FillRawEventHeaderESD(AliESDEvent*& esd);
246   void           DeleteRecPoints(const TString& detectors);
247   void           DeleteDigits(const TString& detectors);
248
249   Bool_t         IsSelected(TString detName, TString& detectors) const;
250   Bool_t         InitRunLoader();
251   AliReconstructor* GetReconstructor(Int_t iDet);
252   AliVertexer*   CreateVertexer();
253   AliTrackleter* CreateMultFinder();
254   void           CleanUp();
255
256   Bool_t         ParseOutput();
257
258   //==========================================//
259   void           WriteAlignmentData(AliESDEvent* esd);
260
261   void           FillRawDataErrorLog(Int_t iEvent, AliESDEvent* esd);
262
263   //Quality Assurance
264   //  void                 CheckQA() ;
265
266   // Plane Efficiency evaluation
267   Bool_t  FinishPlaneEff(); //ultimate tasks related to Plane Eff. evaluation 
268   Bool_t  InitPlaneEff();   // initialize what is needed for Plane Eff. evaluation
269
270   Bool_t               InitAliEVE();
271   void                 RunAliEVE();
272
273   Bool_t         InitRecoParams(); // init the array with the reconstruciton parameters
274   Bool_t         GetEventInfo();   // fill the event info inside the event loop
275
276   const char    *MatchDetectorList(const char *detectorList, UInt_t detectorMask);
277
278   //*** Global reconstruction flags *******************
279   Bool_t         fRunVertexFinder;    // run the vertex finder
280   Bool_t         fRunVertexFinderTracks;    // run the vertex finder with tracks
281   Bool_t         fRunMuonTracking;    // run the MUON tracking
282   Bool_t         fRunV0Finder;        // run the ESD V0 finder
283   Bool_t         fRunCascadeFinder;   // run the ESD cascade finder
284   Bool_t         fRunMultFinder;      // run the trackleter for ITS clusters
285   Bool_t         fStopOnError;        // stop or continue on errors
286   Bool_t         fStopOnMissingTriggerFile; // stop if the simulated trigger file is absent
287   Bool_t         fWriteAlignmentData; // write track space-points flag
288   Bool_t         fWriteESDfriend;     // write ESD friend flag
289   Bool_t         fFillTriggerESD;     // fill trigger info into ESD
290
291   //*** Clean ESD flag and parameters *******************
292   Bool_t         fCleanESD;      // clean ESD flag
293   Float_t        fV0DCAmax;      // max. allowed DCA between V0 daugthers 
294   Float_t        fV0CsPmin;      // min. allowed cosine of V0 pointing angle 
295   Float_t        fDmax;          // max. allowed transverse impact parameter 
296   Float_t        fZmax;          // max. allowed longitudinal impact parameter 
297
298   TString        fRunLocalReconstruction; // run the local reconstruction for these detectors
299   TString        fRunTracking;        // run the tracking for these detectors
300   TString        fFillESD;            // fill ESD for these detectors
301   TString        fDeleteRecPoints;    // delete recpoints after each event
302   TString        fDeleteDigits;       // delete digits after each event
303   TString        fLoadCDB;            // prefetch CDB entries and init reco-params for these detectors
304   TString        fUseTrackingErrorsForAlignment; // for these detectors
305   TString        fGAliceFileName;     // name of the galice file
306   TString        fRawInput;           // name of input raw-data file or directory
307   TString        fESDOutput;          //! name of output ESD file
308   TString        fProofOutputFileName;//! name of output file in PROOF mode
309   TString        fProofOutputLocation;//! output location in PROOF mode
310   Bool_t         fProofOutputDataset; //! keep output file in PROOF mode in dataset or merge
311   TString        fProofOutputArchive; //! list of file to be kept in output zip archive in PROOF mode
312   TString        fEquipIdMap;         // name of file with equipment id map
313   Int_t          fFirstEvent;         // index of first event to be reconstr.
314   Int_t          fLastEvent;          // index of last event to be reconstr.
315   UInt_t         fNumberOfEventsPerFile; // number of events per file in case of raw-data reconstruction
316   Double32_t     fFractionFriends; // fraction of ESD friends to be stored
317   TObjArray      fOptions;            // options for reconstructor objects
318   Bool_t         fLoadAlignFromCDB;   // Load alignment data from CDB and apply it to geometry or not
319   TString        fLoadAlignData;      // Load alignment data from CDB for these detectors
320   TString        fUseHLTData;        // Detectors for which the HLT data is used as input
321   AliRunInfo*    fRunInfo;            // an object which contains essential global conditions information
322   AliEventInfo   fEventInfo;          // an object which contains essential event information
323   AliTriggerRunScalers* fRunScalers;  // an object which contains the trigger counters for xsection
324   AliCTPTimeParams* fCTPTimeParams;   // an object which contains the trigger delays
325   AliCTPTimeParams* fCTPTimeAlign;    // an object which contains the CTP (mis)alignment data
326   AliRunLoader*  fRunLoader;          //! current run loader object
327   AliRawReader*  fRawReader;          //! current raw data reader
328   AliRawReader*  fParentRawReader;    //! parent raw data reader in case of AliRawReaderHLT
329
330   static const char* fgkDetectorName[kNDetectors]; //! names of detectors
331   AliReconstructor*  fReconstructor[kNDetectors];  //! array of reconstructor objects
332   AliRecoParam   fRecoParam;                      // container for the reco-param objects for detectors
333   AliLoader*     fLoader[kNDetectors];   //! detector loaders
334   AliTracker*    fTracker[kNDetectors];  //! trackers
335   AliTracker*    fSPDTrackleter;           //! trackleter [for SPD Plane Efficiency purposes]
336   AliESDVertex*  fDiamondProfileSPD;       // (x,y) diamond profile from SPD for AliITSVertexer3D(Z)
337   AliESDVertex*  fDiamondProfile;          // (x,y) diamond profile for AliVertexerTracks (ITS+TPC)
338   AliESDVertex*  fDiamondProfileTPC;       // (x,y) diamond profile from TPC for AliVertexerTracks
339   THashTable*    fListOfCosmicTriggers;    // list of cosmic triggers as defined by trigger coordination
340
341   AliGRPObject*  fGRPData;              // Data from the GRP/GRP/Data CDB folder
342
343   TObjArray*     fAlignObjArray;      //! array with the alignment objects to be applied to the geometry
344
345   TString        fCDBUri;             //! Uri of the default CDB storage
346   TString        fQARefUri;         //! Uri of the default QA reference storage
347   TObjArray      fSpecCDBUri;         //! Array with detector specific CDB storages
348   Bool_t         fInitCDBCalled;               //! flag to check if CDB storages are already initialized
349   Bool_t         fCDBSnapshotMode;             //! flag true if we are setting the CDB Manager in snapshot mode
350   Bool_t         fSetRunNumberFromDataCalled;  //! flag to check if run number is already loaded from run loader
351
352   //Quality Assurance
353   Int_t  fQACycles[     AliQAv1::kNDET];  // # events over which QA data are accumulated
354   Bool_t fQAWriteExpert[AliQAv1::kNDET];  // Flag to save or not expert QA data
355   TString               fQADetectors ;  // list of detectors to be QA'ed        
356   TString               fQATasks ;      // list of QA tasks to be performed     
357   Bool_t                fRunQA ;        // Run QA flag
358   Bool_t                fRunGlobalQA;   // Run global QA flag
359   Bool_t                fSameQACycle;   //! open a new QA data file or not
360   Bool_t                fInitQACalled;  //! control of QA intialisation
361   Bool_t                fWriteQAExpertData ; //! decides wheter or not to write experts QA data; true by default
362
363   // Plane Efficiency Evaluation
364   Bool_t         fRunPlaneEff ;      // Evaluate Plane Efficiency
365
366   // PID
367   AliESDpid*     fESDpid;                      // PID object
368
369   // New members needed in order to split Run method
370   // into InitRun,RunEvent,FinishRun methods
371   AliESDEvent*         fesd;        //! Pointer to the ESD event object
372   AliESDEvent*         fhltesd;     //! Pointer to the HLT ESD event object
373   AliESDfriend*        fesdf;       //! Pointer to the ESD friend object
374   TFile*               ffile;       //! Pointer to the ESD file
375   TFile*               ffileF;      //! Pointer to the ESD friend file
376   TTree*               ftree;       //! Pointer to the ESD tree
377   TTree*               ftreeF;      //! Pointer to the ESD friend tree
378   TTree*               fhlttree;    //! Pointer to the HLT ESD tree
379   AliVertexerTracks*   ftVertexer;  //! Pointer to the vertexer based on ESD tracks
380   Bool_t               fIsNewRunLoader; // galice.root created from scratch (real raw data case)
381   Bool_t               fRunAliEVE;  // Run AliEVE or not
382   Double_t             fBeamInt[2][2]; //! mean beam intensities from AliLHCData
383   
384   TTree*              fChain;      //! The raw-data chain in case of AliRawReaderChain
385
386   // Counters used in WriteESDfriend()
387   Int_t fNall;    //! Number of reconstructed events
388   Int_t fNspecie; //! Number of events, selected by IsCosmicOrCalibSpecie
389   Int_t fSspecie; //! Number of events, sampled from fNspecie
390   Int_t fNhighPt; //! Number of events, selected by IsHighPt 
391   Int_t fShighPt; //! Number of events, sampled from fNhighPt
392  
393   // Counters for SetAutoFlush configuration
394   Long64_t fTreeBuffSize;   //  allowed uncompressed buffer size per tree
395   Long64_t fMemCountESD;    //! accumulated ESD size before AutoSave 
396   Long64_t fMemCountESDF;   //! accumulated ESD size before AutoSave 
397   Long64_t fMemCountESDHLT; //! accumulated ESD size before AutoSave 
398   //
399   // Upgrade detector reconstruction
400   TString fUpgradeModule;
401   Bool_t  fUpgradeMask[kNDetectors];
402   // Connect an analysis manager in the event loop
403   TString              fAnalysisMacro; // Full path to a macro creating an analysis manager train
404   AliAnalysisManager  *fAnalysis;      //! Analysis manager
405   AliRecoInputHandler *fRecoHandler;   //! Input handler adapted for reconstruction
406   TString              fDeclTriggerClasses; // Declared defined trigger classes
407   //
408   Bool_t               fStopped;        //  flag that reco is stopped due to the limited resources 
409   Int_t                fMaxRSS;         //  max RSS memory, MB
410   Int_t                fMaxVMEM;        //  max VMEM memory, MB
411   static const char*   fgkStopEvFName;  //  filename for stop.event stamp
412   //
413   ClassDef(AliReconstruction, 47)      // class for running the reconstruction
414 };
415
416 #endif