1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
18 ///////////////////////////////////////////////////////////////////////////////
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. //
25 // This class is also responsible for building the geometry of the //
30 <img src="picts/AliModuleClass.gif">
34 ///////////////////////////////////////////////////////////////////////////////
37 #include <TObjArray.h>
38 #include <TClonesArray.h>
41 #include <TDirectory.h>
42 #include <TVirtualMC.h>
43 #include <TGeoManager.h>
47 #include "AliConfig.h"
48 #include "AliLoader.h"
50 #include "AliModule.h"
52 #include "AliTrackReference.h"
54 #include "AliRawDataHeader.h"
60 Float_t AliModule::fgDensityFactor = 1.0;
62 //_______________________________________________________________________
63 AliModule::AliModule():
75 fCurrentIterTrackRef(0),
79 // Default constructor for the AliModule class
83 //_______________________________________________________________________
84 AliModule::AliModule(const char* name,const char *title):
88 fIdtmed(new TArrayI(100)),
89 fIdmate(new TArrayI(100)),
93 fHistograms(new TList()),
97 fCurrentIterTrackRef(0),
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.
105 // Get the Module numeric ID
107 Int_t id = gAlice->GetModuleID(name);
109 // Module already added !
110 AliWarning(Form("Module: %s already present at %d",name,id));
114 // Add this Module to the list of Modules
116 gAlice->AddModule(this);
118 //PH SetMarkerColor(3);
120 // Clear space for tracking media and material indexes
122 for(Int_t i=0;i<100;i++) (*fIdmate)[i]=(*fIdtmed)[i]=0;
125 //_______________________________________________________________________
126 AliModule::~AliModule()
132 // Remove this Module from the list of Modules
134 TObjArray * modules = gAlice->Modules();
135 if (modules) modules->Remove(this);
137 // Delete ROOT geometry
145 fHistograms->Clear();
149 // Delete TArray objects
155 //_______________________________________________________________________
156 void AliModule::Disable()
159 // Disable Module on viewer
165 // Loop through geometry to disable all
166 // nodes for this Module
167 while((node = dynamic_cast<TNode*>(next()))) {
168 node->SetVisibility(-1);
172 //_______________________________________________________________________
173 void AliModule::Enable()
176 // Enable Module on the viewver
182 // Loop through geometry to enable all
183 // nodes for this Module
184 while((node = dynamic_cast<TNode*>(next()))) {
185 node->SetVisibility(3);
189 //_______________________________________________________________________
190 void AliModule::AliMaterial(Int_t imat, const char* name, Float_t a,
191 Float_t z, Float_t dens, Float_t radl,
192 Float_t absl, Float_t *buf, Int_t nwbuf) const
195 // Store the parameters for a material
197 // imat the material index will be stored in (*fIdmate)[imat]
198 // name material name
202 // radl radiation length
203 // absl absorbtion length
204 // buf adress of an array user words
205 // nwbuf number of user words
208 //Build the string uniquename as "DET_materialname"
209 TString uniquename = GetName();
210 uniquename.Append("_");
211 uniquename.Append(name);
212 //if geometry loaded from file only fill fIdmate, else create material too
213 if(gAlice->IsRootGeometry()){
214 TGeoMaterial *mat = gGeoManager->GetMaterial(uniquename.Data());
215 kmat = mat->GetUniqueID();
216 (*fIdmate)[imat]=kmat;
218 if (fgDensityFactor != 1.0)
219 AliWarning(Form("Material density multiplied by %.2f!", fgDensityFactor));
220 gMC->Material(kmat, uniquename.Data(), a, z, dens * fgDensityFactor, radl, absl, buf, nwbuf);
221 (*fIdmate)[imat]=kmat;
225 //_______________________________________________________________________
226 void AliModule::AliGetMaterial(Int_t imat, char* name, Float_t &a,
227 Float_t &z, Float_t &dens, Float_t &radl,
231 // Store the parameters for a material
233 // imat the material index will be stored in (*fIdmate)[imat]
234 // name material name
238 // radl radiation length
239 // absl absorbtion length
240 // buf adress of an array user words
241 // nwbuf number of user words
246 kmat=(*fIdmate)[imat];
247 gMC->Gfmate(kmat, name, a, z, dens, radl, absl, buf, nwbuf);
251 //_______________________________________________________________________
252 void AliModule::AliMixture(Int_t imat, const char *name, Float_t *a,
253 Float_t *z, Float_t dens, Int_t nlmat,
257 // Defines mixture or compound imat as composed by
258 // nlmat materials defined by arrays a, z and wmat
260 // If nlmat > 0 wmat contains the proportion by
261 // weights of each basic material in the mixture
263 // If nlmat < 0 wmat contains the number of atoms
264 // of eack kind in the molecule of the compound
265 // In this case, wmat is changed on output to the relative weigths.
267 // imat the material index will be stored in (*fIdmate)[imat]
268 // name material name
269 // a array of atomic masses
270 // z array of atomic numbers
272 // nlmat number of components
273 // wmat array of concentrations
276 //Build the string uniquename as "DET_mixturename"
277 TString uniquename = GetName();
278 uniquename.Append("_");
279 uniquename.Append(name);
280 //if geometry loaded from file only fill fIdmate, else create mixture too
281 if(gAlice->IsRootGeometry()){
282 TGeoMaterial *mat = gGeoManager->GetMaterial(uniquename.Data());
283 kmat = mat->GetUniqueID();
284 (*fIdmate)[imat]=kmat;
286 if (fgDensityFactor != 1.0)
287 AliWarning(Form("Material density multiplied by %.2f!", fgDensityFactor));
288 gMC->Mixture(kmat, uniquename.Data(), a, z, dens * fgDensityFactor, nlmat, wmat);
289 (*fIdmate)[imat]=kmat;
293 //_______________________________________________________________________
294 void AliModule::AliMedium(Int_t numed, const char *name, Int_t nmat,
295 Int_t isvol, Int_t ifield, Float_t fieldm,
296 Float_t tmaxfd, Float_t stemax, Float_t deemax,
297 Float_t epsil, Float_t stmin, Float_t *ubuf,
301 // Store the parameters of a tracking medium
303 // numed the medium number is stored into (*fIdtmed)[numed]
305 // nmat the material number is stored into (*fIdmate)[nmat]
306 // isvol sensitive volume if isvol!=0
307 // ifield magnetic field flag (see below)
308 // fieldm maximum magnetic field
309 // tmaxfd maximum deflection angle due to magnetic field
310 // stemax maximum step allowed
311 // deemax maximum fractional energy loss in one step
312 // epsil tracking precision in cm
313 // stmin minimum step due to continuous processes
315 // ifield = 0 no magnetic field
316 // = -1 user decision in guswim
317 // = 1 tracking performed with Runge Kutta
318 // = 2 tracking performed with helix
319 // = 3 constant magnetic field along z
322 //Build the string uniquename as "DET_mediumname"
323 TString uniquename = GetName();
324 uniquename.Append("_");
325 uniquename.Append(name);
326 //if geometry loaded from file only fill fIdtmed, else create medium too
327 if(gAlice->IsRootGeometry()){
328 TGeoMedium *med = gGeoManager->GetMedium(uniquename.Data());
330 (*fIdtmed)[numed]=kmed;
332 gMC->Medium(kmed, uniquename.Data(), (*fIdmate)[nmat], isvol, ifield,
333 fieldm, tmaxfd, stemax, deemax, epsil, stmin, ubuf, nbuf);
334 (*fIdtmed)[numed]=kmed;
338 //_______________________________________________________________________
339 void AliModule::AliMatrix(Int_t &nmat, Float_t theta1, Float_t phi1,
340 Float_t theta2, Float_t phi2, Float_t theta3,
344 // Define a rotation matrix. Angles are in degrees.
346 // nmat on output contains the number assigned to the rotation matrix
347 // theta1 polar angle for axis I
348 // phi1 azimuthal angle for axis I
349 // theta2 polar angle for axis II
350 // phi2 azimuthal angle for axis II
351 // theta3 polar angle for axis III
352 // phi3 azimuthal angle for axis III
354 gMC->Matrix(nmat, theta1, phi1, theta2, phi2, theta3, phi3);
357 //_______________________________________________________________________
358 Float_t AliModule::ZMin() const
363 //_______________________________________________________________________
364 Float_t AliModule::ZMax() const
369 //_______________________________________________________________________
370 void AliModule::SetEuclidFile(char* material, char* geometry)
373 // Sets the name of the Euclid file
375 fEuclidMaterial=material;
377 fEuclidGeometry=geometry;
379 char* name = new char[strlen(material)];
380 strcpy(name,material);
381 strcpy(&name[strlen(name)-4],".euc");
382 fEuclidGeometry=name;
387 //_______________________________________________________________________
388 void AliModule::ReadEuclid(const char* filnam, char* topvol)
391 // read in the geometry of the detector in euclid file format
393 // id_det : the detector identification (2=its,...)
394 // topvol : return parameter describing the name of the top
395 // volume of geometry.
400 // several changes have been made by miroslav helbich
401 // subroutine is rewrited to follow the new established way of memory
402 // booking for tracking medias and rotation matrices.
403 // all used tracking media have to be defined first, for this you can use
404 // subroutine greutmed.
405 // top volume is searched as only volume not positioned into another
408 Int_t i, nvol, iret, itmed, irot, numed, npar, ndiv, iaxe;
409 Int_t ndvmx, nr, flag;
410 char key[5], card[77], natmed[21];
411 char name[5], mother[5], shape[5], konly[5], volst[7000][5];
414 Float_t teta1, phi1, teta2, phi2, teta3, phi3, orig, step;
416 const Int_t kMaxRot=5000;
417 Int_t idrot[kMaxRot],istop[7000];
420 // *** The input filnam name will be with extension '.euc'
421 filtmp=gSystem->ExpandPathName(filnam);
422 lun=fopen(filtmp,"r");
425 AliError(Form("Could not open file %s",filnam));
428 //* --- definition of rotation matrix 0 ---
429 TArrayI &idtmed = *fIdtmed;
430 for(i=1; i<kMaxRot; ++i) idrot[i]=-99;
434 for(i=0;i<77;i++) card[i]=0;
435 iret=fscanf(lun,"%77[^\n]",card);
436 if(iret<=0) goto L20;
441 if (!strcmp(key,"TMED")) {
442 sscanf(&card[5],"%d '%[^']'",&itmed,natmed);
443 if( itmed<0 || itmed>=100 ) {
444 AliError(Form("TMED illegal medium number %d for %s",itmed,natmed));
447 //Pad the string with blanks
450 while(i<20) natmed[i++]=' ';
453 if( idtmed[itmed]<=0 ) {
454 AliError(Form("TMED undefined medium number %d for %s",itmed,natmed));
457 gMC->Gckmat(idtmed[itmed],natmed);
459 } else if (!strcmp(key,"ROTM")) {
460 sscanf(&card[4],"%d %f %f %f %f %f %f",&irot,&teta1,&phi1,&teta2,&phi2,&teta3,&phi3);
461 if( irot<=0 || irot>=kMaxRot ) {
462 AliError(Form("ROTM rotation matrix number %d illegal",irot));
465 AliMatrix(idrot[irot],teta1,phi1,teta2,phi2,teta3,phi3);
467 } else if (!strcmp(key,"VOLU")) {
468 sscanf(&card[5],"'%[^']' '%[^']' %d %d", name, shape, &numed, &npar);
470 for(i=0;i<npar;i++) fscanf(lun,"%f",&par[i]);
473 gMC->Gsvolu( name, shape, idtmed[numed], par, npar);
474 //* save the defined volumes
475 strcpy(volst[++nvol],name);
478 } else if (!strcmp(key,"DIVN")) {
479 sscanf(&card[5],"'%[^']' '%[^']' %d %d", name, mother, &ndiv, &iaxe);
480 gMC->Gsdvn ( name, mother, ndiv, iaxe );
482 } else if (!strcmp(key,"DVN2")) {
483 sscanf(&card[5],"'%[^']' '%[^']' %d %d %f %d",name, mother, &ndiv, &iaxe, &orig, &numed);
484 gMC->Gsdvn2( name, mother, ndiv, iaxe, orig,idtmed[numed]);
486 } else if (!strcmp(key,"DIVT")) {
487 sscanf(&card[5],"'%[^']' '%[^']' %f %d %d %d", name, mother, &step, &iaxe, &numed, &ndvmx);
488 gMC->Gsdvt ( name, mother, step, iaxe, idtmed[numed], ndvmx);
490 } else if (!strcmp(key,"DVT2")) {
491 sscanf(&card[5],"'%[^']' '%[^']' %f %d %f %d %d", name, mother, &step, &iaxe, &orig, &numed, &ndvmx);
492 gMC->Gsdvt2 ( name, mother, step, iaxe, orig, idtmed[numed], ndvmx );
494 } else if (!strcmp(key,"POSI")) {
495 sscanf(&card[5],"'%[^']' %d '%[^']' %f %f %f %d '%[^']'", name, &nr, mother, &xo, &yo, &zo, &irot, konly);
496 if( irot<0 || irot>=kMaxRot ) {
497 Error("ReadEuclid","POSI %s#%d rotation matrix number %d illegal\n",name,nr,irot);
500 if( idrot[irot] == -99) {
501 Error("ReadEuclid","POSI %s#%d undefined matrix number %d\n",name,nr,irot);
504 //*** volume name cannot be the top volume
505 for(i=1;i<=nvol;i++) {
506 if (!strcmp(volst[i],name)) istop[i]=0;
509 gMC->Gspos ( name, nr, mother, xo, yo, zo, idrot[irot], konly );
511 } else if (!strcmp(key,"POSP")) {
512 sscanf(&card[5],"'%[^']' %d '%[^']' %f %f %f %d '%[^']' %d", name, &nr, mother, &xo, &yo, &zo, &irot, konly, &npar);
513 if( irot<0 || irot>=kMaxRot ) {
514 Error("ReadEuclid","POSP %s#%d rotation matrix number %d illegal\n",name,nr,irot);
517 if( idrot[irot] == -99) {
518 Error("ReadEuclid","POSP %s#%d undefined matrix number %d\n",name,nr,irot);
522 for(i=0;i<npar;i++) fscanf(lun,"%f",&par[i]);
525 //*** volume name cannot be the top volume
526 for(i=1;i<=nvol;i++) {
527 if (!strcmp(volst[i],name)) istop[i]=0;
530 gMC->Gsposp ( name, nr, mother, xo,yo,zo, idrot[irot], konly, par, npar);
533 if (strcmp(key,"END")) goto L10;
534 //* find top volume in the geometry
536 for(i=1;i<=nvol;i++) {
537 if (istop[i] && flag) {
538 AliWarning(Form(" %s is another possible top volume",volst[i]));
540 if (istop[i] && !flag) {
541 strcpy(topvol,volst[i]);
542 AliDebug(2, Form("volume %s taken as a top volume",topvol));
547 AliWarning("top volume not found");
551 //* commented out only for the not cernlib version
552 AliDebug(1, Form("file: %s is now read in",filnam));
557 AliError("reading error or premature end of file");
560 //_______________________________________________________________________
561 void AliModule::ReadEuclidMedia(const char* filnam)
564 // read in the materials and tracking media for the detector
565 // in euclid file format
567 // filnam: name of the input file
568 // id_det: id_det is the detector identification (2=its,...)
570 // author : miroslav helbich
572 Float_t sxmgmx = gAlice->Field()->Max();
573 Int_t isxfld = gAlice->Field()->Integ();
574 Int_t end, i, iret, itmed;
575 char key[5], card[130], natmed[21], namate[21];
580 Int_t nwbuf, isvol, ifield, nmat;
581 Float_t a, z, dens, radl, absl, fieldm, tmaxfd, stemax, deemax, epsil, stmin;
584 for(i=0;i<end;i++) if(filnam[i]=='.') {
589 // *** The input filnam name will be with extension '.euc'
590 AliDebug(1, Form("The file name is %s",filnam)); //Debug
591 filtmp=gSystem->ExpandPathName(filnam);
592 lun=fopen(filtmp,"r");
595 AliWarning(Form("Could not open file %s",filnam));
599 // Retrieve Mag Field parameters
600 Int_t globField=gAlice->Field()->Integ();
601 Float_t globMaxField=gAlice->Field()->Max();
602 // TArrayI &idtmed = *fIdtmed;
605 for(i=0;i<130;i++) card[i]=0;
606 iret=fscanf(lun,"%4s %[^\n]",key,card);
607 if(iret<=0) goto L20;
611 if (!strcmp(key,"MATE")) {
612 sscanf(card,"%d '%[^']' %f %f %f %f %f %d",&imate,namate,&a,&z,&dens,&radl,&absl,&nwbuf);
613 if (nwbuf>0) for(i=0;i<nwbuf;i++) fscanf(lun,"%f",&ubuf[i]);
614 //Pad the string with blanks
617 while(i<20) namate[i++]=' ';
620 AliMaterial(imate,namate,a,z,dens,radl,absl,ubuf,nwbuf);
621 //* read tracking medium
622 } else if (!strcmp(key,"TMED")) {
623 sscanf(card,"%d '%[^']' %d %d %d %f %f %f %f %f %f %d",
624 &itmed,natmed,&nmat,&isvol,&ifield,&fieldm,&tmaxfd,
625 &stemax,&deemax,&epsil,&stmin,&nwbuf);
626 if (nwbuf>0) for(i=0;i<nwbuf;i++) fscanf(lun,"%f",&ubuf[i]);
627 if (ifield<0) ifield=isxfld;
628 if (fieldm<0) fieldm=sxmgmx;
629 //Pad the string with blanks
632 while(i<20) natmed[i++]=' ';
635 AliMedium(itmed,natmed,nmat,isvol,globField,globMaxField,tmaxfd,
636 stemax,deemax,epsil,stmin,ubuf,nwbuf);
637 // (*fImedia)[idtmed[itmed]-1]=id_det;
641 if (strcmp(key,"END")) goto L10;
644 //* commented out only for the not cernlib version
645 AliDebug(1, Form("file %s is now read in",filnam));
650 AliWarning("reading error or premature end of file");
653 //_______________________________________________________________________
654 void AliModule::AddAlignableVolumes() const
658 AliWarning(Form(" %s still has to implement the AddAlignableVolumes method!",GetName()));
661 //_______________________________________________________________________
663 AliLoader* AliModule::MakeLoader(const char* /*topfoldername*/)
669 //_____________________________________________________________________________
670 AliTrackReference* AliModule::AddTrackReference(Int_t label, Int_t id){
672 // add a trackrefernce to the list
673 return (gAlice->GetMCApp()->AddTrackReference(label, id));
676 //_____________________________________________________________________________
677 TTree* AliModule::TreeTR()
680 // Return TR tree pointer
682 if ( fRunLoader == 0x0)
684 AliError("Can not get the run loader");
688 TTree* tree = fRunLoader->TreeTR();
693 //_____________________________________________________________________________
694 void AliModule::Digits2Raw()
696 // This is a dummy version that just copies the digits file contents
697 // to a raw data file.
699 AliWarning(Form("Dummy version called for %s", GetName()));
701 Int_t nDDLs = AliDAQ::NumberOfDdls(GetName());
703 if (!GetLoader()) return;
704 fstream digitsFile(GetLoader()->GetDigitsFileName(), ios::in);
705 if (!digitsFile) return;
707 digitsFile.seekg(0, ios::end);
708 UInt_t size = digitsFile.tellg();
709 UInt_t ddlSize = 4 * (size / (4*nDDLs));
710 Char_t* buffer = new Char_t[ddlSize+1];
712 for (Int_t iDDL = 0; iDDL < nDDLs; iDDL++) {
714 strcpy(fileName,AliDAQ::DdlFileName(GetName(),iDDL));
715 fstream rawFile(fileName, ios::out);
716 if (!rawFile) return;
718 AliRawDataHeader header;
719 header.fSize = ddlSize + sizeof(header);
720 rawFile.write((char*) &header, sizeof(header));
722 digitsFile.read(buffer, ddlSize);
723 rawFile.write(buffer, ddlSize);