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 ---
66 #include "TObjString.h"
67 #include "TGeometry.h"
68 #include "TBenchmark.h"
70 // --- Standard library ---
72 // --- AliRoot header files ---
74 #include "AliHeader.h"
75 #include "AliStream.h"
76 #include "AliRunDigitizer.h"
77 #include "AliEMCALDigit.h"
79 #include "AliEMCALGetter.h"
80 #include "AliEMCALDigitizer.h"
81 #include "AliEMCALSDigitizer.h"
82 #include "AliEMCALGeometry.h"
83 #include "AliEMCALTick.h"
85 ClassImp(AliEMCALDigitizer)
88 //____________________________________________________________________________
89 AliEMCALDigitizer::AliEMCALDigitizer():AliDigitizer("",""),
96 fDefaultInit = kTRUE ;
97 fManager = 0 ; // We work in the standalong mode
98 fEventFolderName = "" ;
101 //____________________________________________________________________________
102 AliEMCALDigitizer::AliEMCALDigitizer(TString alirunFileName, TString eventFolderName):
103 AliDigitizer("EMCAL"+AliConfig::fgkDigitizerTaskName, alirunFileName),
104 fInputFileNames(0), fEventNames(0), fEventFolderName(eventFolderName)
110 fDefaultInit = kFALSE ;
111 fManager = 0 ; // We work in the standalong mode
114 //____________________________________________________________________________
115 AliEMCALDigitizer::AliEMCALDigitizer(const AliEMCALDigitizer & d) : AliDigitizer(d)
119 SetName(d.GetName()) ;
120 SetTitle(d.GetTitle()) ;
121 fDigitThreshold = d.fDigitThreshold ;
122 fMeanPhotonElectron = d.fMeanPhotonElectron ;
123 fPedestal = d.fPedestal ;
125 fPinNoise = d.fPinNoise ;
126 fTimeResolution = d.fTimeResolution ;
127 fTimeThreshold = d.fTimeThreshold ;
128 fTimeSignalLength = d.fTimeSignalLength ;
129 fADCchannelEC = d.fADCchannelEC ;
130 fADCpedestalEC = d.fADCpedestalEC ;
131 fNADCEC = d.fNADCEC ;
132 fEventFolderName = d.fEventFolderName;
135 //____________________________________________________________________________
136 AliEMCALDigitizer::AliEMCALDigitizer(AliRunDigitizer * rd):
137 AliDigitizer(rd,"EMCAL"+AliConfig::fgkDigitizerTaskName),
140 // ctor Init() is called by RunDigitizer
142 fEventFolderName = fManager->GetInputFolderName(0) ;
143 SetTitle(dynamic_cast<AliStream*>(fManager->GetInputStream(0))->GetFileName(0));
145 fDefaultInit = kFALSE ;
148 //____________________________________________________________________________
149 AliEMCALDigitizer::~AliEMCALDigitizer()
152 AliEMCALGetter * gime =AliEMCALGetter::Instance(GetTitle(),fEventFolderName);
153 gime->EmcalLoader()->CleanDigitizer();
154 delete [] fInputFileNames ;
155 delete [] fEventNames ;
159 //____________________________________________________________________________
160 void AliEMCALDigitizer::Digitize(Int_t event)
163 // Makes the digitization of the collected summable digits
164 // for this it first creates the array of all EMCAL modules
165 // filled with noise (different for EMC, CPV and PPSD) and
166 // after that adds contributions from SDigits. This design
167 // helps to avoid scanning over the list of digits to add
168 // contribution of any new SDigit.
170 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
171 Int_t ReadEvent = event ;
173 ReadEvent = dynamic_cast<AliStream*>(fManager->GetInputStream(0))->GetCurrentEventNumber() ;
174 Info("Digitize", "Adding event %d from input stream 0", ReadEvent) ;
175 gime->Event(ReadEvent, "S") ;
176 TClonesArray * digits = gime->Digits() ;
179 const AliEMCALGeometry *geom = gime->EMCALGeometry() ;
182 nEMC = geom->GetNPhi()*geom->GetNZ(); //max number of digits possible
186 digits->Expand(nEMC) ;
188 // get first the sdigitizer from the tasks list (must have same name as the digitizer)
189 if ( !gime->SDigitizer() )
190 gime->LoadSDigitizer();
191 AliEMCALSDigitizer * sDigitizer = gime->SDigitizer();
194 Fatal("Digitize", "SDigitizer with name %s %s not found", fEventFolderName.Data(), GetTitle() ) ;
196 //take all the inputs to add together and load the SDigits
197 TObjArray * sdigArray = new TObjArray(fInput) ;
198 sdigArray->AddAt(gime->SDigits(), 0) ;
200 for(i = 1 ; i < fInput ; i++){
201 TString tempo(fEventNames[i]) ;
203 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
205 ReadEvent = dynamic_cast<AliStream*>(fManager->GetInputStream(i))->GetCurrentEventNumber() ;
206 Info("Digitize", "Adding event %d from input stream %d", ReadEvent, i) ;
207 gime->Event(ReadEvent,"S");
208 sdigArray->AddAt(gime->SDigits(), i) ;
211 //Find the first tower with signal
212 Int_t nextSig = nEMC + 1 ;
213 TClonesArray * sdigits ;
214 for(i = 0 ; i < fInput ; i++){
215 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
216 if ( !sdigits->GetEntriesFast() )
218 Int_t curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(0))->GetId() ;
219 if(curNext < nextSig)
223 TArrayI index(fInput) ;
224 index.Reset() ; //Set all indexes to zero
226 AliEMCALDigit * digit ;
227 AliEMCALDigit * curSDigit ;
229 TClonesArray * ticks = new TClonesArray("AliEMCALTick",1000) ;
231 //Put Noise contribution
232 for(absID = 1; absID <= nEMC; absID++){
234 // amplitude set to zero, noise will be added later
235 new((*digits)[absID-1]) AliEMCALDigit( -1, -1, absID, 0, TimeOfNoise() ) ;
236 //look if we have to add signal?
237 digit = dynamic_cast<AliEMCALDigit *>(digits->At(absID-1)) ;
240 //Add SDigits from all inputs
243 Float_t a = digit->GetAmp() ;
244 Float_t b = TMath::Abs( a /fTimeSignalLength) ;
245 //Mark the beginning of the signal
246 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime(),0, b);
247 //Mark the end of the signal
248 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime()+fTimeSignalLength, -a, -b);
251 for(i = 0; i< fInput ; i++){ //loop over (possible) merge sources
252 if(dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
253 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
256 //May be several digits will contribute from the same input
257 while(curSDigit && (curSDigit->GetId() == absID)){
258 //Shift primary to separate primaries belonging different inputs
259 Int_t primaryoffset ;
261 primaryoffset = fManager->GetMask(i) ;
264 curSDigit->ShiftPrimary(primaryoffset) ;
266 a = curSDigit->GetAmp() ;
267 b = a /fTimeSignalLength ;
268 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime(),0, b);
269 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime()+fTimeSignalLength, -a, -b);
271 *digit = *digit + *curSDigit ; //add energies
274 if( dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
275 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
280 // add fluctuations for photo-electron creation
281 amp = sDigitizer->Calibrate(digit->GetAmp()) ; // GeV
282 amp *= static_cast<Float_t>(gRandom->Poisson(fMeanPhotonElectron)) / static_cast<Float_t>(fMeanPhotonElectron) ;
284 //calculate and set time
285 Float_t time = FrontEdgeTime(ticks) ;
286 digit->SetTime(time) ;
288 //Find next signal module
290 for(i = 0 ; i < fInput ; i++){
291 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
292 Int_t curNext = nextSig ;
293 if(sdigits->GetEntriesFast() > index[i] ){
294 curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(index[i]))->GetId() ;
296 if(curNext < nextSig) nextSig = curNext ;
300 amp += TMath::Abs(gRandom->Gaus(0., fPinNoise)) ;
301 digit->SetAmp(sDigitizer->Digitize(amp)) ;
307 delete sdigArray ; //We should not delete its contents
309 //remove digits below thresholds
310 for(i = 0 ; i < nEMC ; i++){
311 digit = dynamic_cast<AliEMCALDigit*>( digits->At(i) ) ;
312 Float_t threshold = fDigitThreshold ;
313 if(sDigitizer->Calibrate( digit->GetAmp() ) < threshold)
314 digits->RemoveAt(i) ;
316 digit->SetTime(gRandom->Gaus(digit->GetTime(),fTimeResolution) ) ;
321 Int_t ndigits = digits->GetEntriesFast() ;
322 digits->Expand(ndigits) ;
324 //Set indexes in list of digits
325 for (i = 0 ; i < ndigits ; i++) {
326 digit = dynamic_cast<AliEMCALDigit *>( digits->At(i) ) ;
327 digit->SetIndexInList(i) ;
328 Float_t energy = sDigitizer->Calibrate(digit->GetAmp()) ;
329 digit->SetAmp(DigitizeEnergy(energy) ) ;
333 //____________________________________________________________________________
335 Int_t AliEMCALDigitizer::DigitizeEnergy(Float_t energy)
337 Int_t channel = -999;
338 channel = static_cast<Int_t> (TMath::Ceil( (energy + fADCpedestalEC)/fADCchannelEC )) ;
339 if(channel > fNADCEC )
344 //____________________________________________________________________________
345 void AliEMCALDigitizer::Exec(Option_t *option)
347 // Steering method to process digitization for events
348 // in the range from fFirstEvent to fLastEvent.
349 // This range is optionally set by SetEventRange().
350 // if fLastEvent=-1, then process events until the end.
351 // by default fLastEvent = fFirstEvent (process only one event)
353 if (!fInit) { // to prevent overwrite existing file
354 Error( "Exec", "Give a version name different from %s", fEventFolderName.Data() ) ;
358 if (strstr(option,"print")) {
363 if(strstr(option,"tim"))
364 gBenchmark->Start("EMCALDigitizer");
366 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
368 if (fLastEvent == -1)
369 fLastEvent = gime->MaxEvent() - 1 ;
371 Int_t nEvents = fLastEvent - fFirstEvent + 1;
375 for (ievent = fFirstEvent; ievent <= fLastEvent; ievent++) {
377 gime->Event(ievent,"S") ;
379 Digitize(ievent) ; //Add prepared SDigits to digits and add the noise
383 if(strstr(option,"deb"))
386 //increment the total number of Digits per run
387 fDigitsInRun += gime->Digits()->GetEntriesFast() ;
390 if(strstr(option,"tim")){
391 gBenchmark->Stop("EMCALDigitizer");
392 printf("Exec: took %f seconds for Digitizing %f seconds per event",
393 gBenchmark->GetCpuTime("EMCALDigitizer"), gBenchmark->GetCpuTime("EMCALDigitizer")/nEvents ) ;
397 //____________________________________________________________________________
398 Float_t AliEMCALDigitizer::FrontEdgeTime(TClonesArray * ticks)
400 // Returns the shortest time among all time ticks
402 ticks->Sort() ; //Sort in accordance with times of ticks
404 AliEMCALTick * ctick = (AliEMCALTick *) it.Next() ;
405 Float_t time = ctick->CrossingTime(fTimeThreshold) ;
408 while((t=(AliEMCALTick*) it.Next())){
409 if(t->GetTime() < time) //This tick starts before crossing
414 time = ctick->CrossingTime(fTimeThreshold) ;
419 //____________________________________________________________________________
420 Bool_t AliEMCALDigitizer::Init()
422 // Makes all memory allocations
424 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
426 Error("Init", "Could not obtain the Getter object for file %s and event %s !", GetTitle(), fEventFolderName.Data()) ;
430 TString opt("Digits") ;
431 if(gime->VersionExists(opt) ) {
432 Error( "Init", "Give a version name different from %s", fEventFolderName.Data() ) ;
436 // Post Digitizer to the white board
437 gime->PostDigitizer(this) ;
440 fLastEvent = fFirstEvent ;
443 fInput = fManager->GetNinputs() ;
447 fInputFileNames = new TString[fInput] ;
448 fEventNames = new TString[fInput] ;
449 fInputFileNames[0] = GetTitle() ;
450 fEventNames[0] = fEventFolderName.Data() ;
452 for (index = 1 ; index < fInput ; index++) {
453 fInputFileNames[index] = dynamic_cast<AliStream*>(fManager->GetInputStream(index))->GetFileName(0);
454 TString tempo = fManager->GetInputFolderName(index) ;
455 fEventNames[index] = tempo.Remove(tempo.Length()-1) ; // strip of the stream number added bt fManager
458 //to prevent cleaning of this object while GetEvent is called
459 gime->EmcalLoader()->GetDigitsDataLoader()->GetBaseTaskLoader()->SetDoNotReload(kTRUE);
464 //____________________________________________________________________________
465 void AliEMCALDigitizer::InitParameters()
467 fMeanPhotonElectron = 18200 ; // electrons per GeV
468 fPinNoise = 0.1 ; // noise equivalent GeV (random choice)
469 if (fPinNoise == 0. )
470 Warning("InitParameters", "No noise added\n") ;
471 fDigitThreshold = fPinNoise * 3; //2 sigma
472 fTimeResolution = 1.0e-9 ;
473 fTimeSignalLength = 1.0e-9 ;
475 fADCchannelEC = 0.00050; // width of one ADC channel in GeV
476 fADCpedestalEC = 0.005 ; // GeV
477 fNADCEC = (Int_t) TMath::Power(2,16) ; // number of channels in Tower ADC
479 fTimeThreshold = 0.001*10000000 ; //Means 1 MeV in terms of SDigits amplitude
483 //__________________________________________________________________
484 void AliEMCALDigitizer::MixWith(TString alirunFileName, TString eventFolderName)
486 // Allows to produce digits by superimposing background and signal event.
487 // It is assumed, that headers file with SIGNAL events is opened in
489 // Sets the BACKGROUND event, with which the SIGNAL event is to be mixed
490 // Thus we avoid writing (changing) huge and expensive
491 // backgound files: all output will be writen into SIGNAL, i.e.
492 // opened in constructor file.
494 // One can open as many files to mix with as one needs.
495 // However only Sdigits with the same name (i.e. constructed with the same SDigitizer)
498 if( strcmp(GetName(), "") == 0 )
502 Error("MixWith", "Cannot use this method under AliRunDigitizer") ;
505 // looking for file which contains AliRun
506 if (gSystem->AccessPathName(alirunFileName)) {// file does not exist
507 Error("MixWith", "File %s does not exist!", alirunFileName.Data()) ;
510 // looking for the file which contains SDigits
511 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
512 TString fileName( gime->GetSDigitsFileName() ) ;
513 if ( eventFolderName != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
514 fileName = fileName.ReplaceAll(".root", "") + "_" + eventFolderName + ".root" ;
515 if ( (gSystem->AccessPathName(fileName)) ) {
516 Error("MixWith", "The file %s does not exist!", fileName.Data()) ;
519 // need to increase the arrays
520 TString tempo = fInputFileNames[fInput-1] ;
521 delete [] fInputFileNames ;
522 fInputFileNames = new TString[fInput+1] ;
523 fInputFileNames[fInput-1] = tempo ;
525 tempo = fEventNames[fInput-1] ;
526 delete [] fEventNames ;
527 fEventNames = new TString[fInput+1] ;
528 fEventNames[fInput-1] = tempo ;
530 fInputFileNames[fInput] = alirunFileName ;
531 fEventNames[fInput] = eventFolderName ;
535 //__________________________________________________________________
536 void AliEMCALDigitizer::Print()const
538 // Print Digitizer's parameters
539 printf("Print: \n------------------- %s -------------", GetName() ) ;
540 if( strcmp(fEventFolderName.Data(), "") != 0 ){
541 printf(" Writing Digits to branch with title %s\n", fEventFolderName.Data()) ;
545 nStreams = GetNInputStreams() ;
550 for (index = 0 ; index < nStreams ; index++) {
551 TString tempo(fEventNames[index]) ;
553 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[index], tempo) ;
554 TString fileName( gime->GetSDigitsFileName() ) ;
555 if ( fEventNames[index] != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
556 fileName = fileName.ReplaceAll(".root", "") + "_" + fEventNames[index] + ".root" ;
557 printf ("Adding SDigits from %s %s\n", fInputFileNames[index].Data(), fileName.Data()) ;
559 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
560 printf("\nWriting digits to %s", gime->GetDigitsFileName().Data()) ;
562 printf("\nWith following parameters:\n") ;
564 printf(" Electronics noise in EMC (fPinNoise) = %f\n", fPinNoise) ;
565 printf(" Threshold in EMC (fDigitThreshold) = %f\n", fDigitThreshold) ;
566 printf("---------------------------------------------------\n") ;
569 printf("Print: AliEMCALDigitizer not initialized") ;
572 //__________________________________________________________________
573 void AliEMCALDigitizer::PrintDigits(Option_t * option){
575 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
576 TClonesArray * digits = gime->Digits() ;
578 printf("PrintDigits: %d", digits->GetEntriesFast()) ;
579 printf("\nevent %d", gAlice->GetEvNumber()) ;
580 printf("\n Number of entries in Digits list %d", digits->GetEntriesFast() ) ;
582 if(strstr(option,"all")){
584 AliEMCALDigit * digit;
585 printf("\nEMC digits (with primaries):\n") ;
586 printf("\n Id Amplitude Time Index Nprim: Primaries list \n") ;
588 for (index = 0 ; index < digits->GetEntries() ; index++) {
589 digit = dynamic_cast<AliEMCALDigit *>(digits->At(index)) ;
590 printf("\n%6d %8d %6.5e %4d %2d : ",
591 digit->GetId(), digit->GetAmp(), digit->GetTime(), digit->GetIndexInList(), digit->GetNprimary()) ;
593 for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++) {
594 printf("%d ",digit->GetPrimary(iprimary+1) ) ;
600 //__________________________________________________________________
601 Float_t AliEMCALDigitizer::TimeOfNoise(void)
602 { // Calculates the time signal generated by noise
603 //to be rewritten, now returns just big number
608 //__________________________________________________________________
609 void AliEMCALDigitizer::Unload()
611 // Unloads the SDigits and Digits
613 for(i = 1 ; i < fInput ; i++){
614 TString tempo(fEventNames[i]) ;
616 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
617 gime->EmcalLoader()->UnloadSDigits() ;
620 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
621 gime->EmcalLoader()->UnloadDigits() ;
624 //_________________________________________________________________________________________
625 void AliEMCALDigitizer::WriteDigits()
628 // Makes TreeD in the output file.
629 // Check if branch already exists:
630 // if yes, exit without writing: ROOT TTree does not support overwriting/updating of
631 // already existing branches.
632 // else creates branch with Digits, named "EMCAL", title "...",
633 // and branch "AliEMCALDigitizer", with the same title to keep all the parameters
634 // and names of files, from which digits are made.
636 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
637 const TClonesArray * digits = gime->Digits() ;
638 TTree * treeD = gime->TreeD();
640 // -- create Digits branch
641 Int_t bufferSize = 32000 ;
642 TBranch * digitsBranch = treeD->Branch("EMCAL",&digits,bufferSize);
643 digitsBranch->SetTitle(fEventFolderName);
644 digitsBranch->Fill() ;
646 gime->WriteDigits("OVERWRITE");
647 gime->WriteDigitizer("OVERWRITE");