[u/mrichter/AliRoot.git] / STEER / AliSimulation.h

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

/* $Id$ */

//
// class for running generation, simulation and digitization
// Hits, sdigits and digits are created for all detectors by typing:
//   AliSimulation sim;
//   sim.Run();
//

#include <TNamed.h>
#include <TString.h>
#include <TObjArray.h>
#include "AliQA.h"

class AliCDBId;
class AliCDBParam;
class AliRunLoader;
class AliQADataMakerSteer ; 

class AliSimulation: public TNamed {
public:
  AliSimulation(const char* configFileName = "Config.C",
		const char* name = "AliSimulation", 
		const char* title = "generation, simulation and digitization");
  AliSimulation(const AliSimulation& sim);
  AliSimulation& operator = (const AliSimulation& sim);
  virtual ~AliSimulation();

  static AliSimulation *GetInstance() {return fgInstance;}

  void           SetNumberOfEvents(Int_t nEvents);
  void           SetConfigFile(const char* fileName);
  void           SetGAliceFile(const char* fileName);
  void           SetEventsPerFile(const char* detector, const char* type, 
				  Int_t nEvents);

  void           SetRunGeneration(Bool_t run) {fRunGeneration = run;};
  void           SetRunSimulation(Bool_t run) {fRunSimulation = run;};
  void           SetLoadAlignFromCDB(Bool_t load)  {fLoadAlignFromCDB = load;};
  void           SetLoadAlignData(const char* detectors) 
                   {fLoadAlObjsListOfDets = detectors;};
  void           SetMakeSDigits(const char* detectors) 
                   {fMakeSDigits = detectors;};
  void           MergeWith(const char* fileName, Int_t nSignalPerBkgrd = 0);
  void           EmbedInto(const char* fileName, Int_t nSignalPerBkgrd = 0);
  void           SetUseBkgrdVertex(Bool_t useBkgrdVertex)
                   {fUseBkgrdVertex = useBkgrdVertex;};
  void           SetRegionOfInterest(Bool_t flag) {fRegionOfInterest = flag;};
  void           SetMakeDigits(const char* detectors)
                   {fMakeDigits = detectors;};
  void           SetMakeTrigger(const char* descriptors)
                   {fMakeTrigger = descriptors;};
  void           SetMakeDigitsFromHits(const char* detectors)
                   {fMakeDigitsFromHits = detectors;};
  void           SetWriteRawData(const char* detectors, 
				 const char* fileName = NULL,
				 Bool_t deleteIntermediateFiles = kFALSE)
                   {fWriteRawData = detectors; fRawDataFileName = fileName;
		   fDeleteIntermediateFiles = deleteIntermediateFiles;};
  void           SetWriteSelRawData(Bool_t sel = kTRUE)
                   {fWriteSelRawData = sel;}
  void           SetAlignObjArray(TObjArray *array)
                   {fAlignObjArray = array;
		   fLoadAlignFromCDB = kFALSE;}

  Bool_t         MisalignGeometry(AliRunLoader *runLoader = NULL);

  void           SetRunNumber(Int_t run);
  void           SetSeed(Int_t seed);
    
  void 		 ProcessEnvironmentVars();
		   
  // CDB storage activation
  void SetDefaultStorage(const char* uri);
  void SetSpecificStorage(const char* calibType, const char* uri);

  virtual Bool_t Run(Int_t nEvents = 0);

  virtual Bool_t RunSimulation(Int_t nEvents = 0);
  virtual Bool_t RunSDigitization(const char* detectors = "ALL");
  virtual Bool_t RunTrigger(const char* descriptors ="", const char* detectors = "ALL");
  virtual Bool_t WriteTriggerRawData();
  virtual Bool_t RunDigitization(const char* detectors = "ALL",
				 const char* excludeDetectors = "");
  virtual Bool_t RunHitsDigitization(const char* detectors = "ALL");
  virtual Bool_t WriteRawData(const char* detectors = "ALL",
			      const char* fileName = NULL,
			      Bool_t deleteIntermediateFiles = kFALSE,
			      Bool_t selrawdata = kFALSE);
  virtual Bool_t WriteRawFiles(const char* detectors = "ALL");
  virtual Bool_t ConvertRawFilesToDate(const char* dateFileName = "raw.date",
				       const char* rootFileName = "");
  virtual Bool_t ConvertDateToRoot(const char* dateFileName = "raw.date",
				   const char* rootFileName = "raw.root");
  virtual Bool_t ConvertRaw2SDigits(const char* rawDirectory, const char* esdFile = "");

  // HLT
  void SetRunHLT(const char* options) {fRunHLT=options;}
  virtual Bool_t RunHLT();

  //Quality Assurance
  Int_t       GetDetIndex(const char * detector);
  const Int_t GetQACycles(const char * detector) { return fQACycles[GetDetIndex(detector)] ; }
  void        SetQACycles(const char * detector, const Int_t cycles) { fQACycles[GetDetIndex(detector)] = cycles ; }
  Bool_t      RunQA() ;
  Bool_t      SetRunQA(TString detAndAction="ALL:ALL") ; 

  void SetWriteGRPEntry(Bool_t flag = kTRUE) { fWriteGRPEntry = flag; }
  void WriteGRPEntry();

private:
  void 		 InitCDB();
  void 		 InitRunNumber();
  void 		 SetCDBLock();
  Bool_t         SetRunNumberFromData();
  AliRunLoader*  LoadRun(const char* mode = "UPDATE") const;
  Int_t          GetNSignalPerBkgrd(Int_t nEvents = 0) const;
  Bool_t         IsSelected(TString detName, TString& detectors) const;

  static AliSimulation *fgInstance;    // Static pointer to object

  Bool_t         fRunGeneration;      // generate prim. particles or not
  Bool_t         fRunSimulation;      // simulate detectors (hits) or not
  Bool_t         fLoadAlignFromCDB;   // Load alignment data from CDB and apply it to geometry or not
  TString        fLoadAlObjsListOfDets;   // Load alignment data from CDB for these detectors
  TString        fMakeSDigits;        // create sdigits for these detectors
  TString        fMakeDigits;         // create digits for these detectors
  TString        fMakeTrigger;        // run trigger for these descriptors
  TString        fMakeDigitsFromHits; // create digits from hits for these detectors
  TString        fWriteRawData;       // write raw data for these detectors
  TString        fRawDataFileName;    // file name for the raw data file
  Bool_t         fDeleteIntermediateFiles; // delete intermediate raw data files
  Bool_t         fWriteSelRawData;    // write detectors raw data in a separate file accoring to the trigger cluster
  Bool_t         fStopOnError;        // stop or continue on errors

  Int_t          fNEvents;            // number of events
  TString        fConfigFileName;     // name of the config file
  TString        fGAliceFileName;     // name of the galice file
  TObjArray      fEventsPerFile;      // number of events per file for given detectors and data types

  TObjArray*     fBkgrdFileNames;     // names of background files for merging
  TObjArray* 	 fAlignObjArray;      // array with the alignment objects to be applied to the geometry
  Bool_t         fUseBkgrdVertex;     // use vertex from background in case of merging
  Bool_t         fRegionOfInterest;   // digitization in region of interest

  TString 	 fCDBUri;	      //! Uri of the default CDB storage
  TObjArray      fSpecCDBUri;         //! Array with detector specific CDB storages
  Int_t 	 fRun; 		      //! Run number, will be passed to CDB and gAlice!!
  Int_t 	 fSeed;               //! Seed for random number generator 
  Bool_t 	 fInitCDBCalled;      //! flag to check if CDB storages are already initialized
  Bool_t 	 fInitRunNumberCalled;  //! flag to check if run number is already initialized
  Bool_t 	 fSetRunNumberFromDataCalled;  //! flag to check if run number is already loaded from run loader
  
  Bool_t         fEmbeddingFlag;      // Flag for embedding
  
  //QA stuff
  static const Int_t   fgkNDetectors = 15 ;             // number of detectors
  static const char *  fgkDetectorName[fgkNDetectors] ; // names of detectors
  Int_t                fQACycles[fgkNDetectors] ;       // cycle length (# events) over which QA data are accumulated
  TString              fQADetectors ;                   // list of detectors to be QA'ed 	
  TString              fQATasks ;                       // list of QA tasks to be performed	
	AliQADataMakerSteer * fQASteer ;                      // steering object to run QA
  Bool_t               fRunQA ;                         // Runs the QA at the end of simulation

  //HLT
  TString        fRunHLT;             // HLT options, HLT is disabled if empty, default='default'

  Bool_t         fWriteGRPEntry;      // Write or not GRP entry corresponding to the settings in Config.C

  ClassDef(AliSimulation, 8)  // class for running generation, simulation and digitization
};

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