changes in the PID of protons + new config for the proton femtoscopy train
[u/mrichter/AliRoot.git] / STEER / 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 "AliQAv1.h"
19 #include "AliQAManager.h"
20 #include <time.h>
21
22 class AliCDBId;
23 class AliCDBParam;
24 class AliRunLoader;
25 class AliLegoGenerator;
26 class AliLego;
27 class AliMagF;
28 class AliHLTSimulation;
29
30 class AliSimulation: public TNamed {
31 public:
32   AliSimulation(const char* configFileName = "Config.C",
33                 const char* name = "AliSimulation", 
34                 const char* title = "generation, simulation and digitization");
35   virtual ~AliSimulation();
36
37   static AliSimulation *Instance() {if(!fgInstance) fgInstance=new AliSimulation(); return fgInstance;}
38
39   void           SetNumberOfEvents(Int_t nEvents);
40   void           SetConfigFile(const char* fileName);
41   void           SetGAliceFile(const char* fileName);
42   void           SetEventsPerFile(const char* detector, const char* type, 
43                                   Int_t nEvents);
44
45   void           SetRunGeneration(Bool_t run) {fRunGeneration = run;};
46   void           SetRunSimulation(Bool_t run) {fRunSimulation = run;};
47   void           SetLoadAlignFromCDB(Bool_t load)  {fLoadAlignFromCDB = load;};
48   void           SetLoadAlignData(const char* detectors) 
49                    {fLoadAlObjsListOfDets = detectors;};
50   void           SetMakeSDigits(const char* detectors) 
51                    {fMakeSDigits = detectors;};
52   void           MergeWith(const char* fileName, Int_t nSignalPerBkgrd = 0);
53   void           EmbedInto(const char* fileName, Int_t nSignalPerBkgrd = 0);
54   void           SetUseBkgrdVertex(Bool_t useBkgrdVertex)
55                    {fUseBkgrdVertex = useBkgrdVertex;};
56   void           SetRegionOfInterest(Bool_t flag) {fRegionOfInterest = flag;};
57   void           SetMakeDigits(const char* detectors)
58                    {fMakeDigits = detectors;};
59   void           SetMakeDigitsFromHits(const char* detectors)
60                    {fMakeDigitsFromHits = detectors;};
61   void           SetWriteRawData(const char* detectors, 
62                                  const char* fileName = NULL,
63                                  Bool_t deleteIntermediateFiles = kFALSE)
64                    {fWriteRawData = detectors; fRawDataFileName = fileName;
65                    fDeleteIntermediateFiles = deleteIntermediateFiles;};
66   void           SetWriteSelRawData(Bool_t sel = kTRUE)
67                    {fWriteSelRawData = sel;}
68   void           SetTriggerConfig(TString conf) {fTriggerConfig=conf;}
69   const Char_t*  GetTriggerConfig() const {return fTriggerConfig.Data();}
70   void           SetAlignObjArray(TObjArray *array)
71                    {fAlignObjArray = array;
72                    fLoadAlignFromCDB = kFALSE;}
73   void           SetUseMonitoring(Bool_t flag=kTRUE) {fUseMonitoring = flag;}
74
75   Bool_t         MisalignGeometry(AliRunLoader *runLoader = NULL);
76
77   void           SetRunNumber(Int_t run);
78   void           SetSeed(Int_t seed);
79     
80   void           ProcessEnvironmentVars();
81                    
82   // CDB storage activation
83   void SetDefaultStorage(const char* uri);
84   void SetSpecificStorage(const char* calibType, const char* uri);
85   void SetCDBSnapshotMode(const char* snapshotFileName) {AliCDBManager::Instance()->SetSnapshotMode(snapshotFileName);}
86
87   virtual Bool_t Run(Int_t nEvents = 0);
88   virtual Bool_t RunLego(const char *setup="Config.C",Int_t nc1=60,Float_t c1min=2,Float_t c1max=178,
89                          Int_t nc2=60,Float_t c2min=0,Float_t c2max=360,Float_t rmin=0,
90                          Float_t rmax=430,Float_t zmax=10000, AliLegoGenerator* gener=NULL, Int_t nev = -1);
91
92   virtual Bool_t RunSimulation(Int_t nEvents = 0);
93   virtual Bool_t RunSDigitization(const char* detectors = "ALL");
94   virtual Bool_t RunTrigger(const char* descriptors ="", const char* detectors = "ALL");
95   virtual Bool_t WriteTriggerRawData();
96   virtual Bool_t RunDigitization(const char* detectors = "ALL",
97                                  const char* excludeDetectors = "");
98   virtual Bool_t RunHitsDigitization(const char* detectors = "ALL");
99   virtual Bool_t WriteRawData(const char* detectors = "ALL",
100                               const char* fileName = NULL,
101                               Bool_t deleteIntermediateFiles = kFALSE,
102                               Bool_t selrawdata = kFALSE);
103   virtual Bool_t WriteRawFiles(const char* detectors = "ALL");
104   virtual Bool_t ConvertRawFilesToDate(const char* dateFileName = "raw.date",
105                                        const char* rootFileName = "");
106   virtual Bool_t ConvertDateToRoot(const char* dateFileName = "raw.date",
107                                    const char* rootFileName = "raw.root");
108   virtual Int_t ConvertRaw2SDigits(const char* rawDirectory, const char* esdFile = "", Int_t N=-1, Int_t nSkip=0);
109
110   // Sets the name of the file from which the geometry is loaded
111   virtual void SetGeometryFile(const Char_t* filename) {fGeometryFile=filename;}
112   virtual const Char_t* GetGeometryFile() const {return fGeometryFile.Data();}
113   virtual Bool_t IsGeometryFromFile() const {return !fGeometryFile.IsNull();}
114
115
116   // HLT
117   void SetRunHLT(const char* options) {fRunHLT=options;}
118   virtual Bool_t CreateHLT();
119   virtual Bool_t RunHLT();
120   virtual  Bool_t IsLegoRun() const {return (fLego!=0);}
121   AliLego* Lego() const {return fLego;}
122   virtual  void  FinishRun();
123
124   //Quality Assurance
125   Int_t       GetDetIndex(const char * detector);
126   void        SetQACycles(AliQAv1::DETECTORINDEX_t det, const Int_t cycles) {  AliQAManager::QAManager()->SetCycleLength(det, cycles) ; }
127   Bool_t      RunQA() ;
128   Bool_t      SetRunQA(TString detAndAction="ALL:ALL") ; 
129   void        SetQAWriteExpert(AliQAv1::DETECTORINDEX_t det) { AliQAManager::QAManager()->SetWriteExpert(det) ; }  
130   void        SetQARefDefaultStorage(const char* uri);
131   void        InitQA();
132   void        SetEventSpecie(AliRecoParam::EventSpecie_t es) { fEventSpecie = es ; }
133   void        SetWriteQAExpert() { fWriteQAExpertData = kTRUE ; }
134
135   void SetWriteGRPEntry(Bool_t flag = kTRUE) { fWriteGRPEntry = flag; }
136   void WriteGRPEntry();
137   void UseVertexFromCDB()   {fUseVertexFromCDB   = kTRUE;}
138   void UseMagFieldFromGRP() {fUseMagFieldFromGRP = kTRUE;} 
139   void SetGRPWriteLocation(char* loc) {fGRPWriteLocation = loc;}
140
141   void UseTimeStampFromCDB()   {fUseTimeStampFromCDB   = kTRUE;}
142   time_t GenerateTimeStamp() const;
143
144 private:
145
146   AliSimulation(const AliSimulation&); // Not implemented
147   AliSimulation& operator = (const AliSimulation&); // Not implemented
148
149   void           InitCDB();
150   void           InitRunNumber();
151   void           SetCDBLock();
152   Bool_t         SetRunNumberFromData();
153   AliRunLoader*  LoadRun(const char* mode = "UPDATE") const;
154   Int_t          GetNSignalPerBkgrd(Int_t nEvents = 0) const;
155   Bool_t         IsSelected(TString detName, TString& detectors) const;
156
157   static AliSimulation *fgInstance;    // Static pointer to object
158
159   Bool_t         fRunGeneration;      // generate prim. particles or not
160   Bool_t         fRunSimulation;      // simulate detectors (hits) or not
161   Bool_t         fLoadAlignFromCDB;   // Load alignment data from CDB and apply it to geometry or not
162   TString        fLoadAlObjsListOfDets;   // Load alignment data from CDB for these detectors
163   TString        fMakeSDigits;        // create sdigits for these detectors
164   TString        fMakeDigits;         // create digits for these detectors
165   TString        fTriggerConfig;      // run trigger for these descriptors
166   TString        fMakeDigitsFromHits; // create digits from hits for these detectors
167   TString        fWriteRawData;       // write raw data for these detectors
168   TString        fRawDataFileName;    // file name for the raw data file
169   Bool_t         fDeleteIntermediateFiles; // delete intermediate raw data files
170   Bool_t         fWriteSelRawData;    // write detectors raw data in a separate file accoring to the trigger cluster
171   Bool_t         fStopOnError;        // stop or continue on errors
172   Bool_t         fUseMonitoring;      // monitor simulation timing per volume
173
174   Int_t          fNEvents;            // number of events
175   TString        fConfigFileName;     // name of the config file
176   TString        fGAliceFileName;     // name of the galice file
177   TObjArray      fEventsPerFile;      // number of events per file for given detectors and data types
178
179   TObjArray*     fBkgrdFileNames;     // names of background files for merging
180   TObjArray*     fAlignObjArray;      // array with the alignment objects to be applied to the geometry
181   Bool_t         fUseBkgrdVertex;     // use vertex from background in case of merging
182   Bool_t         fRegionOfInterest;   // digitization in region of interest
183
184   TString        fCDBUri;                            //! Uri of the default CDB storage
185   TString        fQARefUri;                          //! Uri of the default QA reference storage
186   TObjArray      fSpecCDBUri;                        //! Array with detector specific CDB storages
187   Int_t            fRun;                                     //! Run number, will be passed to CDB and gAlice!!
188   Int_t            fSeed;                        //! Seed for random number generator 
189   Bool_t           fInitCDBCalled;               //! flag to check if CDB storages are already initialized
190   Bool_t           fInitRunNumberCalled;         //! flag to check if run number is already initialized
191   Bool_t           fSetRunNumberFromDataCalled;  //! flag to check if run number is already loaded from run loader
192   
193   Bool_t         fEmbeddingFlag;       // Flag for embedding
194   AliLego       *fLego;                //! Pointer to aliLego object if it exists
195   // OCDB
196   ULong64_t       fKey;                //! current CDB key
197   Bool_t          fUseVertexFromCDB;   // Flag to use Vertex from CDB
198   Bool_t          fUseMagFieldFromGRP; // Use magnetic field settings from GRP
199   TString         fGRPWriteLocation;   // Location to write the GRP entry from simulation
200
201   Bool_t          fUseTimeStampFromCDB;// Flag to generate event time-stamps according to SOR/EOR from GRP
202   time_t          fTimeStart;          // SOR time-stamp
203   time_t          fTimeEnd;            // EOR time-stamp
204   
205   //QA stuff
206 //   #ifdef MFT_UPGRADE
207 //   static const Int_t   fgkNDetectors = 16 ;             // number of detectors
208 //   #else
209 //   static const Int_t   fgkNDetectors = 15 ;             // number of detectors
210 //   #endif
211   static const Int_t   fgkNDetectors = 16 ;             // number of detectors    // AU
212   static const char *  fgkDetectorName[fgkNDetectors] ; // names of detectors
213   TString              fQADetectors ;                   // list of detectors to be QA'ed        
214   TString              fQATasks ;                       // list of QA tasks to be performed     
215   Bool_t               fRunQA ;                         // Runs the QA at the end of simulation
216   AliRecoParam::EventSpecie_t fEventSpecie ;            // type of event (see AliRecoParam::EventSpecie_t)
217   Bool_t               fWriteQAExpertData ;             //! decides wheter or not to write experts QA data; true by default
218
219   TString              fGeometryFile;                   // Geometry file
220
221   //HLT
222   TString              fRunHLT;       //! HLT options, HLT is disabled if empty, default='default'
223   AliHLTSimulation*    fpHLT;         //! The instance of HLT simulation
224
225   Bool_t         fWriteGRPEntry;      // Write or not GRP entry corresponding to the settings in Config.C
226
227   ClassDef(AliSimulation, 13)  // class for running generation, simulation and digitization
228 };
229
230 #endif