AliReconstruction.h

Go to the documentation of this file.

#ifndef ALIRECONSTRUCTION_H
#define ALIRECONSTRUCTION_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id: AliReconstruction.h 63911 2013-08-19 16:46:41Z hristov $ */

//                                                                           //
// class for running the reconstruction                                      //
// Clusters and tracks are created for all detectors and all events by       //
// typing:                                                                   //
//                                                                           //
//   AliReconstruction rec;                                                  //
//   rec.Run();                                                              //
//                                                                           //


#include <TSelector.h>
#include <TString.h>
#include <TObjArray.h>

class AliReconstructor;
class AliRunLoader;
class AliRawReader;
class AliLoader;
class AliTracker;
class AliMagF;
class AliVertexer;
class AliTrackleter;
class AliESDVertex;
class AliESDEvent;
class AliESDfriend;
class AliESDpid;
class AliVertexerTracks;
class TFile;
class TTree;
class TList;
class AliQAManager; 
class TMap;
class AliRecoParam;
class AliDetectorRecoParam;
class AliRunInfo;
class AliGRPObject;
class THashTable;
class AliTriggerRunScalers;
class AliCTPTimeParams;
class AliAnalysisManager;
class AliRecoInputHandler;
class THashList;
class AliMCEventHandler;
class AliGRPRecoParam;

#include "AliQAv1.h"
#include "AliEventInfo.h"
#include "AliRecoParam.h"

using std::ofstream;

class AliReconstruction: public TSelector {
public:
  AliReconstruction(const char* gAliceFilename = "galice.root");
  virtual ~AliReconstruction();

  void           SetGAliceFile(const char* fileName);
  void           SetInput(const char* input);
  void           SetOutput(const char* output);

  void           SetEquipmentIdMap(const char *mapFile) {fEquipIdMap = mapFile;};
  void           SetEventRange(Int_t firstEvent = 0, Int_t lastEvent = -1) 
    {fFirstEvent = firstEvent; fLastEvent = lastEvent;};
  void           SetNumberOfEventsPerFile(UInt_t nEvents)
    {fNumberOfEventsPerFile = nEvents;};
  void           SetFractionFriends(Double_t frac = 0.04)    {fFractionFriends = frac;};
  void           SetFractionHLTESD(Double_t frac = 0.05)   {fFractionHLTESD = frac;};
  void           SetSkipFriendsForLargeZ(Bool_t v)           {fSkipFriendsForLargeZ=v;}
  void           SetMaxFriendTracks(Int_t n)                 {fMaxFriendTracks = n;}
  void           SetSkipFriendsCutZ(double z)                {fSkipFriendsCutZ = z;}
  //
  Double_t       GetFractionHLTESD()             const     {return fFractionHLTESD;};
  Double_t       GetFractionFriends()              const     {return fFractionFriends;};
  Bool_t         GetSkipFriendsForLargeZ()         const     {return fSkipFriendsForLargeZ;}
  Int_t          GetMaxFriendTracks()              const     {return fMaxFriendTracks;}
  Double_t       GetSkipFriendsCutZ()              const     {return fSkipFriendsCutZ;}
  //
  void           SetOption(const char* detector, const char* option);
  void           SetRecoParam(const char* detector, AliDetectorRecoParam *par);

  void           SetCosmicAlias(const char* nm="kCosmic") {fCosmicAlias = nm;}
  void           SetLaserAlias(const char* nm="kCalibLaser") {fLaserAlias = nm;}

  TString&       GetCosmicAlias() const {return (TString&)fCosmicAlias;}
  TString&       GetLaserAlias()  const {return (TString&)fLaserAlias;}

  void           SetRunLocalReconstruction(const char* detectors) {
    fRunLocalReconstruction = detectors;};
  void           SetRunTracking(const char* detectors) {
    fRunTracking = detectors;};
  void           SetFillESD(const char* detectors) {fFillESD = detectors;};
  void           SetRunReconstruction(const char* detectors) {
    SetRunLocalReconstruction(detectors); 
    SetRunTracking(detectors);
    SetFillESD(detectors);};
  void           SetDeleteRecPoints(const char* dets) {fDeleteRecPoints = dets;}
  void           SetDeleteDigits(const char* dets)    {fDeleteDigits = dets;}
  void           SetUseTrackingErrorsForAlignment(const char* detectors) 
    {fUseTrackingErrorsForAlignment = detectors;};
  void           SetLoadAlignFromCDB(Bool_t load)  {fLoadAlignFromCDB = load;};
  void           SetLoadAlignData(const char* detectors) 
    {fLoadAlignData = detectors;};

  void           SetRun1PIDforTracking(Bool_t val=kTRUE);
  void           SetTreeBuffSize(Long64_t sz=30000000) {fTreeBuffSize = sz;}
  //*** Global reconstruction flag setters
  void SetRunMultFinder(Bool_t flag=kTRUE) {fRunMultFinder=flag;};
  void SetRunVertexFinder(Bool_t flag=kTRUE) {fRunVertexFinder=flag;};
  void SetRunVertexFinderTracks(Bool_t flag=kTRUE) {fRunVertexFinderTracks=flag;};
  void SetRunV0Finder(Bool_t flag=kTRUE) {fRunV0Finder=flag;};
  void SetRunCascadeFinder(Bool_t flag=kTRUE) {fRunCascadeFinder=flag;};
  void SetStopOnError(Bool_t flag=kTRUE) {fStopOnError=flag;}
  void SetStopOnMissingTriggerFile(Bool_t flag=kTRUE) {fStopOnMissingTriggerFile=flag;}
  void SetWriteAlignmentData(Bool_t flag=kTRUE){fWriteAlignmentData=flag;}
  void SetWriteESDfriend(Bool_t flag=kTRUE){fWriteESDfriend=flag;}
  void SetWriteHLTESD(Bool_t flag=kTRUE) {fWriteHLTESD=flag;}
  void SetFillTriggerESD(Bool_t flag=kTRUE){fFillTriggerESD=flag;}
  void SetDiamondProfileSPD(AliESDVertex *dp) {fDiamondProfileSPD=dp;}
  void SetDiamondProfile(AliESDVertex *dp) {fDiamondProfile=dp;}
  void SetDiamondProfileTPC(AliESDVertex *dp) {fDiamondProfileTPC=dp;}
  void ResetFriends();
    
  void SetSkipIncompleteDAQ(Bool_t v=kTRUE) { fSkipIncompleteDAQ = v; }
  Bool_t GetSkipIncompleteDAQ() { return fSkipIncompleteDAQ; }
  void SetCleanESD(Bool_t flag=kTRUE){fCleanESD=flag;}
  void SetUseHLTData(const char* detectors){fUseHLTData=detectors;}
  void SetV0DCAmax(Float_t d) {fV0DCAmax=d;}
  void SetV0CsPmin(Float_t d) {fV0CsPmin=d;}
  void SetDmax(Float_t d) {fDmax=d;}
  void SetZmax(Float_t z) {fZmax=z;}
  Float_t GetV0DCAmax() const {return fV0DCAmax;}
  Float_t GetV0CsPmin() const {return fV0CsPmin;}
  Float_t GetDmax() const {return fDmax;}
  Float_t GetZmax() const {return fZmax;}
  
  Bool_t HasNextEventAfter(Int_t eventId);
  
  //
  Bool_t  IsRunMultFinder()   const {return fRunMultFinder;}
  
  // CDB storage activation
  void SetDefaultStorage(const char* uri);
  void SetSpecificStorage(const char* calibType, const char* uri);
  void SetCDBSnapshotMode(const char* snapshotFileName);
  void AddCheckRecoCDBvsSimuCDB(const char* cdbpath,const char* comment="");
  void RemCheckRecoCDBvsSimuCDB(const char* cdbpath);
  void ResetCheckRecoCDBvsSimuCDB() {fCheckRecoCDBvsSimuCDB.Delete();}
  void RectifyCDBurl(TString& url);
  const TObjArray* GetCheckRecoCDBvsSimuCDB() const {return &fCheckRecoCDBvsSimuCDB;}
  void CheckRecoCDBvsSimuCDB();
  Bool_t MisalignGeometry(const TString& detectors);

  void           SetAlignObjArray(TObjArray *array)
                   {fAlignObjArray = array;
       fLoadAlignFromCDB = kFALSE;}

  virtual Int_t  Version() const {return 2;}
  virtual void   Begin(TTree*);
  virtual void   SlaveBegin(TTree*);
  virtual void   Init(TTree *tree);
  virtual Bool_t Process(Long64_t entry);
  virtual Bool_t ProcessEvent(Int_t iEvent);
  virtual void   SlaveTerminate();
  virtual void   Terminate();
  virtual Bool_t Run(const char* input = NULL);
  void           Abort(const char *method, EAbort what);
  virtual void   SetOption(const char* option) {
    TSelector::SetOption(option);
  }

  // Trackers
  AliTracker* GetTracker(Int_t idx) const { return fTracker[idx]; }
  Bool_t      CreateTrackers(const TString& detectors);
  void        ImportRunLoader(AliRunLoader* rl) { fRunLoader = rl; }

  // Quality Assurance 
  void    SetQACycles(AliQAv1::DETECTORINDEX_t det, Int_t cycles) { fQACycles[det] = cycles ; }
  void    SetQAWriteExpert(AliQAv1::DETECTORINDEX_t det) { fQAWriteExpert[det] = kTRUE ; }
  Bool_t  SetRunQA(TString detAndAction="ALL:ALL") ; 
  void    SetRunGlobalQA(Bool_t flag=kTRUE){fRunGlobalQA = flag;}
  void    SetQARefDefaultStorage(const char* uri);
  void    InitQA();
  void    MergeQA(const char *fileName = NULL); 
  void    SetWriteQAExpert() { fWriteQAExpertData = kTRUE ; }
  Bool_t  IsRunQA() const { return fRunQA ; } 
  Bool_t  IsRunGlobalQA() const { return fRunGlobalQA ; }
  Bool_t  IsInTasks(AliQAv1::TASKINDEX_t tsk) { return fQATasks.Contains(Form("%d", tsk)) ; }
  
  // Plane Efficiency Evaluation
  void    SetRunPlaneEff(Bool_t flag=kFALSE)  {fRunPlaneEff = flag;}

  enum {
    kNDetectors = 18   // number of detectors    + AD +FIT //alla
  };
  static Int_t   GetDetIndex(const char * detector);
  static const char** GetDetectorNames() { return fgkDetectorName; }

  // Upgrade
 void SetUpgradeModule(const char* detectors)  {fUpgradeModule = detectors; MatchUpgradeDetector() ; }
 void MatchUpgradeDetector();

  // Connection to analysis manager. 
  // If a macro is set it should contain a function returning an analysis 
  // manager object. The macro is ignored in case the analysis manager is 
  // set via SetAnalysisManager
  void        SetAnalysisMacro(const char *macropath) {fAnalysisMacro = macropath;}
  const char *GetAnalysisMacro() const {return fAnalysisMacro.Data();}
  void        SetAnalysisManager(AliAnalysisManager *mgr) {fAnalysis = mgr;}
  AliAnalysisManager *GetAnalysisManager() const {return fAnalysis;}

  // A method to declare defined trigger classes even if they are not
  // present in the run, needed for proper event selection based on trigger
  void        DeclareTriggerClasses(const char *trClasses) {fDeclTriggerClasses = trClasses;}
  //
  //
  void           CleanProcessedEvent();
   
  AliESDEvent* GetESDEvent() const { return fesd; }
  AliESDfriend* GetESDfriend() const { return fesdf; }
  AliRunLoader* GetRunLoader() const { return fRunLoader;}
  AliRawReader* GetRawReader() const { return fRawReader; }
  
  Bool_t       HasEnoughResources(int ev);
  void         SetStopOnResourcesExcess(int vRSS=3000,int vVMEM=4000);
  //
  //
  virtual Bool_t ProcessEvent(void* event);
  void           InitRun(const char* input);

  void SetMCEventHandler(AliMCEventHandler* hmc) {fMCEventHandlerExt = hmc;}
  AliMCEventHandler* GetMCEventHandler() const {return fMCEventHandlerExt;}
  
protected:
  // Functions needed to select events for which we store the ESD friends
  Bool_t IsHighPt() const;
  Bool_t IsCosmicOrCalibSpecie() const;
  void WriteESDfriend();
  Bool_t DecideFriendsStorage();

private:
  AliReconstruction(const AliReconstruction& rec);
  AliReconstruction& operator = (const AliReconstruction& rec);

  void           InitRawReader(const char* input);
  void           InitCDB();
  Bool_t         InitGRP();
  void           SetCDBLock();
  Bool_t         SetRunNumberFromData();
  Bool_t         LoadCDB();
  Bool_t         LoadTriggerScalersCDB();
  Bool_t         LoadCTPTimeParamsCDB();
  Bool_t         ReadIntensityInfoCDB();
  Bool_t         RunLocalEventReconstruction(const TString& detectors);
  Bool_t         RunVertexFinder(AliESDEvent*& esd);
  Bool_t         RunMuonTracking(AliESDEvent*& esd);
  Bool_t         RunMFTTrackingMU(AliESDEvent*& esd);      // AU
  Bool_t         RunSPDTrackleting(AliESDEvent*& esd);
  Bool_t         RunMultFinder(AliESDEvent*& esd);
  Bool_t         RunTracking(AliESDEvent*& esd, AliESDpid &PID);
  Bool_t         CleanESD(AliESDEvent *esd,const AliGRPRecoParam *grpRecoParam);
  Bool_t         FillESD(AliESDEvent*& esd, const TString& detectors);
  Bool_t         FillTriggerESD(AliESDEvent*& esd);
  Bool_t         FillTriggerScalers(AliESDEvent*& esd);
  Bool_t         FillRawEventHeaderESD(AliESDEvent*& esd);
  Bool_t         FillMCEventHeaderESD(AliESDEvent*& esd);
  void           DeleteRecPoints(const TString& detectors);
  void           DeleteDigits(const TString& detectors);

  Bool_t         IsSelected(TString detName, TString& detectors) const;
  Bool_t         InitRunLoader();
  AliReconstructor* GetReconstructor(Int_t iDet);
  AliVertexer*   CreateVertexer();
  AliTrackleter* CreateMultFinder();
  void           CleanUp();

  Bool_t         ParseOutput();

  //==========================================//
  void           WriteAlignmentData(AliESDEvent* esd);

  void           FillRawDataErrorLog(Int_t iEvent, AliESDEvent* esd);

  //Quality Assurance
  //  void                 CheckQA() ;

  // Plane Efficiency evaluation
  Bool_t  FinishPlaneEff(); //ultimate tasks related to Plane Eff. evaluation 
  Bool_t  InitPlaneEff();   // initialize what is needed for Plane Eff. evaluation

  Bool_t               InitAliEVE();
  void                 RunAliEVE();

  Bool_t         InitRecoParams(); // init the array with the reconstruciton parameters
  Bool_t         GetEventInfo();   // fill the event info inside the event loop
  void           ProcessTriggerAliases();
  Bool_t         TriggerMatches2Alias(const char* trigName, const char* alias);
  const char    *MatchDetectorList(const char *detectorList, UInt_t detectorMask);

  //*** Global reconstruction flags *******************
  Bool_t         fRunVertexFinder;    // run the vertex finder
  Bool_t         fRunVertexFinderTracks;    // run the vertex finder with tracks
  Bool_t         fRunMuonTracking;    // run the MUON tracking
  Bool_t         fRunMFTTrackingMU;   // run the MFT+MUON tracking      // AU
  Bool_t         fRunV0Finder;        // run the ESD V0 finder
  Bool_t         fRunCascadeFinder;   // run the ESD cascade finder
  Bool_t         fRunMultFinder;      // run the trackleter for ITS clusters
  Bool_t         fStopOnError;        // stop or continue on errors
  Bool_t         fStopOnMissingTriggerFile; // stop if the simulated trigger file is absent
  Bool_t         fWriteAlignmentData; // write track space-points flag
  Bool_t         fWriteESDfriend;     // write ESD friend flag
  Bool_t         fWriteHLTESD;        // write HLT ESD tree
  Bool_t         fFillTriggerESD;     // fill trigger info into ESD
  //
  Bool_t         fWriteThisFriend;    // decision to store or not friends for given event
  Bool_t         fSkipFriendsForLargeZ; // if true, TPC only tracks with |Z|>fSkipFriendsCutZ never stored
  Int_t          fMaxFriendTracks;    // max number of friend tracks to store per event
  Double_t       fFractionFriends;    // fraction of ESD friends to be stored
  Double_t       fFractionHLTESD;   // fraction of HLT ESD events to store 
  Double_t       fSkipFriendsCutZ;    // friends of TPC only tracks with large Z have low priority

  //*** Clean ESD flag and parameters *******************
  Bool_t         fSkipIncompleteDAQ; // skip events with "incomplete DAQ" attribute
  Bool_t         fCleanESD;      // clean ESD flag
  Float_t        fV0DCAmax;      // max. allowed DCA between V0 daugthers 
  Float_t        fV0CsPmin;      // min. allowed cosine of V0 pointing angle 
  Float_t        fDmax;          // max. allowed transverse impact parameter 
  Float_t        fZmax;          // max. allowed longitudinal impact parameter 
  
  TString        fCosmicAlias;        // alias for cosmic triggers
  TString        fLaserAlias;         // alias for laser triggers
  //
  TString        fRunLocalReconstruction; // run the local reconstruction for these detectors
  TString        fRunTracking;        // run the tracking for these detectors
  TString        fFillESD;            // fill ESD for these detectors
  TString        fDeleteRecPoints;    // delete recpoints after each event
  TString        fDeleteDigits;       // delete digits after each event
  TString        fLoadCDB;            // prefetch CDB entries and init reco-params for these detectors
  TString        fUseTrackingErrorsForAlignment; // for these detectors
  TString        fGAliceFileName;     // name of the galice file
  TString        fRawInput;           // name of input raw-data file or directory
  TString        fESDOutput;          
  TString        fProofOutputFileName;
  TString        fProofOutputLocation;
  Bool_t         fProofOutputDataset; 
  TString        fProofOutputArchive; 
  TString        fEquipIdMap;         // name of file with equipment id map
  Int_t          fFirstEvent;         // index of first event to be reconstr.
  Int_t          fLastEvent;          // index of last event to be reconstr.
  UInt_t         fNumberOfEventsPerFile; // number of events per file in case of raw-data reconstruction
  TObjArray      fOptions;            // options for reconstructor objects
  Bool_t         fLoadAlignFromCDB;   // Load alignment data from CDB and apply it to geometry or not
  TString        fLoadAlignData;      // Load alignment data from CDB for these detectors
  TString        fUseHLTData;        // Detectors for which the HLT data is used as input
  AliRunInfo*    fRunInfo;            // an object which contains essential global conditions information
  AliEventInfo   fEventInfo;          // an object which contains essential event information
  AliTriggerRunScalers* fRunScalers;  // an object which contains the trigger counters for xsection
  AliCTPTimeParams* fCTPTimeParams;   // an object which contains the trigger delays
  AliCTPTimeParams* fCTPTimeAlign;    // an object which contains the CTP (mis)alignment data
  AliRunLoader*  fRunLoader;          
  AliRawReader*  fRawReader;          
  AliRawReader*  fParentRawReader;    

  static const char* fgkDetectorName[kNDetectors]; 
  AliReconstructor*  fReconstructor[kNDetectors];  
  AliRecoParam   fRecoParam;                      // container for the reco-param objects for detectors
  AliLoader*     fLoader[kNDetectors];   
  AliTracker*    fTracker[kNDetectors];  
  AliTracker*    fSPDTrackleter;           
  AliESDVertex*  fDiamondProfileSPD;       // (x,y) diamond profile from SPD for AliITSVertexer3D(Z)
  AliESDVertex*  fDiamondProfile;          // (x,y) diamond profile for AliVertexerTracks (ITS+TPC)
  AliESDVertex*  fDiamondProfileTPC;       // (x,y) diamond profile from TPC for AliVertexerTracks
  THashTable*    fListOfCosmicTriggers;    // list of cosmic triggers as defined by trigger coordination (RS for BWD comp)
  THashList*     fAlias2Trigger;          // list of aliases with string of triggers per alias

  AliGRPObject*  fGRPData;              // Data from the GRP/GRP/Data CDB folder

  TObjArray*   fAlignObjArray;      

  TString  fCDBUri;       
  TString  fQARefUri;     
  TObjArray      fSpecCDBUri;         
  TObjArray      fCheckRecoCDBvsSimuCDB; // Array for CDB items which must be the same in the sim and rec
  Bool_t   fInitCDBCalled;               
  Bool_t         fCDBSnapshotMode;             
  Bool_t   fSetRunNumberFromDataCalled;  

  //Quality Assurance
  Int_t  fQACycles[     AliQAv1::kNDET];  // # events over which QA data are accumulated
  Bool_t fQAWriteExpert[AliQAv1::kNDET];  // Flag to save or not expert QA data
  TString               fQADetectors ;  // list of detectors to be QA'ed  
  TString               fQATasks ;      // list of QA tasks to be performed 
  Bool_t                fRunQA ;        // Run QA flag
  Bool_t                fRunGlobalQA;   // Run global QA flag
  Bool_t                fSameQACycle;   
  Bool_t                fInitQACalled;  
  Bool_t                fWriteQAExpertData ; 

  // Plane Efficiency Evaluation
  Bool_t         fRunPlaneEff ;      // Evaluate Plane Efficiency

  // PID
  AliESDpid*     fESDpid;                      // PID object

  // New members needed in order to split Run method
  // into InitRun,RunEvent,FinishRun methods
  AliESDEvent*         fesd;        
  AliESDEvent*         fhltesd;     
  AliESDfriend*        fesdf;       
  AliESDfriend*        fesdfDummy;  
  TFile*               ffile;       
  TFile*               ffileF;      
  TTree*               ftree;       
  TTree*               ftreeF;      
  TTree*               fhlttree;    
  AliVertexerTracks*   ftVertexer;  
  Bool_t               fIsNewRunLoader; // galice.root created from scratch (real raw data case)
  Bool_t               fRunAliEVE;  // Run AliEVE or not
  Double_t             fBeamInt[2][2]; 
  
  TTree*              fChain;      

  // Counters used in WriteESDfriend()
  Int_t fNall;    
  Int_t fNspecie; 
  Int_t fSspecie; 
  Int_t fNhighPt; 
  Int_t fShighPt; 
 
  // Counters for SetAutoFlush configuration
  Long64_t fTreeBuffSize;   //  allowed uncompressed buffer size per tree
  Long64_t fMemCountESD;    
  Long64_t fMemCountESDF;   
  Long64_t fMemCountESDHLT; 
  //
  // Upgrade detector reconstruction
  TString fUpgradeModule;
  Bool_t  fUpgradeMask[kNDetectors];
  // optional MCHandler to access MC info in case of embedding
  AliMCEventHandler*   fMCEventHandlerExt;  // only externally set
  // Connect an analysis manager in the event loop
  TString              fAnalysisMacro; // Full path to a macro creating an analysis manager train
  AliAnalysisManager  *fAnalysis;      
  AliRecoInputHandler *fRecoHandler;   
  TString              fDeclTriggerClasses; // Declared defined trigger classes
  //
  Bool_t               fStopped;        //  flag that reco is stopped due to the limited resources 
  Int_t                fMaxRSS;         //  max RSS memory, MB
  Int_t                fMaxVMEM;        //  max VMEM memory, MB
  Int_t                fNAbandonedEv;   //  number of abandoned events
  static const char*   fgkStopEvFName;  //  filename for stop.event stamp
  //
  ClassDef(AliReconstruction, 53)      // class for running the reconstruction
};

#endif