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 // Control class for Alice C++ //
21 // Only one single instance of this class exists. //
22 // The object is created in main program aliroot //
23 // and is pointed by the global gAlice. //
25 // -Supports the list of all Alice Detectors (fModules). //
26 // -Supports the list of particles (fParticles). //
27 // -Supports the Trees. //
28 // -Supports the geometry. //
29 // -Supports the event display. //
32 <img src="picts/AliRunClass.gif">
37 <img src="picts/alirun.gif">
41 ///////////////////////////////////////////////////////////////////////////////
45 #include <TDatabasePDG.h>
46 #include <TGeometry.h>
51 #include <TVirtualMC.h>
53 #include "AliDetector.h"
54 #include "AliDisplay.h"
55 #include "AliHeader.h"
57 #include "AliLegoGenerator.h"
60 #include "AliMagFCM.h"
61 #include "AliMagFDM.h"
71 //_______________________________________________________________________
88 fPDGDB(0), //Particle factory object
89 fConfigFunction("\0"),
94 // Default constructor for AliRun
96 AliConfig::Instance();//skowron 29 Feb 2002
97 //ensures that the folder structure is build
100 //_______________________________________________________________________
101 AliRun::AliRun(const AliRun& arun):
118 fPDGDB(0), //Particle factory object
119 fConfigFunction("\0"),
124 // Copy constructor for AliRun
129 //_____________________________________________________________________________
130 AliRun::AliRun(const char *name, const char *title):
137 fModules(new TObjArray(77)), // Support list for the Detectors
147 fPDGDB(TDatabasePDG::Instance()), //Particle factory object!
148 fConfigFunction("Config();"),
149 fRandom(new TRandom3()),
153 // Constructor for the main processor.
154 // Creates the geometry
155 // Creates the list of Detectors.
156 // Creates the list of particles.
161 // Set random number generator
164 if (gSystem->Getenv("CONFIG_SEED")) {
165 gRandom->SetSeed(static_cast<UInt_t>(atoi(gSystem->Getenv("CONFIG_SEED"))));
168 // Add to list of browsable
169 gROOT->GetListOfBrowsables()->Add(this,name);
170 // Create the TNode geometry for the event display
171 BuildSimpleGeometry();
173 // Create default mag field
176 // Add particle list to configuration
177 AliConfig::Instance()->Add(fPDGDB);
182 //_______________________________________________________________________
186 // Default AliRun destructor
188 gROOT->GetListOfBrowsables()->Remove(this);
192 TFolder* evfold = fRunLoader->GetEventFolder();
193 TFolder* modfold = dynamic_cast<TFolder*>(evfold->FindObjectAny(AliConfig::GetModulesFolderName()));
194 TIter next(fModules);
196 while((mod = (AliModule*)next()))
198 modfold->Remove(mod);
217 //_______________________________________________________________________
218 void AliRun::Copy(TObject &) const
220 Fatal("Copy","Not implemented!\n");
223 //_______________________________________________________________________
227 // Initialize Alice geometry
232 //_______________________________________________________________________
233 void AliRun::BuildSimpleGeometry()
236 // Create a simple TNode geometry used by Root display engine
238 // Initialise geometry
240 fGeometry = new TGeometry("AliceGeom","Galice Geometry for Hits");
241 new TMaterial("void","Vacuum",0,0,0); //Everything is void
242 TBRIK *brik = new TBRIK("S_alice","alice volume","void",2000,2000,3000);
243 brik->SetVisibility(0);
244 new TNode("alice","alice","S_alice");
247 //_______________________________________________________________________
248 void AliRun::CleanDetectors()
251 // Clean Detectors at the end of event
253 fRunLoader->CleanDetectors();
256 //_______________________________________________________________________
257 void AliRun::ResetHits()
262 //_______________________________________________________________________
263 AliGenerator* AliRun::Generator() const
265 return fMCApp->Generator();
268 //_______________________________________________________________________
269 void AliRun::SetField(AliMagF* magField)
272 // Set Magnetic Field Map
278 //_______________________________________________________________________
279 void AliRun::SetField(Int_t type, Int_t version, Float_t scale,
280 Float_t maxField, const char* filename)
283 // Set magnetic field parameters
284 // type Magnetic field transport flag 0=no field, 2=helix, 3=Runge Kutta
285 // version Magnetic field map version (only 1 active now)
286 // scale Scale factor for the magnetic field
287 // maxField Maximum value for the magnetic field
290 // --- Sanity check on mag field flags
291 if(fField) delete fField;
293 fField = new AliMagFC("Map1"," ",type,scale,maxField);
294 } else if(version<=2) {
295 fField = new AliMagFCM("Map2-3",filename,type,scale,maxField);
297 } else if(version==3) {
298 fField = new AliMagFDM("Map4",filename,type,scale,maxField);
301 Warning("SetField","Invalid map %d\n",version);
305 //_____________________________________________________________________________
307 void AliRun::InitLoaders()
309 //creates list of getters
310 if (GetDebug()) Info("InitLoaders","");
311 TIter next(fModules);
313 while((mod = (AliModule*)next()))
315 mod->SetRunLoader(fRunLoader);
316 AliDetector *det = dynamic_cast<AliDetector*>(mod);
319 if (GetDebug()) Info("InitLoaders"," Adding %s ",det->GetName());
320 fRunLoader->AddLoader(det);
323 if (GetDebug()) Info("InitLoaders","Done");
325 //_____________________________________________________________________________
327 void AliRun::FinishRun()
330 // Called at the end of the run.
335 if (GetDebug()) Info("FinishRun"," Finish Lego");
336 fRunLoader->CdGAFile();
340 // Clean detector information
341 TIter next(fModules);
343 while((detector = dynamic_cast<AliModule*>(next()))) {
344 if (GetDebug()) Info("FinishRun"," %s->FinishRun()",detector->GetName());
345 detector->FinishRun();
348 if (GetDebug()) Info("FinishRun"," fRunLoader->WriteHeader(OVERWRITE)");
349 fRunLoader->WriteHeader("OVERWRITE");
351 // Write AliRun info and all detectors parameters
352 fRunLoader->CdGAFile();
353 Write(0,TObject::kOverwrite);//write AliRun
354 fRunLoader->Write(0,TObject::kOverwrite);//write RunLoader itself
356 // Clean tree information
357 if (GetDebug()) Info("FinishRun"," fRunLoader->Stack()->FinishRun()");
358 fRunLoader->Stack()->FinishRun();
360 if(fMCApp) fMCApp->FinishRun();
362 fRunLoader->Synchronize();
365 //_______________________________________________________________________
366 void AliRun::Announce() const
369 // Announce the current version of AliRoot
372 "****************************************************************\n");
373 printf("%6s","*");printf("%64s","*\n");
376 printf(" You are running AliRoot version NewIO\n");
379 printf(" The cvs tag for the current program is $Name$\n");
381 printf("%6s","*");printf("%64s","*\n");
383 "****************************************************************\n");
386 //_______________________________________________________________________
387 AliModule *AliRun::GetModule(const char *name) const
390 // Return pointer to detector from name
392 return dynamic_cast<AliModule*>(fModules->FindObject(name));
395 //_______________________________________________________________________
396 AliDetector *AliRun::GetDetector(const char *name) const
399 // Return pointer to detector from name
401 return dynamic_cast<AliDetector*>(fModules->FindObject(name));
404 //_______________________________________________________________________
405 Int_t AliRun::GetModuleID(const char *name) const
408 // Return galice internal detector identifier from name
411 TObject *mod=fModules->FindObject(name);
412 if(mod) i=fModules->IndexOf(mod);
416 //_______________________________________________________________________
417 Int_t AliRun::GetEvent(Int_t event)
420 // Reloads data containers in folders # event
421 // Set branch addresses
423 if (fRunLoader == 0x0)
425 Error("GetEvent","RunLoader is not set. Can not load data.");
428 /*****************************************/
429 /**** P R E R E L O A D I N G ****/
430 /*****************************************/
431 // Reset existing structures
433 fMCApp->ResetTrackReferences();
437 /*****************************************/
438 /**** R E L O A D ****/
439 /*****************************************/
441 fRunLoader->GetEvent(event);
443 /*****************************************/
444 /**** P O S T R E L O A D I N G ****/
445 /*****************************************/
447 // Set Trees branch addresses
448 TIter next(fModules);
450 while((detector = dynamic_cast<AliModule*>(next())))
452 detector->SetTreeAddress();
455 return fRunLoader->GetHeader()->GetNtrack();
458 //_______________________________________________________________________
459 TGeometry *AliRun::GetGeometry()
462 // Import Alice geometry from current file
463 // Return pointer to geometry object
465 if (!fGeometry) fGeometry = dynamic_cast<TGeometry*>(gDirectory->Get("AliceGeom"));
467 // Unlink and relink nodes in detectors
468 // This is bad and there must be a better way...
471 TIter next(fModules);
473 while((detector = dynamic_cast<AliModule*>(next()))) {
474 TList *dnodes=detector->Nodes();
477 for ( j=0; j<dnodes->GetSize(); j++) {
478 node = dynamic_cast<TNode*>(dnodes->At(j));
479 node1 = fGeometry->GetNode(node->GetName());
480 dnodes->Remove(node);
481 dnodes->AddAt(node1,j);
487 //_______________________________________________________________________
488 void AliRun::SetBaseFile(const char *filename)
490 fBaseFileName = filename;
493 //_______________________________________________________________________
494 void AliRun::ResetDigits()
497 // Reset all Detectors digits
499 TIter next(fModules);
501 while((detector = dynamic_cast<AliModule*>(next()))) {
502 detector->ResetDigits();
506 //_______________________________________________________________________
507 void AliRun::ResetSDigits()
510 // Reset all Detectors digits
512 TIter next(fModules);
514 while((detector = dynamic_cast<AliModule*>(next()))) {
515 detector->ResetSDigits();
520 //_______________________________________________________________________
522 void AliRun::ResetPoints()
525 // Reset all Detectors points
527 TIter next(fModules);
529 while((detector = dynamic_cast<AliModule*>(next()))) {
530 detector->ResetPoints();
533 //_______________________________________________________________________
535 void AliRun::InitMC(const char *setup)
538 // Initialize ALICE Simulation run
543 Warning("Init","Cannot initialise AliRun twice!\n");
547 fMCApp=new AliMC(GetName(),GetTitle());
549 gROOT->LoadMacro(setup);
550 gInterpreter->ProcessLine(fConfigFunction.Data());
552 fRunLoader->CdGAFile();
554 AliPDG::AddParticlesToPdgDataBase();
556 fNdets = fModules->GetLast()+1;
558 // Added also after in case of interactive initialisation of modules
559 fNdets = fModules->GetLast()+1;
561 TIter next(fModules);
562 for(Int_t i=0; i<fNdets; ++i)
564 TObject *objfirst, *objlast;
565 AliModule *detector=dynamic_cast<AliModule*>(fModules->At(i));
566 objlast = gDirectory->GetList()->Last();
568 // Add Detector histograms in Detector list of histograms
569 if (objlast) objfirst = gDirectory->GetList()->After(objlast);
570 else objfirst = gDirectory->GetList()->First();
573 detector->Histograms()->Add(objfirst);
574 objfirst = gDirectory->GetList()->After(objfirst);
580 //Must be here because some MCs (G4) adds detectors here and not in Config.C
582 fRunLoader->MakeTree("E");
585 fRunLoader->LoadKinematics("RECREATE");
586 fRunLoader->LoadTrackRefs("RECREATE");
587 fRunLoader->LoadHits("all","RECREATE");
591 // Save stuff at the beginning of the file to avoid file corruption
592 fRunLoader->CdGAFile();
594 fEventNrInRun = -1; //important - we start Begin event from increasing current number in run
597 //_______________________________________________________________________
599 void AliRun::RunMC(Int_t nevent, const char *setup)
602 // Main function to be called to process a galice run
604 // Root > gAlice.Run();
605 // a positive number of events will cause the finish routine
608 fEventsPerRun = nevent;
609 // check if initialisation has been done
610 if (!fInitDone) InitMC(setup);
612 // Create the Root Tree with one branch per detector
613 //Hits moved to begin event -> now we are crating separate tree for each event
615 gMC->ProcessRun(nevent);
617 // End of this run, close files
618 if(nevent>0) FinishRun();
621 //_______________________________________________________________________
622 void AliRun::RunReco(const char *selected, Int_t first, Int_t last)
625 // Main function to be called to reconstruct Alice event
627 Int_t nev = fRunLoader->GetNumberOfEvents();
628 if (GetDebug()) Info("RunReco","Found %d events",nev);
629 Int_t nFirst = first;
630 Int_t nLast = (last < 0)? nev : last;
632 for (Int_t nevent = nFirst; nevent <= nLast; nevent++) {
633 if (GetDebug()) Info("RunReco","Processing event %d",nevent);
635 Digits2Reco(selected);
639 //_______________________________________________________________________
641 void AliRun::Hits2Digits(const char *selected)
644 // Convert Hits to sumable digits
646 for (Int_t nevent=0; nevent<gAlice->TreeE()->GetEntries(); nevent++) {
648 Hits2SDigits(selected);
649 SDigits2Digits(selected);
654 //_______________________________________________________________________
656 void AliRun::Tree2Tree(Option_t *option, const char *selected)
659 // Function to transform the content of
661 // - TreeH to TreeS (option "S")
662 // - TreeS to TreeD (option "D")
663 // - TreeD to TreeR (option "R")
665 // If multiple options are specified ("SDR"), transformation will be done in sequence for
666 // selected detector and for all detectors if none is selected (detector string
667 // can contain blank separated list of detector names).
670 const char *oS = strstr(option,"S");
671 const char *oD = strstr(option,"D");
672 const char *oR = strstr(option,"R");
674 TObjArray *detectors = Detectors();
676 TIter next(detectors);
678 AliDetector *detector = 0;
680 while((detector = dynamic_cast<AliDetector*>(next()))) {
682 if (strcmp(detector->GetName(),selected)) continue;
683 if (detector->IsActive())
686 AliLoader* loader = detector->GetLoader();
687 if (loader == 0x0) continue;
691 if (GetDebug()) Info("Tree2Tree","Processing Hits2SDigits for %s ...",detector->GetName());
692 loader->LoadHits("read");
693 if (loader->TreeS() == 0x0) loader->MakeTree("S");
694 detector->MakeBranch(option);
695 detector->SetTreeAddress();
696 detector->Hits2SDigits();
697 loader->UnloadHits();
698 loader->UnloadSDigits();
702 if (GetDebug()) Info("Tree2Tree","Processing SDigits2Digits for %s ...",detector->GetName());
703 loader->LoadSDigits("read");
704 if (loader->TreeD() == 0x0) loader->MakeTree("D");
705 detector->MakeBranch(option);
706 detector->SetTreeAddress();
707 detector->SDigits2Digits();
708 loader->UnloadSDigits();
709 loader->UnloadDigits();
713 if (GetDebug()) Info("Tree2Tree","Processing Digits2Reco for %s ...",detector->GetName());
714 loader->LoadDigits("read");
715 if (loader->TreeR() == 0x0) loader->MakeTree("R");
716 detector->MakeBranch(option);
717 detector->SetTreeAddress();
718 detector->Digits2Reco();
719 loader->UnloadDigits();
720 loader->UnloadRecPoints();
727 //_______________________________________________________________________
728 void AliRun::RunLego(const char *setup, Int_t nc1, Float_t c1min,
729 Float_t c1max,Int_t nc2,Float_t c2min,Float_t c2max,
730 Float_t rmin,Float_t rmax,Float_t zmax, AliLegoGenerator* gener)
733 // Generates lego plots of:
734 // - radiation length map phi vs theta
735 // - radiation length map phi vs eta
736 // - interaction length map
737 // - g/cm2 length map
739 // ntheta bins in theta, eta
740 // themin minimum angle in theta (degrees)
741 // themax maximum angle in theta (degrees)
743 // phimin minimum angle in phi (degrees)
744 // phimax maximum angle in phi (degrees)
745 // rmin minimum radius
746 // rmax maximum radius
749 // The number of events generated = ntheta*nphi
750 // run input parameters in macro setup (default="Config.C")
752 // Use macro "lego.C" to visualize the 3 lego plots in spherical coordinates
755 <img src="picts/AliRunLego1.gif">
760 <img src="picts/AliRunLego2.gif">
765 <img src="picts/AliRunLego3.gif">
770 // check if initialisation has been done
771 // If runloader has been initialized, set the number of events per file to nc1 * nc2
774 if (!gener) gener = new AliLegoGenerator();
776 // Configure Generator
777 gener->SetRadiusRange(rmin, rmax);
778 gener->SetZMax(zmax);
779 gener->SetCoor1Range(nc1, c1min, c1max);
780 gener->SetCoor2Range(nc2, c2min, c2max);
784 fLego = new AliLego("lego",gener);
786 if (!fInitDone) InitMC(setup);
787 //Save current generator
789 AliGenerator *gen=fMCApp->Generator();
790 fMCApp->ResetGenerator(gener);
791 //Prepare MC for Lego Run
796 if (fRunLoader) fRunLoader->SetNumberOfEventsPerFile(nc1 * nc2);
797 //gMC->ProcessRun(nc1*nc2+1);
798 gMC->ProcessRun(nc1*nc2);
800 // End of this run, close files
802 // Restore current generator
803 fMCApp->ResetGenerator(gen);
804 // Delete Lego Object
805 delete fLego; fLego=0;
808 //_______________________________________________________________________
809 void AliRun::SetConfigFunction(const char * config)
812 // Set the signature of the function contained in Config.C to configure
815 fConfigFunction=config;
822 //_______________________________________________________________________
823 void AliRun::Field(const Double_t* x, Double_t *b) const
826 // Return the value of the magnetic field
829 for (Int_t i=0; i<3; i++) xfloat[i] = x[i];
833 Field()->Field(xfloat,bfloat);
834 for (Int_t j=0; j<3; j++) b[j] = bfloat[j];
837 printf("No mag field defined!\n");
843 // End of MC Application
846 //_______________________________________________________________________
847 void AliRun::Streamer(TBuffer &R__b)
849 // Stream an object of class AliRun.
851 if (R__b.IsReading()) {
852 if (!gAlice) gAlice = this;
853 AliRun::Class()->ReadBuffer(R__b, this);
854 gROOT->GetListOfBrowsables()->Add(this,"Run");
858 AliRun::Class()->WriteBuffer(R__b, this);
861 //_______________________________________________________________________
863 void AliRun::SetGenEventHeader(AliGenEventHeader* header)
865 fRunLoader->GetHeader()->SetGenEventHeader(header);
867 //_______________________________________________________________________
869 Int_t AliRun::GetEvNumber() const
871 //Returns number of current event
872 if (fRunLoader == 0x0)
874 Error("GetEvent","RunLoader is not set. Can not load data.");
878 return fRunLoader->GetEventNumber();
880 //_______________________________________________________________________
882 void AliRun::SetRunLoader(AliRunLoader* rloader)
885 // Set the loader of the run
887 fRunLoader = rloader;
888 if (fRunLoader == 0x0) return;
891 TFolder* evfold = fRunLoader->GetEventFolder();
892 if (evfold) evfoldname = evfold->GetName();
893 else Warning("SetRunLoader","Did not get Event Folder from Run Loader");
895 if ( fRunLoader->GetAliRun() )
896 {//if alrun already exists in folder
897 if (fRunLoader->GetAliRun() != this )
898 {//and is different than this - crash
899 Fatal("AliRun","AliRun is already in Folder and it is not this object");
905 evfold->Add(this);//Post this AliRun to Folder
908 TIter next(fModules);
910 while((module = (AliModule*)next()))
912 if (evfold) AliConfig::Instance()->Add(module,evfoldname);
913 module->SetRunLoader(fRunLoader);
914 AliDetector* detector = dynamic_cast<AliDetector*>(module);
917 AliLoader* loader = fRunLoader->GetLoader(detector);
920 Error("SetRunLoader","Can not get loader for detector %s",detector->GetName());
924 if (GetDebug()) Info("SetRunLoader","Setting loader for detector %s",detector->GetName());
925 detector->SetLoader(loader);
931 void AliRun::AddModule(AliModule* mod)
934 // Add a module to the module list
936 if (mod == 0x0) return;
937 if (strlen(mod->GetName()) == 0) return;
938 if (GetModuleID(mod->GetName()) >= 0) return;
940 if (GetDebug()) Info("AddModule","%s",mod->GetName());
941 if (fRunLoader == 0x0) AliConfig::Instance()->Add(mod);
942 else AliConfig::Instance()->Add(mod,fRunLoader->GetEventFolder()->GetName());