Removal of out-of-event-loop QA. Correlation QA. Some clean-up in QA code (Yves)
[u/mrichter/AliRoot.git] / STEER / AliSimulation.h
1 #ifndef ALISIMULATION_H
2 #define ALISIMULATION_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 // class for running generation, simulation and digitization
10 // Hits, sdigits and digits are created for all detectors by typing:
11 //   AliSimulation sim;
12 //   sim.Run();
13 //
14
15 #include <TNamed.h>
16 #include <TString.h>
17 #include <TObjArray.h>
18 #include "AliQA.h"
19 #include "AliQADataMakerSteer.h"
20
21 class AliCDBId;
22 class AliCDBParam;
23 class AliRunLoader;
24
25 class AliSimulation: public TNamed {
26 public:
27   AliSimulation(const char* configFileName = "Config.C",
28                 const char* name = "AliSimulation", 
29                 const char* title = "generation, simulation and digitization");
30   AliSimulation(const AliSimulation& sim);
31   AliSimulation& operator = (const AliSimulation& sim);
32   virtual ~AliSimulation();
33
34   static AliSimulation *GetInstance() {return fgInstance;}
35
36   void           SetNumberOfEvents(Int_t nEvents);
37   void           SetConfigFile(const char* fileName);
38   void           SetGAliceFile(const char* fileName);
39   void           SetEventsPerFile(const char* detector, const char* type, 
40                                   Int_t nEvents);
41
42   void           SetRunGeneration(Bool_t run) {fRunGeneration = run;};
43   void           SetRunSimulation(Bool_t run) {fRunSimulation = run;};
44   void           SetLoadAlignFromCDB(Bool_t load)  {fLoadAlignFromCDB = load;};
45   void           SetLoadAlignData(const char* detectors) 
46                    {fLoadAlObjsListOfDets = detectors;};
47   void           SetMakeSDigits(const char* detectors) 
48                    {fMakeSDigits = detectors;};
49   void           MergeWith(const char* fileName, Int_t nSignalPerBkgrd = 0);
50   void           EmbedInto(const char* fileName, Int_t nSignalPerBkgrd = 0);
51   void           SetUseBkgrdVertex(Bool_t useBkgrdVertex)
52                    {fUseBkgrdVertex = useBkgrdVertex;};
53   void           SetRegionOfInterest(Bool_t flag) {fRegionOfInterest = flag;};
54   void           SetMakeDigits(const char* detectors)
55                    {fMakeDigits = detectors;};
56   void           SetMakeTrigger(const char* descriptors)
57                    {fMakeTrigger = descriptors;};
58   void           SetMakeDigitsFromHits(const char* detectors)
59                    {fMakeDigitsFromHits = detectors;};
60   void           SetWriteRawData(const char* detectors, 
61                                  const char* fileName = NULL,
62                                  Bool_t deleteIntermediateFiles = kFALSE)
63                    {fWriteRawData = detectors; fRawDataFileName = fileName;
64                    fDeleteIntermediateFiles = deleteIntermediateFiles;};
65   void           SetWriteSelRawData(Bool_t sel = kTRUE)
66                    {fWriteSelRawData = sel;}
67   void           SetAlignObjArray(TObjArray *array)
68                    {fAlignObjArray = array;
69                    fLoadAlignFromCDB = kFALSE;}
70
71   Bool_t         MisalignGeometry(AliRunLoader *runLoader = NULL);
72
73   void           SetRunNumber(Int_t run);
74   void           SetSeed(Int_t seed);
75     
76   void           ProcessEnvironmentVars();
77                    
78   // CDB storage activation
79   void SetDefaultStorage(const char* uri);
80   void SetSpecificStorage(const char* calibType, const char* uri);
81
82   virtual Bool_t Run(Int_t nEvents = 0);
83
84   virtual Bool_t RunSimulation(Int_t nEvents = 0);
85   virtual Bool_t RunSDigitization(const char* detectors = "ALL");
86   virtual Bool_t RunTrigger(const char* descriptors ="", const char* detectors = "ALL");
87   virtual Bool_t WriteTriggerRawData();
88   virtual Bool_t RunDigitization(const char* detectors = "ALL",
89                                  const char* excludeDetectors = "");
90   virtual Bool_t RunHitsDigitization(const char* detectors = "ALL");
91   virtual Bool_t WriteRawData(const char* detectors = "ALL",
92                               const char* fileName = NULL,
93                               Bool_t deleteIntermediateFiles = kFALSE,
94                               Bool_t selrawdata = kFALSE);
95   virtual Bool_t WriteRawFiles(const char* detectors = "ALL");
96   virtual Bool_t ConvertRawFilesToDate(const char* dateFileName = "raw.date",
97                                        const char* rootFileName = "");
98   virtual Bool_t ConvertDateToRoot(const char* dateFileName = "raw.date",
99                                    const char* rootFileName = "raw.root");
100   virtual Bool_t ConvertRaw2SDigits(const char* rawDirectory, const char* esdFile = "");
101
102   // HLT
103   void SetRunHLT(const char* options) {fRunHLT=options;}
104   virtual Bool_t RunHLT();
105
106   //Quality Assurance
107   Int_t       GetDetIndex(const char * detector);
108   void        SetQACycles(AliQA::DETECTORINDEX_t det, const Int_t cycles) {  fQASteer->SetCycleLength(det, cycles) ; }
109   Bool_t      RunQA() ;
110   Bool_t      SetRunQA(TString detAndAction="ALL:ALL") ; 
111
112   void SetWriteGRPEntry(Bool_t flag = kTRUE) { fWriteGRPEntry = flag; }
113   void WriteGRPEntry();
114
115 private:
116   void           InitCDB();
117   void           InitRunNumber();
118   void           SetCDBLock();
119   Bool_t         SetRunNumberFromData();
120   AliRunLoader*  LoadRun(const char* mode = "UPDATE") const;
121   Int_t          GetNSignalPerBkgrd(Int_t nEvents = 0) const;
122   Bool_t         IsSelected(TString detName, TString& detectors) const;
123
124   static AliSimulation *fgInstance;    // Static pointer to object
125
126   Bool_t         fRunGeneration;      // generate prim. particles or not
127   Bool_t         fRunSimulation;      // simulate detectors (hits) or not
128   Bool_t         fLoadAlignFromCDB;   // Load alignment data from CDB and apply it to geometry or not
129   TString        fLoadAlObjsListOfDets;   // Load alignment data from CDB for these detectors
130   TString        fMakeSDigits;        // create sdigits for these detectors
131   TString        fMakeDigits;         // create digits for these detectors
132   TString        fMakeTrigger;        // run trigger for these descriptors
133   TString        fMakeDigitsFromHits; // create digits from hits for these detectors
134   TString        fWriteRawData;       // write raw data for these detectors
135   TString        fRawDataFileName;    // file name for the raw data file
136   Bool_t         fDeleteIntermediateFiles; // delete intermediate raw data files
137   Bool_t         fWriteSelRawData;    // write detectors raw data in a separate file accoring to the trigger cluster
138   Bool_t         fStopOnError;        // stop or continue on errors
139
140   Int_t          fNEvents;            // number of events
141   TString        fConfigFileName;     // name of the config file
142   TString        fGAliceFileName;     // name of the galice file
143   TObjArray      fEventsPerFile;      // number of events per file for given detectors and data types
144
145   TObjArray*     fBkgrdFileNames;     // names of background files for merging
146   TObjArray*     fAlignObjArray;      // array with the alignment objects to be applied to the geometry
147   Bool_t         fUseBkgrdVertex;     // use vertex from background in case of merging
148   Bool_t         fRegionOfInterest;   // digitization in region of interest
149
150   TString        fCDBUri;             //! Uri of the default CDB storage
151   TObjArray      fSpecCDBUri;         //! Array with detector specific CDB storages
152   Int_t          fRun;                //! Run number, will be passed to CDB and gAlice!!
153   Int_t          fSeed;               //! Seed for random number generator 
154   Bool_t         fInitCDBCalled;      //! flag to check if CDB storages are already initialized
155   Bool_t         fInitRunNumberCalled;  //! flag to check if run number is already initialized
156   Bool_t         fSetRunNumberFromDataCalled;  //! flag to check if run number is already loaded from run loader
157   
158   Bool_t         fEmbeddingFlag;      // Flag for embedding
159   
160   //QA stuff
161   static const Int_t   fgkNDetectors = 15 ;             // number of detectors
162   static const char *  fgkDetectorName[fgkNDetectors] ; // names of detectors
163   TString              fQADetectors ;                   // list of detectors to be QA'ed        
164   TString              fQATasks ;                       // list of QA tasks to be performed     
165         AliQADataMakerSteer * fQASteer ;                      // steering object to run QA
166   Bool_t               fRunQA ;                         // Runs the QA at the end of simulation
167
168   //HLT
169   TString        fRunHLT;             // HLT options, HLT is disabled if empty, default='default'
170
171   Bool_t         fWriteGRPEntry;      // Write or not GRP entry corresponding to the settings in Config.C
172
173   ClassDef(AliSimulation, 8)  // class for running generation, simulation and digitization
174 };
175
176 #endif