prevent running if CDB snapshot setting failed
[u/mrichter/AliRoot.git] / STEER / STEER / AliModule.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17
18 ///////////////////////////////////////////////////////////////////////////////
19 //                                                                           //
20 // Base class for ALICE modules. Both sensitive modules (Modules) and      //
21 // non-sensitive ones are described by this base class. This class           //
22 // supports the hit and digit trees produced by the simulation and also      //
23 // the objects produced by the reconstruction.                               //
24 //                                                                           //
25 // This class is also responsible for building the geometry of the           //
26 // Modules.                                                                //
27 //                                                                           //
28 //Begin_Html
29 /*
30 <img src="picts/AliModuleClass.gif">
31 */
32 //End_Html
33 //                                                                           //
34 ///////////////////////////////////////////////////////////////////////////////
35
36 #include <TObjArray.h>
37 #include <TClonesArray.h>
38 #include <TTree.h>
39 #include <TSystem.h>
40 #include <TDirectory.h>
41 #include <TVirtualMC.h>
42 #include <TGeoManager.h>
43 #include <TString.h>
44
45 #include "AliLog.h"
46 #include "AliConfig.h"
47 #include "AliLoader.h"
48 #include "AliMagF.h"
49 #include "AliModule.h"
50 #include "AliRun.h"
51 #include "AliTrackReference.h"
52 #include "AliMC.h"
53 #include "AliSimulation.h"
54 #include "AliRawDataHeaderV3.h"
55 #include "AliDigitizationInput.h"
56
57 #include "AliDAQ.h"
58
59 using std::endl;
60 using std::cout;
61 using std::fstream;
62 using std::ios;
63 using std::ostream;
64 ClassImp(AliModule)
65  
66 Float_t AliModule::fgDensityFactor = 1.0;
67  
68 //_______________________________________________________________________
69 AliModule::AliModule():
70   fIdtmed(0),
71   fIdmate(0),
72   fLoMedium(0),
73   fHiMedium(0),
74   fActive(0),
75   fEnable(1),
76   fMaxIterTrackRef(0),
77   fCurrentIterTrackRef(0),
78   fRunLoader(0),
79   fDigInput(0)
80 {
81   //
82   // Default constructor for the AliModule class
83   //
84 }
85  
86 //_______________________________________________________________________
87 AliModule::AliModule(const char* name,const char *title):
88   TNamed(name,title),
89   fIdtmed(new TArrayI(100)),
90   fIdmate(new TArrayI(100)),
91   fLoMedium(65536),
92   fHiMedium(0),
93   fActive(0),
94   fEnable(1),
95   fMaxIterTrackRef(0),
96   fCurrentIterTrackRef(0),
97   fRunLoader(0),
98   fDigInput(0)
99 {
100   //
101   // Normal constructor invoked by all Modules.
102   // Create the list for Module specific histograms
103   // Add this Module to the global list of Modules in Run.
104   //
105   // Get the Module numeric ID
106
107   Int_t id = gAlice->GetModuleID(name);
108   if (id>=0) {
109     // Module already added !
110      AliWarning(Form("Module: %s already present at %d",name,id));
111      return;
112   }
113   //
114   // Add this Module to the list of Modules
115
116   gAlice->AddModule(this);
117
118   //PH  SetMarkerColor(3);
119   //
120   // Clear space for tracking media and material indexes
121
122   for(Int_t i=0;i<100;i++) (*fIdmate)[i]=(*fIdtmed)[i]=0;
123 }
124  
125 //_______________________________________________________________________
126 AliModule::~AliModule()
127 {
128   //
129   // Destructor
130   //
131
132   // Remove this Module from the list of Modules
133   if (gAlice) {
134     TObjArray * modules = gAlice->Modules();
135     if (modules) modules->Remove(this);
136   }
137
138   // Delete TArray objects
139   delete fIdtmed;
140   delete fIdmate;
141
142
143
144 //_______________________________________________________________________
145 void AliModule::AliMaterial(Int_t imat, const char* name, Float_t a, 
146                             Float_t z, Float_t dens, Float_t radl,
147                             Float_t absl, Float_t *buf, Int_t nwbuf) const
148 {
149   //
150   // Store the parameters for a material
151   //
152   // imat        the material index will be stored in (*fIdmate)[imat]
153   // name        material name
154   // a           atomic mass
155   // z           atomic number
156   // dens        density
157   // radl        radiation length
158   // absl        absorbtion length
159   // buf         adress of an array user words
160   // nwbuf       number of user words
161   //
162   Int_t kmat;
163   //Build the string uniquename as "DET_materialname"
164   TString uniquename = GetName();
165   uniquename.Append("_");
166   uniquename.Append(name);
167   //if geometry loaded from file only fill fIdmate, else create material too
168   if(AliSimulation::Instance()->IsGeometryFromFile()){
169     TGeoMaterial *mat = gGeoManager->GetMaterial(uniquename.Data());
170     kmat = mat->GetUniqueID();
171     (*fIdmate)[imat]=kmat;
172   }else{
173     if (fgDensityFactor != 1.0)
174       AliWarning(Form("Material density multiplied by %.2f!", fgDensityFactor));
175     TVirtualMC::GetMC()->Material(kmat, uniquename.Data(), a, z, dens * fgDensityFactor, radl, absl, buf, nwbuf);
176     (*fIdmate)[imat]=kmat;
177   }
178 }
179
180 //_______________________________________________________________________
181 void AliModule::AliGetMaterial(Int_t imat, char* name, Float_t &a, 
182                                Float_t &z, Float_t &dens, Float_t &radl,
183                                Float_t &absl) const
184 {
185   //
186   // Store the parameters for a material
187   //
188   // imat        the material index will be stored in (*fIdmate)[imat]
189   // name        material name
190   // a           atomic mass
191   // z           atomic number
192   // dens        density
193   // radl        radiation length
194   // absl        absorbtion length
195   // buf         adress of an array user words
196   // nwbuf       number of user words
197   //
198
199   Int_t kmat=(*fIdmate)[imat];
200   TString sname;
201   TArrayD par;
202   Double_t da, dz, ddens, dradl, dabsl;
203   TVirtualMC::GetMC()->GetMaterial(kmat, sname, da, dz, ddens, dradl, dabsl, par);
204
205   const char* chname = sname.Data();
206   strncpy(name, chname, strlen(chname)+1);
207   a = da;
208   z = dz;
209   dens = ddens;
210   radl = dradl;
211   absl = dabsl;
212 }
213
214 //_______________________________________________________________________
215 void AliModule::AliMixture(Int_t imat, const char *name, Float_t *a,
216                            Float_t *z, Float_t dens, Int_t nlmat,
217                            Float_t *wmat) const
218
219   //
220   // Defines mixture or compound imat as composed by 
221   // nlmat materials defined by arrays a, z and wmat
222   // 
223   // If nlmat > 0 wmat contains the proportion by
224   // weights of each basic material in the mixture  
225   // 
226   // If nlmat < 0 wmat contains the number of atoms 
227   // of eack kind in the molecule of the compound
228   // In this case, wmat is changed on output to the relative weigths.
229   //
230   // imat        the material index will be stored in (*fIdmate)[imat]
231   // name        material name
232   // a           array of atomic masses
233   // z           array of atomic numbers
234   // dens        density
235   // nlmat       number of components
236   // wmat        array of concentrations
237   //
238   Int_t kmat;
239   //Build the string uniquename as "DET_mixturename"
240   TString uniquename = GetName();
241   uniquename.Append("_");
242   uniquename.Append(name);
243   //if geometry loaded from file only fill fIdmate, else create mixture too
244   if(AliSimulation::Instance()->IsGeometryFromFile()){
245     TGeoMaterial *mat = gGeoManager->GetMaterial(uniquename.Data());
246     kmat = mat->GetUniqueID();
247     (*fIdmate)[imat]=kmat;
248   }else{
249     if (fgDensityFactor != 1.0)
250       AliWarning(Form("Material density multiplied by %.2f!", fgDensityFactor));
251     TVirtualMC::GetMC()->Mixture(kmat, uniquename.Data(), a, z, dens * fgDensityFactor, nlmat, wmat);
252     (*fIdmate)[imat]=kmat;
253   }
254
255  
256 //_______________________________________________________________________
257 void AliModule::AliMedium(Int_t numed, const char *name, Int_t nmat,
258                           Int_t isvol, Int_t ifield, Float_t fieldm,
259                           Float_t tmaxfd, Float_t stemax, Float_t deemax,
260                           Float_t epsil, Float_t stmin, Float_t *ubuf,
261                           Int_t nbuf) const
262
263   //
264   // Store the parameters of a tracking medium
265   //
266   // numed       the medium number is stored into (*fIdtmed)[numed]
267   // name        medium name
268   // nmat        the material number is stored into (*fIdmate)[nmat]
269   // isvol       sensitive volume if isvol!=0
270   // ifield      magnetic field flag (see below)
271   // fieldm      maximum magnetic field
272   // tmaxfd      maximum deflection angle due to magnetic field
273   // stemax      maximum step allowed
274   // deemax      maximum fractional energy loss in one step
275   // epsil       tracking precision in cm
276   // stmin       minimum step due to continuous processes
277   //
278   // ifield =  0       no magnetic field
279   //        = -1       user decision in guswim
280   //        =  1       tracking performed with Runge Kutta
281   //        =  2       tracking performed with helix
282   //        =  3       constant magnetic field along z
283   //  
284   Int_t kmed;
285   //Build the string uniquename as "DET_mediumname"
286   TString uniquename = GetName();
287   uniquename.Append("_");
288   uniquename.Append(name);
289   //if geometry loaded from file only fill fIdtmed, else create medium too
290   if(AliSimulation::Instance()->IsGeometryFromFile()){
291     TGeoMedium *med = gGeoManager->GetMedium(uniquename.Data());
292     kmed = med->GetId();
293     (*fIdtmed)[numed]=kmed;
294   }else{
295     TVirtualMC::GetMC()->Medium(kmed, uniquename.Data(), (*fIdmate)[nmat], isvol, ifield,
296                 fieldm, tmaxfd, stemax, deemax, epsil, stmin, ubuf, nbuf);
297     (*fIdtmed)[numed]=kmed;
298   }
299
300  
301 //_______________________________________________________________________
302 void AliModule::AliMatrix(Int_t &nmat, Float_t theta1, Float_t phi1,
303                           Float_t theta2, Float_t phi2, Float_t theta3,
304                           Float_t phi3) const
305 {
306   // 
307   // Define a rotation matrix. Angles are in degrees.
308   //
309   // nmat        on output contains the number assigned to the rotation matrix
310   // theta1      polar angle for axis I
311   // phi1        azimuthal angle for axis I
312   // theta2      polar angle for axis II
313   // phi2        azimuthal angle for axis II
314   // theta3      polar angle for axis III
315   // phi3        azimuthal angle for axis III
316   //
317   TVirtualMC::GetMC()->Matrix(nmat, theta1, phi1, theta2, phi2, theta3, phi3); 
318
319
320 //_______________________________________________________________________
321 Float_t AliModule::ZMin() const
322 {
323   return -500;
324 }
325
326 //_______________________________________________________________________
327 Float_t AliModule::ZMax() const
328 {
329   return 500;
330 }
331
332 //_______________________________________________________________________
333 void AliModule::AddAlignableVolumes() const
334 {
335   // 
336   if (IsActive())
337     AliWarning(Form(" %s still has to implement the AddAlignableVolumes method!",GetName()));
338 }
339
340 //_______________________________________________________________________
341
342 AliLoader*  AliModule::MakeLoader(const char* /*topfoldername*/)
343 {
344   return 0x0;
345 }
346  
347
348 //_____________________________________________________________________________
349 AliTrackReference*  AliModule::AddTrackReference(Int_t label, Int_t id){
350   //
351   // add a trackrefernce to the list
352     return (gAlice->GetMCApp()->AddTrackReference(label, id));
353 }
354
355 //_____________________________________________________________________________
356 TTree* AliModule::TreeTR()
357 {
358   //
359   // Return TR tree pointer
360   //
361   if ( fRunLoader == 0x0)
362    {
363      AliError("Can not get the run loader");
364      return 0x0;
365    }
366
367   TTree* tree = fRunLoader->TreeTR();
368   return tree;
369 }
370
371
372 //_____________________________________________________________________________
373 void AliModule::Digits2Raw()
374 {
375 // This is a dummy version that just copies the digits file contents
376 // to a raw data file.
377
378   AliWarning(Form("Dummy version called for %s", GetName()));
379
380   Int_t nDDLs = AliDAQ::NumberOfDdls(GetName());
381
382   if (!GetLoader()) return;
383   fstream digitsFile(GetLoader()->GetDigitsFileName(), ios::in);
384   if (!digitsFile) return;
385
386   digitsFile.seekg(0, ios::end);
387   UInt_t size = digitsFile.tellg();
388   UInt_t ddlSize = 4 * (size / (4*nDDLs));
389   Char_t* buffer = new Char_t[ddlSize+1];
390
391   for (Int_t iDDL = 0; iDDL < nDDLs; iDDL++) {
392     char fileName[256]="";
393     strncpy(fileName,AliDAQ::DdlFileName(GetName(),iDDL),255);
394     fstream rawFile(fileName, ios::out);
395     if (!rawFile) break;
396
397     AliRawDataHeaderV3 header;
398     header.fSize = ddlSize + sizeof(header);
399     rawFile.write((char*) &header, sizeof(header));
400
401     digitsFile.read(buffer, ddlSize);
402     rawFile.write(buffer, ddlSize);
403     rawFile.close();
404   }
405
406   digitsFile.close();
407   delete[] buffer;
408 }