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 //////////////////////////////////////////////////////////////////////////////
21 // Class performs digitization of Summable digits
23 // In addition it performs mixing of summable digits from different events.
25 // For each event two branches are created in TreeD:
26 // "EMCAL" - list of digits
27 // "AliEMCALDigitizer" - AliEMCALDigitizer with all parameters used in digitization
29 // Note, that one cset title for new digits branch, and repeat digitization with
30 // another set of parameters.
33 // root[0] AliEMCALDigitizer * d = new AliEMCALDigitizer() ;
34 // root[1] d->ExecuteTask()
35 // Warning in <TDatabasePDG::TDatabasePDG>: object already instantiated
36 // //Digitizes SDigitis in all events found in file galice.root
38 // root[2] AliEMCALDigitizer * d1 = new AliEMCALDigitizer("galice1.root") ;
39 // // Will read sdigits from galice1.root
40 // root[3] d1->MixWith("galice2.root")
41 // Warning in <TDatabasePDG::TDatabasePDG>: object already instantiated
42 // // Reads another portion of sdigits from galice2.root
43 // root[3] d1->MixWith("galice3.root")
44 // // Reads another portion of sdigits from galice3.root
45 // root[4] d->ExecuteTask("deb timing")
46 // // Reads SDigits from files galice1.root, galice2.root ....
47 // // mixes them and stores produced Digits in file galice1.root
48 // // deb - prints number of produced digits
49 // // deb all - prints list of produced digits
50 // // timing - prints time used for digitization
51 ////////////////////////////////////////////////////////////////////////////////////
53 //*-- Author: Sahal Yacoob (LBL)
54 // based on : AliEMCALDigitizer
56 // August 2002 Yves Schutz: clone PHOS as closely as possible and intoduction
57 // of new IO (à la PHOS)
58 ///_________________________________________________________________________________
60 // --- ROOT system ---
63 #include "TBenchmark.h"
65 // --- Standard library ---
67 // --- AliRoot header files ---
68 #include "AliRunDigitizer.h"
69 #include "AliEMCALDigit.h"
71 #include "AliEMCALGetter.h"
72 #include "AliEMCALDigitizer.h"
73 #include "AliEMCALSDigitizer.h"
74 #include "AliEMCALGeometry.h"
75 #include "AliEMCALTick.h"
77 ClassImp(AliEMCALDigitizer)
80 //____________________________________________________________________________
81 AliEMCALDigitizer::AliEMCALDigitizer():AliDigitizer("",""),
88 fDefaultInit = kTRUE ;
89 fManager = 0 ; // We work in the standalong mode
90 fEventFolderName = "" ;
93 //____________________________________________________________________________
94 AliEMCALDigitizer::AliEMCALDigitizer(TString alirunFileName, TString eventFolderName):
95 AliDigitizer("EMCAL"+AliConfig::fgkDigitizerTaskName, alirunFileName),
96 fInputFileNames(0), fEventNames(0), fEventFolderName(eventFolderName)
102 fDefaultInit = kFALSE ;
103 fManager = 0 ; // We work in the standalong mode
106 //____________________________________________________________________________
107 AliEMCALDigitizer::AliEMCALDigitizer(const AliEMCALDigitizer & d) : AliDigitizer(d)
111 SetName(d.GetName()) ;
112 SetTitle(d.GetTitle()) ;
113 fDigitThreshold = d.fDigitThreshold ;
114 fMeanPhotonElectron = d.fMeanPhotonElectron ;
115 fPedestal = d.fPedestal ;
117 fPinNoise = d.fPinNoise ;
118 fTimeResolution = d.fTimeResolution ;
119 fTimeThreshold = d.fTimeThreshold ;
120 fTimeSignalLength = d.fTimeSignalLength ;
121 fADCchannelEC = d.fADCchannelEC ;
122 fADCpedestalEC = d.fADCpedestalEC ;
123 fNADCEC = d.fNADCEC ;
124 fEventFolderName = d.fEventFolderName;
127 //____________________________________________________________________________
128 AliEMCALDigitizer::AliEMCALDigitizer(AliRunDigitizer * rd):
129 AliDigitizer(rd,"EMCAL"+AliConfig::fgkDigitizerTaskName),
132 // ctor Init() is called by RunDigitizer
134 fEventFolderName = fManager->GetInputFolderName(0) ;
135 SetTitle(dynamic_cast<AliStream*>(fManager->GetInputStream(0))->GetFileName(0));
137 fDefaultInit = kFALSE ;
140 //____________________________________________________________________________
141 AliEMCALDigitizer::~AliEMCALDigitizer()
144 AliEMCALGetter * gime =AliEMCALGetter::Instance(GetTitle(),fEventFolderName);
145 gime->EmcalLoader()->CleanDigitizer();
146 delete [] fInputFileNames ;
147 delete [] fEventNames ;
151 //____________________________________________________________________________
152 void AliEMCALDigitizer::Digitize(Int_t event)
155 // Makes the digitization of the collected summable digits
156 // for this it first creates the array of all EMCAL modules
157 // filled with noise (different for EMC, CPV and PPSD) and
158 // after that adds contributions from SDigits. This design
159 // helps to avoid scanning over the list of digits to add
160 // contribution of any new SDigit.
162 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
163 Int_t ReadEvent = event ;
165 ReadEvent = dynamic_cast<AliStream*>(fManager->GetInputStream(0))->GetCurrentEventNumber() ;
166 Info("Digitize", "Adding event %d from input stream 0", ReadEvent) ;
167 gime->Event(ReadEvent, "S") ;
168 TClonesArray * digits = gime->Digits() ;
171 const AliEMCALGeometry *geom = gime->EMCALGeometry() ;
173 Int_t nEMC = geom->GetNPhi()*geom->GetNZ(); //max number of digits possible
177 digits->Expand(nEMC) ;
179 // get first the sdigitizer from the tasks list (must have same name as the digitizer)
180 if ( !gime->SDigitizer() )
181 gime->LoadSDigitizer();
182 AliEMCALSDigitizer * sDigitizer = gime->SDigitizer();
185 Fatal("Digitize", "SDigitizer with name %s %s not found", fEventFolderName.Data(), GetTitle() ) ;
187 //take all the inputs to add together and load the SDigits
188 TObjArray * sdigArray = new TObjArray(fInput) ;
189 sdigArray->AddAt(gime->SDigits(), 0) ;
191 for(i = 1 ; i < fInput ; i++){
192 TString tempo(fEventNames[i]) ;
194 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
196 ReadEvent = dynamic_cast<AliStream*>(fManager->GetInputStream(i))->GetCurrentEventNumber() ;
197 Info("Digitize", "Adding event %d from input stream %d", ReadEvent, i) ;
198 gime->Event(ReadEvent,"S");
199 sdigArray->AddAt(gime->SDigits(), i) ;
202 //Find the first tower with signal
203 Int_t nextSig = nEMC + 1 ;
204 TClonesArray * sdigits ;
205 for(i = 0 ; i < fInput ; i++){
206 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
207 if ( !sdigits->GetEntriesFast() )
209 Int_t curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(0))->GetId() ;
210 if(curNext < nextSig)
214 TArrayI index(fInput) ;
215 index.Reset() ; //Set all indexes to zero
217 AliEMCALDigit * digit ;
218 AliEMCALDigit * curSDigit ;
220 TClonesArray * ticks = new TClonesArray("AliEMCALTick",1000) ;
222 //Put Noise contribution
223 for(absID = 1; absID <= nEMC; absID++){
225 // amplitude set to zero, noise will be added later
226 new((*digits)[absID-1]) AliEMCALDigit( -1, -1, absID, 0, TimeOfNoise() ) ;
227 //look if we have to add signal?
228 digit = dynamic_cast<AliEMCALDigit *>(digits->At(absID-1)) ;
231 //Add SDigits from all inputs
234 Float_t a = digit->GetAmp() ;
235 Float_t b = TMath::Abs( a /fTimeSignalLength) ;
236 //Mark the beginning of the signal
237 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime(),0, b);
238 //Mark the end of the signal
239 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime()+fTimeSignalLength, -a, -b);
242 for(i = 0; i< fInput ; i++){ //loop over (possible) merge sources
243 if(dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
244 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
247 //May be several digits will contribute from the same input
248 while(curSDigit && (curSDigit->GetId() == absID)){
249 //Shift primary to separate primaries belonging different inputs
250 Int_t primaryoffset ;
252 primaryoffset = fManager->GetMask(i) ;
255 curSDigit->ShiftPrimary(primaryoffset) ;
257 a = curSDigit->GetAmp() ;
258 b = a /fTimeSignalLength ;
259 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime(),0, b);
260 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime()+fTimeSignalLength, -a, -b);
262 *digit = *digit + *curSDigit ; //add energies
265 if( dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
266 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
271 // add fluctuations for photo-electron creation
272 amp = sDigitizer->Calibrate(digit->GetAmp()) ; // GeV
273 amp *= static_cast<Float_t>(gRandom->Poisson(fMeanPhotonElectron)) / static_cast<Float_t>(fMeanPhotonElectron) ;
275 //calculate and set time
276 Float_t time = FrontEdgeTime(ticks) ;
277 digit->SetTime(time) ;
279 //Find next signal module
281 for(i = 0 ; i < fInput ; i++){
282 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
283 Int_t curNext = nextSig ;
284 if(sdigits->GetEntriesFast() > index[i] ){
285 curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(index[i]))->GetId() ;
287 if(curNext < nextSig) nextSig = curNext ;
291 amp += TMath::Abs(gRandom->Gaus(0., fPinNoise)) ;
292 digit->SetAmp(sDigitizer->Digitize(amp)) ;
298 delete sdigArray ; //We should not delete its contents
300 //remove digits below thresholds
301 for(i = 0 ; i < nEMC ; i++){
302 digit = dynamic_cast<AliEMCALDigit*>( digits->At(i) ) ;
303 Float_t threshold = fDigitThreshold ;
304 if(sDigitizer->Calibrate( digit->GetAmp() ) < threshold)
305 digits->RemoveAt(i) ;
307 digit->SetTime(gRandom->Gaus(digit->GetTime(),fTimeResolution) ) ;
312 Int_t ndigits = digits->GetEntriesFast() ;
313 digits->Expand(ndigits) ;
315 //Set indexes in list of digits
316 for (i = 0 ; i < ndigits ; i++) {
317 digit = dynamic_cast<AliEMCALDigit *>( digits->At(i) ) ;
318 digit->SetIndexInList(i) ;
319 Float_t energy = sDigitizer->Calibrate(digit->GetAmp()) ;
320 digit->SetAmp(DigitizeEnergy(energy) ) ;
324 //____________________________________________________________________________
326 Int_t AliEMCALDigitizer::DigitizeEnergy(Float_t energy)
328 Int_t channel = -999;
329 channel = static_cast<Int_t> (TMath::Ceil( (energy + fADCpedestalEC)/fADCchannelEC )) ;
330 if(channel > fNADCEC )
335 //____________________________________________________________________________
336 void AliEMCALDigitizer::Exec(Option_t *option)
338 // Steering method to process digitization for events
339 // in the range from fFirstEvent to fLastEvent.
340 // This range is optionally set by SetEventRange().
341 // if fLastEvent=-1, then process events until the end.
342 // by default fLastEvent = fFirstEvent (process only one event)
344 if (!fInit) { // to prevent overwrite existing file
345 Error( "Exec", "Give a version name different from %s", fEventFolderName.Data() ) ;
349 if (strstr(option,"print")) {
354 if(strstr(option,"tim"))
355 gBenchmark->Start("EMCALDigitizer");
357 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
359 if (fLastEvent == -1)
360 fLastEvent = gime->MaxEvent() - 1 ;
362 fLastEvent = fFirstEvent ;
364 Int_t nEvents = fLastEvent - fFirstEvent + 1;
368 for (ievent = fFirstEvent; ievent <= fLastEvent; ievent++) {
370 gime->Event(ievent,"S") ;
372 Digitize(ievent) ; //Add prepared SDigits to digits and add the noise
376 if(strstr(option,"deb"))
379 //increment the total number of Digits per run
380 fDigitsInRun += gime->Digits()->GetEntriesFast() ;
383 if(strstr(option,"tim")){
384 gBenchmark->Stop("EMCALDigitizer");
385 printf("Exec: took %f seconds for Digitizing %f seconds per event",
386 gBenchmark->GetCpuTime("EMCALDigitizer"), gBenchmark->GetCpuTime("EMCALDigitizer")/nEvents ) ;
390 //____________________________________________________________________________
391 Float_t AliEMCALDigitizer::FrontEdgeTime(TClonesArray * ticks)
393 // Returns the shortest time among all time ticks
395 ticks->Sort() ; //Sort in accordance with times of ticks
397 AliEMCALTick * ctick = (AliEMCALTick *) it.Next() ;
398 Float_t time = ctick->CrossingTime(fTimeThreshold) ;
401 while((t=(AliEMCALTick*) it.Next())){
402 if(t->GetTime() < time) //This tick starts before crossing
407 time = ctick->CrossingTime(fTimeThreshold) ;
412 //____________________________________________________________________________
413 Bool_t AliEMCALDigitizer::Init()
415 // Makes all memory allocations
417 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
419 Error("Init", "Could not obtain the Getter object for file %s and event %s !", GetTitle(), fEventFolderName.Data()) ;
423 TString opt("Digits") ;
424 if(gime->VersionExists(opt) ) {
425 Error( "Init", "Give a version name different from %s", fEventFolderName.Data() ) ;
429 // Post Digitizer to the white board
430 gime->PostDigitizer(this) ;
433 fLastEvent = fFirstEvent ;
436 fInput = fManager->GetNinputs() ;
440 fInputFileNames = new TString[fInput] ;
441 fEventNames = new TString[fInput] ;
442 fInputFileNames[0] = GetTitle() ;
443 fEventNames[0] = fEventFolderName.Data() ;
445 for (index = 1 ; index < fInput ; index++) {
446 fInputFileNames[index] = dynamic_cast<AliStream*>(fManager->GetInputStream(index))->GetFileName(0);
447 TString tempo = fManager->GetInputFolderName(index) ;
448 fEventNames[index] = tempo.Remove(tempo.Length()-1) ; // strip of the stream number added bt fManager
451 //to prevent cleaning of this object while GetEvent is called
452 gime->EmcalLoader()->GetDigitsDataLoader()->GetBaseTaskLoader()->SetDoNotReload(kTRUE);
457 //____________________________________________________________________________
458 void AliEMCALDigitizer::InitParameters()
460 fMeanPhotonElectron = 18200 ; // electrons per GeV
461 fPinNoise = 0.1 ; // noise equivalent GeV (random choice)
462 if (fPinNoise == 0. )
463 Warning("InitParameters", "No noise added\n") ;
464 fDigitThreshold = fPinNoise * 3; //2 sigma
465 fTimeResolution = 1.0e-9 ;
466 fTimeSignalLength = 1.0e-9 ;
468 fADCchannelEC = 0.00305; // width of one ADC channel in GeV - HG fix so that we see 200 GeV gammas
469 fADCpedestalEC = 0.005 ; // GeV
470 fNADCEC = (Int_t) TMath::Power(2,16) ; // number of channels in Tower ADC
472 fTimeThreshold = 0.001*10000000 ; //Means 1 MeV in terms of SDigits amplitude
476 //__________________________________________________________________
477 void AliEMCALDigitizer::MixWith(TString alirunFileName, TString eventFolderName)
479 // Allows to produce digits by superimposing background and signal event.
480 // It is assumed, that headers file with SIGNAL events is opened in
482 // Sets the BACKGROUND event, with which the SIGNAL event is to be mixed
483 // Thus we avoid writing (changing) huge and expensive
484 // backgound files: all output will be writen into SIGNAL, i.e.
485 // opened in constructor file.
487 // One can open as many files to mix with as one needs.
488 // However only Sdigits with the same name (i.e. constructed with the same SDigitizer)
491 if( strcmp(GetName(), "") == 0 )
495 Error("MixWith", "Cannot use this method under AliRunDigitizer") ;
498 // looking for file which contains AliRun
499 if (gSystem->AccessPathName(alirunFileName)) {// file does not exist
500 Error("MixWith", "File %s does not exist!", alirunFileName.Data()) ;
503 // looking for the file which contains SDigits
504 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
505 TString fileName( gime->GetSDigitsFileName() ) ;
506 if ( eventFolderName != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
507 fileName = fileName.ReplaceAll(".root", "") + "_" + eventFolderName + ".root" ;
508 if ( (gSystem->AccessPathName(fileName)) ) {
509 Error("MixWith", "The file %s does not exist!", fileName.Data()) ;
512 // need to increase the arrays
513 TString tempo = fInputFileNames[fInput-1] ;
514 delete [] fInputFileNames ;
515 fInputFileNames = new TString[fInput+1] ;
516 fInputFileNames[fInput-1] = tempo ;
518 tempo = fEventNames[fInput-1] ;
519 delete [] fEventNames ;
520 fEventNames = new TString[fInput+1] ;
521 fEventNames[fInput-1] = tempo ;
523 fInputFileNames[fInput] = alirunFileName ;
524 fEventNames[fInput] = eventFolderName ;
528 //__________________________________________________________________
529 void AliEMCALDigitizer::Print()const
531 // Print Digitizer's parameters
532 printf("Print: \n------------------- %s -------------", GetName() ) ;
533 if( strcmp(fEventFolderName.Data(), "") != 0 ){
534 printf(" Writing Digits to branch with title %s\n", fEventFolderName.Data()) ;
538 nStreams = GetNInputStreams() ;
543 for (index = 0 ; index < nStreams ; index++) {
544 TString tempo(fEventNames[index]) ;
546 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[index], tempo) ;
547 TString fileName( gime->GetSDigitsFileName() ) ;
548 if ( fEventNames[index] != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
549 fileName = fileName.ReplaceAll(".root", "") + "_" + fEventNames[index] + ".root" ;
550 printf ("Adding SDigits from %s %s\n", fInputFileNames[index].Data(), fileName.Data()) ;
552 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
553 printf("\nWriting digits to %s", gime->GetDigitsFileName().Data()) ;
555 printf("\nWith following parameters:\n") ;
557 printf(" Electronics noise in EMC (fPinNoise) = %f\n", fPinNoise) ;
558 printf(" Threshold in EMC (fDigitThreshold) = %f\n", fDigitThreshold) ;
559 printf("---------------------------------------------------\n") ;
562 printf("Print: AliEMCALDigitizer not initialized") ;
565 //__________________________________________________________________
566 void AliEMCALDigitizer::PrintDigits(Option_t * option){
568 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
569 TClonesArray * digits = gime->Digits() ;
571 printf("PrintDigits: %d", digits->GetEntriesFast()) ;
572 printf("\nevent %d", gAlice->GetEvNumber()) ;
573 printf("\n Number of entries in Digits list %d", digits->GetEntriesFast() ) ;
575 if(strstr(option,"all")){
577 AliEMCALDigit * digit;
578 printf("\nEMC digits (with primaries):\n") ;
579 printf("\n Id Amplitude Time Index Nprim: Primaries list \n") ;
581 for (index = 0 ; index < digits->GetEntries() ; index++) {
582 digit = dynamic_cast<AliEMCALDigit *>(digits->At(index)) ;
583 printf("\n%6d %8d %6.5e %4d %2d : ",
584 digit->GetId(), digit->GetAmp(), digit->GetTime(), digit->GetIndexInList(), digit->GetNprimary()) ;
586 for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++) {
587 printf("%d ",digit->GetPrimary(iprimary+1) ) ;
593 //__________________________________________________________________
594 Float_t AliEMCALDigitizer::TimeOfNoise(void)
595 { // Calculates the time signal generated by noise
596 //to be rewritten, now returns just big number
601 //__________________________________________________________________
602 void AliEMCALDigitizer::Unload()
604 // Unloads the SDigits and Digits
606 for(i = 1 ; i < fInput ; i++){
607 TString tempo(fEventNames[i]) ;
609 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
610 gime->EmcalLoader()->UnloadSDigits() ;
613 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
614 gime->EmcalLoader()->UnloadDigits() ;
617 //_________________________________________________________________________________________
618 void AliEMCALDigitizer::WriteDigits()
621 // Makes TreeD in the output file.
622 // Check if branch already exists:
623 // if yes, exit without writing: ROOT TTree does not support overwriting/updating of
624 // already existing branches.
625 // else creates branch with Digits, named "EMCAL", title "...",
626 // and branch "AliEMCALDigitizer", with the same title to keep all the parameters
627 // and names of files, from which digits are made.
629 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
630 const TClonesArray * digits = gime->Digits() ;
631 TTree * treeD = gime->TreeD();
633 // -- create Digits branch
634 Int_t bufferSize = 32000 ;
635 TBranch * digitsBranch = treeD->Branch("EMCAL",&digits,bufferSize);
636 digitsBranch->SetTitle(fEventFolderName);
637 digitsBranch->Fill() ;
639 gime->WriteDigits("OVERWRITE");
640 gime->WriteDigitizer("OVERWRITE");