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