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