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(const TString alirunFileName, const 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),
142 fEventFolderName = fManager->GetInputFolderName(0) ;
143 SetTitle(dynamic_cast<AliStream*>(fManager->GetInputStream(0))->GetFileName(0));
146 fDefaultInit = kFALSE ;
149 //____________________________________________________________________________
150 AliEMCALDigitizer::~AliEMCALDigitizer()
153 AliEMCALGetter * gime =AliEMCALGetter::Instance(GetTitle(),fEventFolderName);
154 gime->EmcalLoader()->CleanDigitizer();
155 delete [] fInputFileNames ;
156 delete [] fEventNames ;
160 //____________________________________________________________________________
161 void AliEMCALDigitizer::Digitize(const Int_t event)
164 // Makes the digitization of the collected summable digits
165 // for this it first creates the array of all EMCAL modules
166 // filled with noise (different for EMC, CPV and PPSD) and
167 // after that adds contributions from SDigits. This design
168 // helps to avoid scanning over the list of digits to add
169 // contribution of any new SDigit.
171 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
172 TClonesArray * digits = gime->Digits() ;
175 const AliEMCALGeometry *geom = gime->EMCALGeometry() ;
178 nEMC = geom->GetNPhi()*geom->GetNZ(); //max number of digits possible
182 digits->Expand(nEMC) ;
184 // get first the sdigitizer from the tasks list (must have same name as the digitizer)
185 if ( !gime->SDigitizer() )
186 gime->LoadSDigitizer();
187 AliEMCALSDigitizer * sDigitizer = gime->SDigitizer();
190 Fatal("Digitize", "SDigitizer with name %s %s not found", fEventFolderName.Data(), GetTitle() ) ;
192 //take all the inputs to add together and load the SDigits
193 TObjArray * sdigArray = new TObjArray(fInput) ;
194 sdigArray->AddAt(gime->SDigits(), 0) ;
196 for(i = 1 ; i < fInput ; i++){
197 TString tempo(fEventNames[i]) ;
199 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
200 gime->Event(event,"S");
201 sdigArray->AddAt(gime->SDigits(), i) ;
204 //Find the first tower with signal
205 Int_t nextSig = nEMC + 1 ;
206 TClonesArray * sdigits ;
207 for(i = 0 ; i < fInput ; i++){
208 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
209 if ( !sdigits->GetEntriesFast() )
211 Int_t curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(0))->GetId() ;
212 if(curNext < nextSig)
216 TArrayI index(fInput) ;
217 index.Reset() ; //Set all indexes to zero
219 AliEMCALDigit * digit ;
220 AliEMCALDigit * curSDigit ;
222 TClonesArray * ticks = new TClonesArray("AliEMCALTick",1000) ;
224 //Put Noise contribution
225 for(absID = 1; absID <= nEMC; absID++){
227 // amplitude set to zero, noise will be added later
228 new((*digits)[absID-1]) AliEMCALDigit( -1, -1, absID, 0, TimeOfNoise() ) ;
229 //look if we have to add signal?
230 digit = dynamic_cast<AliEMCALDigit *>(digits->At(absID-1)) ;
233 //Add SDigits from all inputs
236 Float_t a = digit->GetAmp() ;
237 Float_t b = TMath::Abs( a /fTimeSignalLength) ;
238 //Mark the beginning of the signal
239 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime(),0, b);
240 //Mark the end of the signal
241 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime()+fTimeSignalLength, -a, -b);
244 for(i = 0; i< fInput ; i++){ //loop over (possible) merge sources
245 if(dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
246 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
249 //May be several digits will contribute from the same input
250 while(curSDigit && (curSDigit->GetId() == absID)){
251 //Shift primary to separate primaries belonging different inputs
252 Int_t primaryoffset ;
254 primaryoffset = fManager->GetMask(i) ;
257 curSDigit->ShiftPrimary(primaryoffset) ;
259 a = curSDigit->GetAmp() ;
260 b = a /fTimeSignalLength ;
261 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime(),0, b);
262 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime()+fTimeSignalLength, -a, -b);
264 *digit = *digit + *curSDigit ; //add energies
267 if( dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
268 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
273 // add fluctuations for photo-electron creation
274 amp = sDigitizer->Calibrate(digit->GetAmp()) ; // GeV
275 amp *= static_cast<Float_t>(gRandom->Poisson(fMeanPhotonElectron)) / static_cast<Float_t>(fMeanPhotonElectron) ;
277 //calculate and set time
278 Float_t time = FrontEdgeTime(ticks) ;
279 digit->SetTime(time) ;
281 //Find next signal module
283 for(i = 0 ; i < fInput ; i++){
284 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
285 Int_t curNext = nextSig ;
286 if(sdigits->GetEntriesFast() > index[i] ){
287 curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(index[i]))->GetId() ;
289 if(curNext < nextSig) nextSig = curNext ;
293 amp += TMath::Abs(gRandom->Gaus(0., fPinNoise)) ;
294 digit->SetAmp(sDigitizer->Digitize(amp)) ;
300 delete sdigArray ; //We should not delete its contents
302 //remove digits below thresholds
303 for(i = 0 ; i < nEMC ; i++){
304 digit = dynamic_cast<AliEMCALDigit*>( digits->At(i) ) ;
305 Float_t threshold = fDigitThreshold ;
306 if(sDigitizer->Calibrate( digit->GetAmp() ) < threshold)
307 digits->RemoveAt(i) ;
309 digit->SetTime(gRandom->Gaus(digit->GetTime(),fTimeResolution) ) ;
314 Int_t ndigits = digits->GetEntriesFast() ;
315 digits->Expand(ndigits) ;
317 //Set indexes in list of digits
318 for (i = 0 ; i < ndigits ; i++) {
319 digit = dynamic_cast<AliEMCALDigit *>( digits->At(i) ) ;
320 digit->SetIndexInList(i) ;
321 Float_t energy = sDigitizer->Calibrate(digit->GetAmp()) ;
322 digit->SetAmp(DigitizeEnergy(energy) ) ;
326 //____________________________________________________________________________
328 Int_t AliEMCALDigitizer::DigitizeEnergy(Float_t energy)
330 Int_t channel = -999;
331 channel = static_cast<Int_t> (TMath::Ceil( (energy + fADCpedestalEC)/fADCchannelEC )) ;
332 if(channel > fNADCEC )
337 //____________________________________________________________________________
338 void AliEMCALDigitizer::Exec(Option_t *option)
342 if (!fInit) { // to prevent overwrite existing file
343 Error( "Exec", "Give a version name different from %s", fEventFolderName.Data() ) ;
347 if (strstr(option,"print")) {
352 if(strstr(option,"tim"))
353 gBenchmark->Start("EMCALDigitizer");
356 fInput = fManager->GetNinputs() ;
358 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
360 Int_t nevents = gime->MaxEvent() ;;
364 for(ievent = 0; ievent < nevents; ievent++){
366 gime->Event(ievent,"S") ;
368 Digitize(ievent) ; //Add prepared SDigits to digits and add the noise
372 if(strstr(option,"deb"))
375 //increment the total number of Digits per run
376 fDigitsInRun += gime->Digits()->GetEntriesFast() ;
379 if(strstr(option,"tim")){
380 gBenchmark->Stop("EMCALDigitizer");
381 printf("Exec: took %f seconds for Digitizing %f seconds per event",
382 gBenchmark->GetCpuTime("EMCALDigitizer"), gBenchmark->GetCpuTime("EMCALDigitizer")/nevents ) ;
386 //____________________________________________________________________________
387 Float_t AliEMCALDigitizer::FrontEdgeTime(TClonesArray * ticks)
389 // Returns the shortest time among all time ticks
391 ticks->Sort() ; //Sort in accordance with times of ticks
393 AliEMCALTick * ctick = (AliEMCALTick *) it.Next() ;
394 Float_t time = ctick->CrossingTime(fTimeThreshold) ;
397 while((t=(AliEMCALTick*) it.Next())){
398 if(t->GetTime() < time) //This tick starts before crossing
403 time = ctick->CrossingTime(fTimeThreshold) ;
408 //____________________________________________________________________________
409 Bool_t AliEMCALDigitizer::Init()
411 // Makes all memory allocations
413 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
415 Error("Init", "Could not obtain the Getter object for file %s and event %s !", GetTitle(), fEventFolderName.Data()) ;
419 TString opt("Digits") ;
420 if(gime->VersionExists(opt) ) {
421 Error( "Init", "Give a version name different from %s", fEventFolderName.Data() ) ;
425 // Post Digitizer to the white board
426 gime->PostDigitizer(this) ;
429 fInput = fManager->GetNinputs() ;
433 fInputFileNames = new TString[fInput] ;
434 fEventNames = new TString[fInput] ;
435 fInputFileNames[0] = GetTitle() ;
436 fEventNames[0] = fEventFolderName.Data() ;
438 for (index = 1 ; index < fInput ; index++) {
439 fInputFileNames[index] = dynamic_cast<AliStream*>(fManager->GetInputStream(index))->GetFileName(0);
440 TString tempo = fManager->GetInputFolderName(index) ;
441 fEventNames[index] = tempo.Remove(tempo.Length()-1) ; // strip of the stream number added bt fManager
444 //to prevent cleaning of this object while GetEvent is called
445 gime->EmcalLoader()->GetDigitsDataLoader()->GetBaseTaskLoader()->SetDoNotReload(kTRUE);
450 //____________________________________________________________________________
451 void AliEMCALDigitizer::InitParameters()
453 fMeanPhotonElectron = 18200 ; // electrons per GeV
454 fPinNoise = 0.1 ; // noise equivalent GeV (random choice)
455 if (fPinNoise == 0. )
456 Warning("InitParameters", "No noise added\n") ;
457 fDigitThreshold = fPinNoise * 3; //2 sigma
458 fTimeResolution = 1.0e-9 ;
459 fTimeSignalLength = 1.0e-9 ;
461 fADCchannelEC = 0.00050; // width of one ADC channel in GeV
462 fADCpedestalEC = 0.005 ; // GeV
463 fNADCEC = (Int_t) TMath::Power(2,16) ; // number of channels in Tower ADC
465 fTimeThreshold = 0.001*10000000 ; //Means 1 MeV in terms of SDigits amplitude
469 //__________________________________________________________________
470 void AliEMCALDigitizer::MixWith(const TString alirunFileName, const TString eventFolderName)
472 // Allows to produce digits by superimposing background and signal event.
473 // It is assumed, that headers file with SIGNAL events is opened in
475 // Sets the BACKGROUND event, with which the SIGNAL event is to be mixed
476 // Thus we avoid writing (changing) huge and expensive
477 // backgound files: all output will be writen into SIGNAL, i.e.
478 // opened in constructor file.
480 // One can open as many files to mix with as one needs.
481 // However only Sdigits with the same name (i.e. constructed with the same SDigitizer)
484 if( strcmp(GetName(), "") == 0 )
488 Error("MixWith", "Cannot use this method under AliRunDigitizer") ;
491 // looking for file which contains AliRun
492 if (gSystem->AccessPathName(alirunFileName)) {// file does not exist
493 Error("MixWith", "File %s does not exist!", alirunFileName.Data()) ;
496 // looking for the file which contains SDigits
497 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
498 TString fileName( gime->GetSDigitsFileName() ) ;
499 if ( eventFolderName != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
500 fileName = fileName.ReplaceAll(".root", "") + "_" + eventFolderName + ".root" ;
501 if ( (gSystem->AccessPathName(fileName)) ) {
502 Error("MixWith", "The file %s does not exist!", fileName.Data()) ;
505 // need to increase the arrays
506 TString tempo = fInputFileNames[fInput-1] ;
507 delete [] fInputFileNames ;
508 fInputFileNames = new TString[fInput+1] ;
509 fInputFileNames[fInput-1] = tempo ;
511 tempo = fEventNames[fInput-1] ;
512 delete [] fEventNames ;
513 fEventNames = new TString[fInput+1] ;
514 fEventNames[fInput-1] = tempo ;
516 fInputFileNames[fInput] = alirunFileName ;
517 fEventNames[fInput] = eventFolderName ;
521 //__________________________________________________________________
522 void AliEMCALDigitizer::Print()const
524 // Print Digitizer's parameters
525 printf("Print: \n------------------- %s -------------", GetName() ) ;
526 if( strcmp(fEventFolderName.Data(), "") != 0 ){
527 printf(" Writing Digits to branch with title %s\n", fEventFolderName.Data()) ;
531 nStreams = GetNInputStreams() ;
536 for (index = 0 ; index < nStreams ; index++) {
537 TString tempo(fEventNames[index]) ;
539 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[index], tempo) ;
540 TString fileName( gime->GetSDigitsFileName() ) ;
541 if ( fEventNames[index] != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
542 fileName = fileName.ReplaceAll(".root", "") + "_" + fEventNames[index] + ".root" ;
543 printf ("Adding SDigits from %s %s\n", fInputFileNames[index].Data(), fileName.Data()) ;
545 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
546 printf("\nWriting digits to %s", gime->GetDigitsFileName().Data()) ;
548 printf("\nWith following parameters:\n") ;
550 printf(" Electronics noise in EMC (fPinNoise) = %f\n", fPinNoise) ;
551 printf(" Threshold in EMC (fDigitThreshold) = %f\n", fDigitThreshold) ;
552 printf("---------------------------------------------------\n") ;
555 printf("Print: AliEMCALDigitizer not initialized") ;
558 //__________________________________________________________________
559 void AliEMCALDigitizer::PrintDigits(Option_t * option){
561 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
562 TClonesArray * digits = gime->Digits() ;
564 printf("PrintDigits: %d", digits->GetEntriesFast()) ;
565 printf("\nevent %d", gAlice->GetEvNumber()) ;
566 printf("\n Number of entries in Digits list %d", digits->GetEntriesFast() ) ;
568 if(strstr(option,"all")){
570 AliEMCALDigit * digit;
571 printf("\nEMC digits (with primaries):\n") ;
572 printf("\n Id Amplitude Time Index Nprim: Primaries list \n") ;
574 for (index = 0 ; index < digits->GetEntries() ; index++) {
575 digit = dynamic_cast<AliEMCALDigit *>(digits->At(index)) ;
576 printf("\n%6d %8d %6.5e %4d %2d : ",
577 digit->GetId(), digit->GetAmp(), digit->GetTime(), digit->GetIndexInList(), digit->GetNprimary()) ;
579 for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++) {
580 printf("%d ",digit->GetPrimary(iprimary+1) ) ;
586 //__________________________________________________________________
587 Float_t AliEMCALDigitizer::TimeOfNoise(void)
588 { // Calculates the time signal generated by noise
589 //to be rewritten, now returns just big number
594 //__________________________________________________________________
595 void AliEMCALDigitizer::Unload()
597 // Unloads the SDigits and Digits
599 for(i = 1 ; i < fInput ; i++){
600 TString tempo(fEventNames[i]) ;
602 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
603 gime->EmcalLoader()->UnloadSDigits() ;
606 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
607 gime->EmcalLoader()->UnloadDigits() ;
610 //_________________________________________________________________________________________
611 void AliEMCALDigitizer::WriteDigits()
614 // Makes TreeD in the output file.
615 // Check if branch already exists:
616 // if yes, exit without writing: ROOT TTree does not support overwriting/updating of
617 // already existing branches.
618 // else creates branch with Digits, named "EMCAL", title "...",
619 // and branch "AliEMCALDigitizer", with the same title to keep all the parameters
620 // and names of files, from which digits are made.
622 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
623 const TClonesArray * digits = gime->Digits() ;
624 TTree * treeD = gime->TreeD();
626 // -- create Digits branch
627 Int_t bufferSize = 32000 ;
628 TBranch * digitsBranch = treeD->Branch("EMCAL",&digits,bufferSize);
629 digitsBranch->SetTitle(fEventFolderName);
630 digitsBranch->Fill() ;
632 gime->WriteDigits("OVERWRITE");
633 gime->WriteDigitizer("OVERWRITE");