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>
45 #include "AliConfig.h"
46 #include "AliLoader.h"
48 #include "AliModule.h"
50 #include "AliTrackReference.h"
52 #include "../RAW/AliRawDataHeader.h"
56 //_______________________________________________________________________
57 AliModule::AliModule():
70 fCurrentIterTrackRef(0),
74 // Default constructor for the AliModule class
78 //_______________________________________________________________________
79 AliModule::AliModule(const char* name,const char *title):
83 fIdtmed(new TArrayI(100)),
84 fIdmate(new TArrayI(100)),
88 fHistograms(new TList()),
91 fTrackReferences(new TClonesArray("AliTrackReference", 100)),
93 fCurrentIterTrackRef(0),
97 // Normal constructor invoked by all Modules.
98 // Create the list for Module specific histograms
99 // Add this Module to the global list of Modules in Run.
101 // Get the Module numeric ID
102 Int_t id = gAlice->GetModuleID(name);
104 // Module already added !
105 AliWarning(Form("Module: %s already present at %d",name,id));
109 // Add this Module to the list of Modules
111 gAlice->AddModule(this);
115 // Clear space for tracking media and material indexes
117 for(Int_t i=0;i<100;i++) (*fIdmate)[i]=(*fIdtmed)[i]=0;
120 //_______________________________________________________________________
121 AliModule::AliModule(const AliModule &mod):
138 fCurrentIterTrackRef(0),
147 //_______________________________________________________________________
148 AliModule::~AliModule()
154 // Remove this Module from the list of Modules
156 TObjArray * modules = gAlice->Modules();
157 if (modules) modules->Remove(this);
159 // Delete ROOT geometry
167 fHistograms->Clear();
171 // Delete track references
172 if (fTrackReferences) {
173 fTrackReferences->Delete();
174 delete fTrackReferences;
175 fTrackReferences = 0;
177 // Delete TArray objects
183 //_______________________________________________________________________
184 void AliModule::Copy(TObject & /* mod */) const
187 // Copy *this onto mod, not implemented for AliModule
189 AliFatal("Not implemented!");
192 //_______________________________________________________________________
193 void AliModule::Disable()
196 // Disable Module on viewer
202 // Loop through geometry to disable all
203 // nodes for this Module
204 while((node = dynamic_cast<TNode*>(next()))) {
205 node->SetVisibility(-1);
209 //_______________________________________________________________________
210 void AliModule::Enable()
213 // Enable Module on the viewver
219 // Loop through geometry to enable all
220 // nodes for this Module
221 while((node = dynamic_cast<TNode*>(next()))) {
222 node->SetVisibility(3);
226 //_______________________________________________________________________
227 void AliModule::AliMaterial(Int_t imat, const char* name, Float_t a,
228 Float_t z, Float_t dens, Float_t radl,
229 Float_t absl, Float_t *buf, Int_t nwbuf) const
232 // Store the parameters for a material
234 // imat the material index will be stored in (*fIdmate)[imat]
235 // name material name
239 // radl radiation length
240 // absl absorbtion length
241 // buf adress of an array user words
242 // nwbuf number of user words
245 gMC->Material(kmat, name, a, z, dens, radl, absl, buf, nwbuf);
246 (*fIdmate)[imat]=kmat;
249 //_______________________________________________________________________
250 void AliModule::AliGetMaterial(Int_t imat, char* name, Float_t &a,
251 Float_t &z, Float_t &dens, Float_t &radl,
255 // Store the parameters for a material
257 // imat the material index will be stored in (*fIdmate)[imat]
258 // name material name
262 // radl radiation length
263 // absl absorbtion length
264 // buf adress of an array user words
265 // nwbuf number of user words
270 kmat=(*fIdmate)[imat];
271 gMC->Gfmate(kmat, name, a, z, dens, radl, absl, buf, nwbuf);
275 //_______________________________________________________________________
276 void AliModule::AliMixture(Int_t imat, const char *name, Float_t *a,
277 Float_t *z, Float_t dens, Int_t nlmat,
281 // Defines mixture or compound imat as composed by
282 // nlmat materials defined by arrays a, z and wmat
284 // If nlmat > 0 wmat contains the proportion by
285 // weights of each basic material in the mixture
287 // If nlmat < 0 wmat contains the number of atoms
288 // of eack kind in the molecule of the compound
289 // In this case, wmat is changed on output to the relative weigths.
291 // imat the material index will be stored in (*fIdmate)[imat]
292 // name material name
293 // a array of atomic masses
294 // z array of atomic numbers
296 // nlmat number of components
297 // wmat array of concentrations
300 gMC->Mixture(kmat, name, a, z, dens, nlmat, wmat);
301 (*fIdmate)[imat]=kmat;
304 //_______________________________________________________________________
305 void AliModule::AliMedium(Int_t numed, const char *name, Int_t nmat,
306 Int_t isvol, Int_t ifield, Float_t fieldm,
307 Float_t tmaxfd, Float_t stemax, Float_t deemax,
308 Float_t epsil, Float_t stmin, Float_t *ubuf,
312 // Store the parameters of a tracking medium
314 // numed the medium number is stored into (*fIdtmed)[numed]
316 // nmat the material number is stored into (*fIdmate)[nmat]
317 // isvol sensitive volume if isvol!=0
318 // ifield magnetic field flag (see below)
319 // fieldm maximum magnetic field
320 // tmaxfd maximum deflection angle due to magnetic field
321 // stemax maximum step allowed
322 // deemax maximum fractional energy loss in one step
323 // epsil tracking precision in cm
324 // stmin minimum step due to continuous processes
326 // ifield = 0 no magnetic field
327 // = -1 user decision in guswim
328 // = 1 tracking performed with Runge Kutta
329 // = 2 tracking performed with helix
330 // = 3 constant magnetic field along z
333 gMC->Medium(kmed,name, (*fIdmate)[nmat], isvol, ifield, fieldm,
334 tmaxfd, stemax, deemax, epsil, stmin, ubuf, nbuf);
335 (*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::RemapTrackReferencesIDs(Int_t *map)
657 // Remapping track reference
658 // Called at finish primary
660 if (!fTrackReferences) return;
661 for (Int_t i=0;i<fTrackReferences->GetEntries();i++){
662 AliTrackReference * ref = dynamic_cast<AliTrackReference*>(fTrackReferences->UncheckedAt(i));
664 Int_t newID = map[ref->GetTrack()];
665 if (newID>=0) ref->SetTrack(newID);
668 ref->SetBit(kNotDeleted,kFALSE);
669 fTrackReferences->RemoveAt(i);
673 fTrackReferences->Compress();
678 //_______________________________________________________________________
679 AliTrackReference* AliModule::FirstTrackReference(Int_t track)
682 // Initialise the hit iterator
683 // Return the address of the first hit for track
684 // If track>=0 the track is read from disk
685 // while if track<0 the first hit of the current
690 if (fRunLoader == 0x0)
691 AliFatal("AliRunLoader not initialized. Can not proceed");
692 fRunLoader->GetAliRun()->GetMCApp()->ResetTrackReferences();
693 fRunLoader->TreeTR()->GetEvent(track);
696 fMaxIterTrackRef = fTrackReferences->GetEntriesFast();
697 fCurrentIterTrackRef = 0;
698 if(fMaxIterTrackRef) return dynamic_cast<AliTrackReference*>(fTrackReferences->UncheckedAt(0));
702 //_______________________________________________________________________
703 AliTrackReference* AliModule::NextTrackReference()
706 // Return the next hit for the current track
708 if(fMaxIterTrackRef) {
709 if(++fCurrentIterTrackRef<fMaxIterTrackRef)
710 return dynamic_cast<AliTrackReference*>(fTrackReferences->UncheckedAt(fCurrentIterTrackRef));
714 AliWarning("Iterator called without calling FistTrackReference before");
720 //_______________________________________________________________________
721 void AliModule::ResetTrackReferences()
724 // Reset number of hits and the hits array
726 fMaxIterTrackRef = 0;
727 if (fTrackReferences) fTrackReferences->Clear();
730 //_____________________________________________________________________________
732 AliLoader* AliModule::MakeLoader(const char* /*topfoldername*/)
737 //PH Merged with v3-09-08 |
739 //_____________________________________________________________________________
741 void AliModule::SetTreeAddress()
744 // Set branch address for track reference Tree
749 // Branch address for track reference tree
750 TTree *treeTR = TreeTR();
752 if (treeTR && fTrackReferences) {
753 branch = treeTR->GetBranch(GetName());
756 AliDebug(3, Form("(%s) Setting for TrackRefs",GetName()));
757 branch->SetAddress(&fTrackReferences);
761 //can be called before MakeBranch and than does not make sense to issue the warning
762 AliDebug(1, Form("(%s) Failed for Track References. Can not find branch in tree.",
768 //_____________________________________________________________________________
769 void AliModule::AddTrackReference(Int_t label){
771 // add a trackrefernce to the list
772 if (!fTrackReferences) {
773 AliError("Container trackrefernce not active");
776 Int_t nref = fTrackReferences->GetEntriesFast();
777 TClonesArray &lref = *fTrackReferences;
778 new(lref[nref]) AliTrackReference(label);
782 //_____________________________________________________________________________
783 void AliModule::MakeBranchTR(Option_t */*option*/)
786 // Makes branch in treeTR
788 AliDebug(2,Form("Making Track Refs. Branch for %s",GetName()));
789 TTree * tree = TreeTR();
790 if (fTrackReferences && tree)
792 TBranch *branch = tree->GetBranch(GetName());
795 AliDebug(2,Form("Branch %s is already in tree.",GetName()));
799 branch = tree->Branch(GetName(),&fTrackReferences);
803 AliDebug(2,Form("FAILED for %s: tree=%#x fTrackReferences=%#x",
804 GetName(),tree,fTrackReferences));
808 //_____________________________________________________________________________
809 TTree* AliModule::TreeTR()
812 // Return TR tree pointer
814 if ( fRunLoader == 0x0)
816 AliError("Can not get the run loader");
820 TTree* tree = fRunLoader->TreeTR();
825 //_____________________________________________________________________________
826 void AliModule::Digits2Raw()
828 // This is a dummy version that just copies the digits file contents
829 // to a raw data file.
831 AliWarning(Form("Dummy version called for %s", GetName()));
833 const Int_t kNDetectors = 17;
834 const char* kDetectors[kNDetectors] = {"TPC", "ITSSPD", "ITSSDD", "ITSSSD", "TRD", "TOF", "PHOS", "RICH", "EMCAL", "MUON", "MUTR", "ZDC", "PMD", "START", "VZERO", "CRT", "FMD"};
835 const Int_t kDetectorDDLs[kNDetectors] = {216, 20, 12, 16, 18, 72, 20, 20, 22, 20, 2, 1, 6, 1, 1, 1, 3};
838 for (Int_t i = 0; i < kNDetectors; i++) {
839 if (strcmp(GetName(), kDetectors[i]) == 0) {
840 nDDLs = kDetectorDDLs[i];
841 ddlOffset = 0x100 * i;
845 if (!GetLoader()) return;
846 fstream digitsFile(GetLoader()->GetDigitsFileName(), ios::in);
847 if (!digitsFile) return;
849 digitsFile.seekg(0, ios::end);
850 UInt_t size = digitsFile.tellg();
851 UInt_t ddlSize = 4 * (size / (4*nDDLs));
852 Char_t* buffer = new Char_t[ddlSize+1];
854 for (Int_t iDDL = 0; iDDL < nDDLs; iDDL++) {
856 sprintf(fileName, "%s_%d.ddl", GetName(), iDDL + ddlOffset);
857 fstream rawFile(fileName, ios::out);
858 if (!rawFile) return;
860 AliRawDataHeader header;
861 header.fSize = ddlSize + sizeof(header);
862 rawFile.write((char*) &header, sizeof(header));
864 digitsFile.read(buffer, ddlSize);
865 rawFile.write(buffer, ddlSize);
874 //_____________________________________________________________________________
875 Int_t AliModule::GetDebug() const
877 AliWarning("Don't use this method any more, use AliDebug instead");