add external setter for MC parents list
[u/mrichter/AliRoot.git] / EMCAL / AliEMCAL.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 // Base Class for EMCAL description:
19 // This class contains material definitions    
20 // for the EMCAL - It does not place the detector in Alice
21 //*-- Author: Yves Schutz (SUBATECH) 
22 //
23 //*-- Additional Contributions: Sahal Yacoob (LBNL/UCT)
24 //                            : Alexei Pavlinov (WSU) 
25 //
26 //////////////////////////////////////////////////////////////////////////////
27
28 // --- ROOT system ---
29 class TFile;
30 #include <TFolder.h> 
31 #include <TGeoGlobalMagField.h>
32 #include <TGraph.h> 
33 #include <TH1F.h> 
34 #include <TRandom.h> 
35 #include <TTree.h>
36 #include <TVirtualMC.h> 
37
38 // --- Standard library ---
39
40 // --- AliRoot header files ---
41 #include "AliMagF.h"
42 #include "AliLog.h"
43 #include "AliEMCAL.h"
44 #include "AliRun.h"
45 #include "AliRunLoader.h"
46 #include "AliCDBManager.h"
47 #include "AliEMCALLoader.h"
48 #include "AliEMCALSDigitizer.h"
49 #include "AliEMCALDigitizer.h"
50 #include "AliEMCALDigit.h"
51 #include "AliEMCALRawUtils.h"
52 #include "AliCDBManager.h"
53 #include "AliCDBEntry.h"
54 #include "AliEMCALRawUtils.h"
55 #include "AliRawReader.h"
56 #include "AliEMCALTriggerData.h"
57 #include "AliEMCALRecParam.h"
58 #include "AliRawEventHeaderBase.h"
59
60 ClassImp(AliEMCAL)
61
62 //for embedding
63 AliEMCALRawUtils*        AliEMCAL::fgRawUtils   = 0;   // EMCAL raw utilities class
64
65 //____________________________________________________________________________
66 AliEMCAL::AliEMCAL()
67   : AliDetector(),
68     fBirkC0(0),
69     fBirkC1(0.),
70     fBirkC2(0.),
71     fGeometry(0), 
72     fCheckRunNumberAndGeoVersion(kTRUE),
73     fTriggerData(0x0)
74 {
75   // Default ctor 
76   fName = "EMCAL" ;
77   InitConstants();
78   
79   // Should call  AliEMCALGeometry::GetInstance(EMCAL->GetTitle(),"") for getting EMCAL geometry
80 }
81
82 //____________________________________________________________________________
83 AliEMCAL::AliEMCAL(const char* name, const char* title, 
84                    const Bool_t checkGeoAndRun)
85   : AliDetector(name,title),
86     fBirkC0(0),
87     fBirkC1(0.),
88     fBirkC2(0.),
89     fGeometry(0), 
90     fCheckRunNumberAndGeoVersion(checkGeoAndRun),
91     fTriggerData(0x0)
92 {
93   //   ctor : title is used to identify the layout
94   InitConstants();
95   
96 }
97
98 //____________________________________________________________________________
99 AliEMCAL::~AliEMCAL()
100 {
101   //dtor
102   delete fgRawUtils;
103   delete fTriggerData;
104 }
105
106 //____________________________________________________________________________
107 void AliEMCAL::InitConstants()
108 {
109   //initialize EMCAL values
110   fBirkC0 = 1;
111   fBirkC1 = 0.013/1.032;
112   fBirkC2 = 9.6e-6/(1.032 * 1.032);
113 }
114
115 //Not needed, modify $ALICE_ROOT/data/galice.cuts instead.
116 //Load the modified one in the configuration file with SetTransPar
117 // //____________________________________________________________________________
118 // void AliEMCAL::DefineMediumParameters()
119 // {
120 //   //
121 //   // EMCAL cuts (Geant3) 
122 //   // 
123 //   Int_t * idtmed = fIdtmed->GetArray() - 1599 ; 
124 // // --- Set decent energy thresholds for gamma and electron tracking
125
126 //   // Tracking threshold for photons and electrons in Lead 
127 //   Float_t cutgam=10.e-5; // 100 kev;
128 //   Float_t cutele=10.e-5; // 100 kev;
129 //   TString ntmp(GetTitle()); 
130 //   ntmp.ToUpper();
131 //   if(ntmp.Contains("10KEV")) {
132 //     cutele = cutgam = 1.e-5;
133 //   } else if(ntmp.Contains("50KEV")) {
134 //     cutele = cutgam = 5.e-5;
135 //   } else if(ntmp.Contains("100KEV")) {
136 //     cutele = cutgam = 1.e-4;
137 //   } else if(ntmp.Contains("200KEV")) {
138 //     cutele = cutgam = 2.e-4;
139 //   } else if(ntmp.Contains("500KEV")) {
140 //     cutele = cutgam = 5.e-4;
141 //   }
142
143 //   gMC->Gstpar(idtmed[1600],"CUTGAM", cutgam);
144 //   gMC->Gstpar(idtmed[1600],"CUTELE", cutele); // 1MEV -> 0.1MEV; 15-aug-05
145 //   gMC->Gstpar(idtmed[1600],"BCUTE",  cutgam);  // BCUTE and BCUTM start from GUTGUM
146 //   gMC->Gstpar(idtmed[1600],"BCUTM",  cutgam);  // BCUTE and BCUTM start from GUTGUM
147 //   // --- Generate explicitly delta rays in Lead ---
148 //   gMC->Gstpar(idtmed[1600], "LOSS", 3) ;
149 //   gMC->Gstpar(idtmed[1600], "DRAY", 1) ;
150 //   gMC->Gstpar(idtmed[1600], "DCUTE", cutele) ;
151 //   gMC->Gstpar(idtmed[1600], "DCUTM", cutele) ;
152
153 // // --- in aluminium parts ---
154 //   gMC->Gstpar(idtmed[1602],"CUTGAM", cutgam) ;
155 //   gMC->Gstpar(idtmed[1602],"CUTELE", cutele) ;
156 //   gMC->Gstpar(idtmed[1602],"BCUTE",  cutgam);  // BCUTE and BCUTM start from GUTGUM
157 //   gMC->Gstpar(idtmed[1602],"BCUTM",  cutgam);  // BCUTE and BCUTM start from GUTGUM
158 //   gMC->Gstpar(idtmed[1602], "LOSS",3.) ;
159 //   gMC->Gstpar(idtmed[1602], "DRAY",1.) ;
160 //   gMC->Gstpar(idtmed[1602], "DCUTE", cutele) ;
161 //   gMC->Gstpar(idtmed[1602], "DCUTM", cutele) ;
162
163 // // --- and finally thresholds for photons and electrons in the scintillator ---
164 //   gMC->Gstpar(idtmed[1601],"CUTGAM", cutgam) ;
165 //   gMC->Gstpar(idtmed[1601],"CUTELE", cutele) ;// 1MEV -> 0.1MEV; 15-aug-05
166 //   gMC->Gstpar(idtmed[1601],"BCUTE",  cutgam);  // BCUTE and BCUTM start from GUTGUM
167 //   gMC->Gstpar(idtmed[1601],"BCUTM",  cutgam);  // BCUTE and BCUTM start from GUTGUM
168 //   gMC->Gstpar(idtmed[1601], "LOSS",3) ; // generate delta rays 
169 //   gMC->Gstpar(idtmed[1601], "DRAY",1) ;
170 //   gMC->Gstpar(idtmed[1601], "DCUTE", cutele) ;
171 //   gMC->Gstpar(idtmed[1601], "DCUTM", cutele) ;
172
173 //   // S steel - 
174 //   gMC->Gstpar(idtmed[1603],"CUTGAM", cutgam);
175 //   gMC->Gstpar(idtmed[1603],"CUTELE", cutele);
176 //   gMC->Gstpar(idtmed[1603],"BCUTE",  cutgam);  // BCUTE and BCUTM start from GUTGUM
177 //   gMC->Gstpar(idtmed[1603],"BCUTM",  cutgam);  // BCUTE and BCUTM start from GUTGUM
178 //   // --- Generate explicitly delta rays 
179 //   gMC->Gstpar(idtmed[1603], "LOSS",3);
180 //   gMC->Gstpar(idtmed[1603], "DRAY",1);
181 //   gMC->Gstpar(idtmed[1603], "DCUTE", cutele) ;
182 //   gMC->Gstpar(idtmed[1603], "DCUTM", cutele) ;
183
184 //   AliEMCALGeometry* geom = GetGeometry();
185 //   if(geom->GetILOSS()>=0) {
186 //     for(int i=1600; i<=1603; i++) gMC->Gstpar(idtmed[i], "LOSS", geom->GetILOSS()) ; 
187 //   } 
188 //   if(geom->GetIHADR()>=0) {
189 //     for(int i=1600; i<=1603; i++) gMC->Gstpar(idtmed[i], "HADR", geom->GetIHADR()) ; 
190 //   }
191 // }
192
193 //____________________________________________________________________________
194 AliDigitizer* AliEMCAL::CreateDigitizer(AliDigitizationInput* digInput) const
195 {
196   //create and return the digitizer
197   return new AliEMCALDigitizer(digInput);
198 }
199
200 //____________________________________________________________________________
201 void AliEMCAL::CreateMaterials()
202 {
203   // Definitions of materials to build EMCAL and associated tracking media.
204   // media number in idtmed are 1599 to 1698.
205   // --- Air ---               
206   Float_t aAir[4]={12.0107,14.0067,15.9994,39.948};
207   Float_t zAir[4]={6.,7.,8.,18.};
208   Float_t wAir[4]={0.000124,0.755267,0.231781,0.012827};
209   Float_t dAir = 1.20479E-3;
210   AliMixture(0, "Air$", aAir, zAir, dAir, 4, wAir) ;
211
212   // --- Lead ---                                                                     
213   AliMaterial(1, "Pb$", 207.2, 82, 11.35, 0.56, 0., 0, 0) ;
214
215
216   // --- The polysterene scintillator (CH) ---
217   Float_t aP[2] = {12.011, 1.00794} ;
218   Float_t zP[2] = {6.0, 1.0} ;
219   Float_t wP[2] = {1.0, 1.0} ;
220   Float_t dP = 1.032 ;
221
222   AliMixture(2, "Polystyrene$", aP, zP, dP, -2, wP) ;
223
224   // --- Aluminium ---
225   AliMaterial(3, "Al$", 26.98, 13., 2.7, 8.9, 999., 0, 0) ;
226   // ---         Absorption length is ignored ^
227
228   // 25-aug-04 by PAI - see  PMD/AliPMDv0.cxx for STEEL definition
229   Float_t asteel[4] = { 55.847,51.9961,58.6934,28.0855 };
230   Float_t zsteel[4] = { 26.,24.,28.,14. };
231   Float_t wsteel[4] = { .715,.18,.1,.005 };
232   AliMixture(4, "STAINLESS STEEL$", asteel, zsteel, 7.88, 4, wsteel);
233
234   // Oct 26,2010 : Multipurpose Copy Paper UNV-21200), weiht 75 g/m**2. 
235   // *Cellulose C6H10O5
236   //    Component C  A=12.01   Z=6.    W=6./21.
237   //    Component H  A=1.      Z=1.    W=10./21.
238   //    Component O  A=16.     Z=8.    W=5./21.
239   Float_t apaper[3] = { 12.01, 1.0, 16.0};
240   Float_t zpaper[3] = {  6.0,  1.0,  8.0};
241   Float_t wpaper[3] = {6./21., 10./21., 5./21.};
242   AliMixture(5, "BondPaper$", apaper, zpaper, 0.75, 3, wpaper);
243  
244   // DEFINITION OF THE TRACKING MEDIA
245   // Look to the $ALICE_ROOT/data/galice.cuts for particular values
246   // of cuts.
247   // Don't forget to add a new tracking medium with non-default cuts
248
249   // for EMCAL: idtmed[1599->1698] equivalent to fIdtmed[0->100]
250   Int_t   isxfld = ((AliMagF*)TGeoGlobalMagField::Instance()->GetField())->Integ() ;
251   Float_t sxmgmx = ((AliMagF*)TGeoGlobalMagField::Instance()->GetField())->Max() ;
252
253   // Air                                                                         -> idtmed[1599]
254  AliMedium(0, "Air$", 0, 0,
255              isxfld, sxmgmx, 10.0, 1.0, 0.1, 0.1, 10.0, 0, 0) ;
256
257   // The Lead                                                                      -> idtmed[1600]
258  
259   AliMedium(1, "Lead$", 1, 0,
260              isxfld, sxmgmx, 10.0, 0.1, 0.1, 0.1, 0.1, 0, 0) ;
261
262  // The scintillator of the CPV made of Polystyrene scintillator                   -> idtmed[1601]
263   float deemax = 0.1; // maximum fractional energy loss in one step (0 < DEEMAX < deemax )
264   AliMedium(2, "Scintillator$", 2, 1,
265             isxfld, sxmgmx, 10.0, 0.001, deemax, 0.001, 0.001, 0, 0) ;
266
267   // Various Aluminium parts made of Al                                            -> idtmed[1602]
268   AliMedium(3, "Al$", 3, 0,
269              isxfld, sxmgmx, 10.0, 0.1, 0.1, 0.001, 0.001, 0, 0) ;
270
271   // 25-aug-04 by PAI : see  PMD/AliPMDv0.cxx for STEEL definition                 -> idtmed[1603]
272   AliMedium(4, "S steel$", 4, 0, 
273              isxfld, sxmgmx, 10.0, 0.01, 0.1, 0.001, 0.001, 0, 0) ;
274
275   // Oct 26,2010; Nov 24,2010                                                      -> idtmed[1604]
276   deemax = 0.01;
277   AliMedium(5, "Paper$", 5, 0, 
278              isxfld, sxmgmx, 10.0, deemax, 0.1, 0.001, 0.001, 0, 0) ;
279
280
281   //set constants for Birk's Law implentation
282   fBirkC0 =  1;
283   fBirkC1 =  0.013/dP;
284   fBirkC2 =  9.6e-6/(dP * dP);
285
286 }
287
288 //____________________________________________________________________________
289 void  AliEMCAL::Init()
290
291   // Init
292   //Not needed, modify $ALICE_ROOT/data/galice.cuts instead.
293   //Load the modified one in the configuration file with SetTransPar
294   //DefineMediumParameters(); 
295 }     
296
297 //____________________________________________________________________________
298 void AliEMCAL::Digits2Raw() {
299
300   static AliEMCALRawUtils rawUtils;
301   rawUtils.Digits2Raw();
302
303 }
304 //____________________________________________________________________________
305 void AliEMCAL::Hits2SDigits()  
306
307 // create summable digits
308
309   GetGeometry();
310   AliEMCALSDigitizer emcalDigitizer(fLoader->GetRunLoader()->GetFileName().Data()) ;
311   emcalDigitizer.SetEventRange(0, -1) ; // do all the events
312   emcalDigitizer.Digitize() ;
313 }
314
315 //______________________________________________________________________
316 Bool_t AliEMCAL::Raw2SDigits(AliRawReader* rawReader){
317   
318   // Conversion from raw data to EMCAL sdigits. 
319   // Does the same as AliEMCALReconstructor::ConvertDigits()
320   // Needed to embed real data and simulation
321   // Works on a single-event basis
322   
323   rawReader->Reset() ; 
324   
325   //Get/create the sdigits tree and array
326         AliRunLoader *rl = AliRunLoader::Instance();
327         AliEMCALLoader *emcalLoader = dynamic_cast<AliEMCALLoader*>(rl->GetDetectorLoader("EMCAL")); 
328   
329   if(!emcalLoader){
330     AliFatal("NULL loader");
331     return kFALSE;
332   }
333   
334   emcalLoader->GetEvent();
335   emcalLoader->LoadSDigits("UPDATE");
336
337   TTree * treeS = emcalLoader->TreeS();
338   if ( !treeS ) { 
339     emcalLoader->MakeSDigitsContainer();
340     treeS = emcalLoader->TreeS();
341   }
342   
343   if(!emcalLoader->SDigits()) {
344     AliFatal("No sdigits array available\n");
345     return kFALSE;
346   }
347   
348   TClonesArray * sdigits = emcalLoader->SDigits();
349   sdigits->Clear("C");  
350   
351   //Trigger sdigits
352   if(!fTriggerData)fTriggerData = new AliEMCALTriggerData();
353   fTriggerData->SetMode(1);     
354   TClonesArray *digitsTrg = new TClonesArray("AliEMCALTriggerRawDigit", 32 * 96);    
355   Int_t bufsize = 32000;
356   treeS->Branch("EMTRG", &digitsTrg, bufsize);
357   
358   
359   //Only physics events
360   if (rawReader->GetType()== AliRawEventHeaderBase::kPhysicsEvent) {
361
362     if(!fgRawUtils)  fgRawUtils   = new AliEMCALRawUtils;
363     //must be done here because, in constructor, option is not yet known
364     fgRawUtils->SetOption(GetOption());
365     
366     // Set parameters from OCDB to raw utils
367     AliEMCALRecParam* recpar = emcalLoader->ReconstructionParameters(0);
368     // fgRawUtils->SetRawFormatHighLowGainFactor(recpar->GetHighLowGainFactor());
369     // fgRawUtils->SetRawFormatOrder(recpar->GetOrderParameter());
370     // fgRawUtils->SetRawFormatTau(recpar->GetTau());
371     fgRawUtils->SetNoiseThreshold(recpar->GetNoiseThreshold());
372     fgRawUtils->SetNPedSamples(recpar->GetNPedSamples());
373     fgRawUtils->SetRemoveBadChannels(recpar->GetRemoveBadChannels());
374     fgRawUtils->SetFittingAlgorithm(recpar->GetFittingAlgorithm());
375     fgRawUtils->SetFALTROUsage(recpar->UseFALTRO());
376     // fgRawUtils->SetTimeMin(recpar->GetTimeMin());
377     // fgRawUtils->SetTimeMax(recpar->GetTimeMax());
378
379     //Fit
380     fgRawUtils->Raw2Digits(rawReader,sdigits,emcalLoader->PedestalData(),digitsTrg,fTriggerData);
381     
382   }//skip calibration event
383   else{
384     AliDebug(1," Calibration Event, skip!");
385   }
386   
387   //Final arrangements of the array, set all sdigits as embedded
388   sdigits->Sort() ;
389   for (Int_t iSDigit = 0 ; iSDigit < sdigits->GetEntriesFast() ; iSDigit++) { 
390     AliEMCALDigit * sdigit = dynamic_cast<AliEMCALDigit *>(sdigits->At(iSDigit)) ;
391     if(sdigit){
392       sdigit->SetIndexInList(iSDigit) ;
393       sdigit->SetType(AliEMCALDigit::kEmbedded);
394     }
395     else {
396       AliFatal("sdigit is NULL!");
397     }
398   }     
399   
400   AliDebug(1,Form("Embedded sdigits entries %d \n",sdigits->GetEntriesFast()));
401   
402   //Write array, clean arrays, unload ..
403   
404   Int_t bufferSize = 32000 ;    
405   TBranch * sdigitsBranch = treeS->GetBranch("EMCAL");
406   if (sdigitsBranch)
407     sdigitsBranch->SetAddress(&sdigits);
408   else
409     treeS->Branch("EMCAL",&sdigits,bufferSize);
410   
411   treeS->Fill();
412   emcalLoader->WriteSDigits("OVERWRITE");
413   emcalLoader->UnloadSDigits();
414
415   digitsTrg->Delete();
416   delete digitsTrg;
417     
418   return kTRUE;
419   
420 }
421
422 //____________________________________________________________________________
423
424 AliLoader* AliEMCAL::MakeLoader(const char* topfoldername)
425 {
426 //different behaviour than standard (singleton getter)
427 // --> to be discussed and made eventually coherent
428  fLoader = new AliEMCALLoader(GetName(),topfoldername);
429  return fLoader;
430 }
431
432 //____________________________________________________________________________
433
434 AliEMCALGeometry* AliEMCAL::GetGeometry() const
435 {
436   //Initializes and returns geometry
437   
438   // Pass the transpor model name (Geant3, Geant4, Fluka) and title to the geometry
439   TString mcname   = "";
440   TString mctitle  = "";
441   if(gMC){
442     mcname  = gMC->GetName()  ;
443     mctitle = gMC->GetTitle() ;
444   }
445  
446   TString geoName(GetTitle());
447   
448   //Check if run number and requested geometry correspond to the same geometry as
449   //in real data taking. To prevent errors in official simulation productions
450   if(!(AliEMCALGeometry::GetInstance()))
451   {
452     // Check the transport model name and option, set sampling fraction depending on it
453     if(!fCheckRunNumberAndGeoVersion){// Set geometry with the name used in the configuration file
454       AliInfo(Form("Geometry name in use <<%s>>, requested via Config file", geoName.Data()));
455       return AliEMCALGeometry::GetInstance(GetTitle(),"EMCAL",mcname,mctitle) ;
456     }
457     else
458     {//Check run number and version and set the corresponding one.
459       //Get run number
460       //AliRunLoader *rl = AliRunLoader::Instance();
461       //Int_t runNumber = rl->GetRunNumber();
462       
463       AliCDBManager* man = AliCDBManager::Instance();
464       Int_t runNumber = man->GetRun();
465       
466       //Instanciate geometry depending on the run number
467       if(runNumber >= 104064 && runNumber < 140000 ){//2009-2010 runs
468         //First year geometry, 4 SM.
469         
470         if(!geoName.Contains("FIRSTYEARV1"))
471         { 
472           AliInfo(Form("*** ATTENTION *** \n \t Specified geometry name <<%s>> for run %d is not considered! \n \t In use <<EMCAL_FIRSTYEARV1>>, check run number and year \n ",
473                        geoName.Data(),runNumber)); 
474         }
475         else 
476         {
477           AliDebug(1,"Initialized geometry with name <<EMCAL_FIRSTYEARV1>>");
478         }
479
480         return AliEMCALGeometry::GetInstance("EMCAL_FIRSTYEARV1","EMCAL",mcname,mctitle) ;// Set geometry with the name used in the configuration file
481       }
482       else if(runNumber >= 140000 && runNumber <= 170593)
483       {
484         //Almost complete EMCAL geometry, 10 SM. Year 2011 configuration
485         
486         if(!geoName.Contains("COMPLETEV1"))
487         {
488           AliInfo(Form("*** ATTENTION *** \n \t Specified geometry name <<%s>>  for run %d is  not considered! \n \t In use <<EMCAL_COMPLETEV1>>, check run number and year \n ",
489                        geoName.Data(),runNumber));
490         }
491         else 
492         {
493           AliDebug(1,"Initialized geometry with name <<EMCAL_COMPLETEV1>>");
494         }
495         
496         return AliEMCALGeometry::GetInstance("EMCAL_COMPLETEV1","EMCAL",mcname,mctitle) ;// Set geometry with the name used in the configuration file
497       }
498       else{ 
499         //Default geometry
500         //Complete EMCAL geometry, 12 SM. Year 2012 and on
501         
502         if(!geoName.Contains("COMPLETE12SMV1"))
503         {
504           AliInfo(Form("*** ATTENTION *** \n \t Specified geometry name <<%s>>  for run %d is  not considered! \n \t In use <<EMCAL_COMPLETE12SMV1>>, check run number and year \n ",
505                        geoName.Data(),runNumber));
506         }
507         else 
508         {
509           AliDebug(1,"Initialized geometry with name <<EMCAL_COMPLETE12SMV1>>");
510         }
511                 
512         return AliEMCALGeometry::GetInstance("EMCAL_COMPLETE12SMV1","EMCAL",mcname,mctitle) ;// Set geometry with the name used in the configuration file
513       }
514     }
515   }// Init geometry for the first time
516   
517   
518   return AliEMCALGeometry::GetInstance();
519     
520 }