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 // SetName(fManager->GetInputFolderName(0)) ;
143 // take title as name of stream 0
144 SetTitle(dynamic_cast<AliStream*>(fManager->GetInputStream(0))->GetFileName(0));
147 fDefaultInit = kFALSE ;
150 //____________________________________________________________________________
151 AliEMCALDigitizer::~AliEMCALDigitizer()
154 AliEMCALGetter * gime =AliEMCALGetter::Instance(GetTitle(),fEventFolderName);
155 gime->EmcalLoader()->CleanDigitizer();
156 delete [] fInputFileNames ;
157 delete [] fEventNames ;
161 //____________________________________________________________________________
162 void AliEMCALDigitizer::Digitize(const Int_t event)
165 // Makes the digitization of the collected summable digits
166 // for this it first creates the array of all EMCAL modules
167 // filled with noise (different for EMC, CPV and PPSD) and
168 // after that adds contributions from SDigits. This design
169 // helps to avoid scanning over the list of digits to add
170 // contribution of any new SDigit.
172 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
173 TClonesArray * digits = gime->Digits() ;
176 const AliEMCALGeometry *geom = gime->EMCALGeometry() ;
178 //Making digits from noise first
180 nEMC = geom->GetNPhi()*geom->GetNZ(); //max number of digits possible
184 digits->Expand(nEMC) ;
186 // get first the sdigitizer from the tasks list (must have same name as the digitizer)
187 if ( !gime->SDigitizer() )
188 gime->LoadSDigitizer();
189 AliEMCALSDigitizer * sDigitizer = gime->SDigitizer();
192 Fatal("Digitize", "SDigitizer with name %s %s not found", fEventFolderName.Data(), GetTitle() ) ;
194 //take all the inputs to add together and load the SDigits
195 TObjArray * sdigArray = new TObjArray(fInput) ;
196 sdigArray->AddAt(gime->SDigits(), 0) ;
198 for(i = 1 ; i < fInput ; i++){
199 TString tempo(fEventNames[i]) ;
201 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
202 gime->Event(event,"S");
203 sdigArray->AddAt(gime->SDigits(), i) ;
206 //Find the first tower with signal
207 Int_t nextSig = nEMC + 1 ;
208 TClonesArray * sdigits ;
209 for(i = 0 ; i < fInput ; i++){
210 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
211 if ( !sdigits->GetEntriesFast() )
213 Int_t curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(0))->GetId() ;
214 if(curNext < nextSig)
218 TArrayI index(fInput) ;
219 index.Reset() ; //Set all indexes to zero
221 AliEMCALDigit * digit ;
222 AliEMCALDigit * curSDigit ;
224 TClonesArray * ticks = new TClonesArray("AliEMCALTick",1000) ;
226 //Put Noise contribution
227 for(absID = 1; absID <= nEMC; absID++){
229 // amplitude set to zero, noise will be added later
230 new((*digits)[absID-1]) AliEMCALDigit( -1, -1, absID, 0, TimeOfNoise() ) ;
231 //look if we have to add signal?
232 digit = dynamic_cast<AliEMCALDigit *>(digits->At(absID-1)) ;
235 //Add SDigits from all inputs
238 Float_t a = digit->GetAmp() ;
239 Float_t b = TMath::Abs( a /fTimeSignalLength) ;
240 //Mark the beginning of the signal
241 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime(),0, b);
242 //Mark the end of the signal
243 new((*ticks)[contrib++]) AliEMCALTick(digit->GetTime()+fTimeSignalLength, -a, -b);
246 for(i = 0; i< fInput ; i++){ //loop over (possible) merge sources
247 if(dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
248 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
251 //May be several digits will contribute from the same input
252 while(curSDigit && (curSDigit->GetId() == absID)){
253 //Shift primary to separate primaries belonging different inputs
254 Int_t primaryoffset ;
256 primaryoffset = fManager->GetMask(i) ;
259 curSDigit->ShiftPrimary(primaryoffset) ;
261 a = curSDigit->GetAmp() ;
262 b = a /fTimeSignalLength ;
263 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime(),0, b);
264 new((*ticks)[contrib++]) AliEMCALTick(curSDigit->GetTime()+fTimeSignalLength, -a, -b);
266 *digit = *digit + *curSDigit ; //add energies
269 if( dynamic_cast<TClonesArray *>(sdigArray->At(i))->GetEntriesFast() > index[i] )
270 curSDigit = dynamic_cast<AliEMCALDigit*>(dynamic_cast<TClonesArray *>(sdigArray->At(i))->At(index[i])) ;
275 // add fluctuations for photo-electron creation
276 amp = sDigitizer->Calibrate(digit->GetAmp()) ; // GeV
277 amp *= static_cast<Float_t>(gRandom->Poisson(fMeanPhotonElectron)) / static_cast<Float_t>(fMeanPhotonElectron) ;
279 //calculate and set time
280 Float_t time = FrontEdgeTime(ticks) ;
281 digit->SetTime(time) ;
283 //Find next signal module
285 for(i = 0 ; i < fInput ; i++){
286 sdigits = dynamic_cast<TClonesArray *>(sdigArray->At(i)) ;
287 Int_t curNext = nextSig ;
288 if(sdigits->GetEntriesFast() > index[i] ){
289 curNext = dynamic_cast<AliEMCALDigit *>(sdigits->At(index[i]))->GetId() ;
291 if(curNext < nextSig) nextSig = curNext ;
295 amp += TMath::Abs(gRandom->Gaus(0., fPinNoise)) ;
296 digit->SetAmp(sDigitizer->Digitize(amp)) ;
302 delete sdigArray ; //We should not delete its contents
304 //remove digits below thresholds
305 for(i = 0 ; i < nEMC ; i++){
306 digit = dynamic_cast<AliEMCALDigit*>( digits->At(i) ) ;
307 Float_t threshold = fDigitThreshold ;
308 if(sDigitizer->Calibrate( digit->GetAmp() ) < threshold)
309 digits->RemoveAt(i) ;
311 digit->SetTime(gRandom->Gaus(digit->GetTime(),fTimeResolution) ) ;
316 Int_t ndigits = digits->GetEntriesFast() ;
317 digits->Expand(ndigits) ;
319 //Set indexes in list of digits
320 for (i = 0 ; i < ndigits ; i++) {
321 digit = dynamic_cast<AliEMCALDigit *>( digits->At(i) ) ;
322 digit->SetIndexInList(i) ;
323 Float_t energy = sDigitizer->Calibrate(digit->GetAmp()) ;
324 digit->SetAmp(DigitizeEnergy(energy) ) ;
328 //____________________________________________________________________________
330 Int_t AliEMCALDigitizer::DigitizeEnergy(Float_t energy)
332 Int_t channel = -999;
333 channel = static_cast<Int_t> (TMath::Ceil( (energy + fADCpedestalEC)/fADCchannelEC )) ;
334 if(channel > fNADCEC )
339 //____________________________________________________________________________
340 void AliEMCALDigitizer::Exec(Option_t *option)
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");
358 fInput = fManager->GetNinputs() ;
360 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
362 Int_t nevents = gime->MaxEvent() ;;
366 for(ievent = 0; ievent < nevents; ievent++){
368 gime->Event(ievent,"S") ;
370 Digitize(ievent) ; //Add prepared SDigits to digits and add the noise
374 if(strstr(option,"deb"))
377 //increment the total number of Digits per run
378 fDigitsInRun += gime->Digits()->GetEntriesFast() ;
381 if(strstr(option,"tim")){
382 gBenchmark->Stop("EMCALDigitizer");
383 printf("Exec: took %f seconds for Digitizing %f seconds per event",
384 gBenchmark->GetCpuTime("EMCALDigitizer"), gBenchmark->GetCpuTime("EMCALDigitizer")/nevents ) ;
388 //____________________________________________________________________________
389 Float_t AliEMCALDigitizer::FrontEdgeTime(TClonesArray * ticks)
391 // Returns the shortest time among all time ticks
393 ticks->Sort() ; //Sort in accordance with times of ticks
395 AliEMCALTick * ctick = (AliEMCALTick *) it.Next() ;
396 Float_t time = ctick->CrossingTime(fTimeThreshold) ;
399 while((t=(AliEMCALTick*) it.Next())){
400 if(t->GetTime() < time) //This tick starts before crossing
405 time = ctick->CrossingTime(fTimeThreshold) ;
410 //____________________________________________________________________________
411 Bool_t AliEMCALDigitizer::Init()
413 // Makes all memory allocations
415 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
417 Error("Init", "Could not obtain the Getter object for file %s and event %s !", GetTitle(), fEventFolderName.Data()) ;
421 TString opt("Digits") ;
422 if(gime->VersionExists(opt) ) {
423 Error( "Init", "Give a version name different from %s", fEventFolderName.Data() ) ;
427 // Post Digitizer to the white board
428 gime->PostDigitizer(this) ;
431 fInput = fManager->GetNinputs() ;
435 fInputFileNames = new TString[fInput] ;
436 fEventNames = new TString[fInput] ;
437 fInputFileNames[0] = GetTitle() ;
438 fEventNames[0] = fEventFolderName.Data() ;
440 for (index = 1 ; index < fInput ; index++) {
441 fInputFileNames[index] = dynamic_cast<AliStream*>(fManager->GetInputStream(index))->GetFileName(0);
442 TString tempo = fManager->GetInputFolderName(index) ;
443 fEventNames[index] = tempo.Remove(tempo.Length()-1) ; // strip of the stream number added bt fManager
446 //to prevent cleaning of this object while GetEvent is called
447 gime->EmcalLoader()->GetDigitsDataLoader()->GetBaseTaskLoader()->SetDoNotReload(kTRUE);
452 //____________________________________________________________________________
453 void AliEMCALDigitizer::InitParameters()
455 fMeanPhotonElectron = 1250 ; // electrons per GeV
456 fPinNoise = 0.001 ; // noise equivalent GeV (random choice)
457 if (fPinNoise == 0. )
458 Warning("InitParameters", "No noise added\n") ;
459 fDigitThreshold = fPinNoise * 3; //2 sigma
460 fTimeResolution = 0.5e-9 ;
461 fTimeSignalLength = 1.0e-9 ;
463 fADCchannelEC = 0.000220; // width of one ADC channel in GeV
464 fADCpedestalEC = 0.005 ; // GeV
465 fNADCEC = (Int_t) TMath::Power(2,16) ; // number of channels in Tower ADC
467 fTimeThreshold = 0.001*10000000 ; //Means 1 MeV in terms of SDigits amplitude
471 //__________________________________________________________________
472 void AliEMCALDigitizer::MixWith(const TString alirunFileName, const TString eventFolderName)
474 // Allows to produce digits by superimposing background and signal event.
475 // It is assumed, that headers file with SIGNAL events is opened in
477 // Sets the BACKGROUND event, with which the SIGNAL event is to be mixed
478 // Thus we avoid writing (changing) huge and expensive
479 // backgound files: all output will be writen into SIGNAL, i.e.
480 // opened in constructor file.
482 // One can open as many files to mix with as one needs.
483 // However only Sdigits with the same name (i.e. constructed with the same SDigitizer)
486 if( strcmp(GetName(), "") == 0 )
490 Error("MixWith", "Cannot use this method under AliRunDigitizer") ;
493 // looking for file which contains AliRun
494 if (gSystem->AccessPathName(alirunFileName)) {// file does not exist
495 Error("MixWith", "File %s does not exist!", alirunFileName.Data()) ;
498 // looking for the file which contains SDigits
499 AliEMCALGetter * gime = AliEMCALGetter::Instance() ;
500 TString fileName( gime->GetSDigitsFileName() ) ;
501 if ( eventFolderName != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
502 fileName = fileName.ReplaceAll(".root", "") + "_" + eventFolderName + ".root" ;
503 if ( (gSystem->AccessPathName(fileName)) ) {
504 Error("MixWith", "The file %s does not exist!", fileName.Data()) ;
507 // need to increase the arrays
508 TString tempo = fInputFileNames[fInput-1] ;
509 delete [] fInputFileNames ;
510 fInputFileNames = new TString[fInput+1] ;
511 fInputFileNames[fInput-1] = tempo ;
513 tempo = fEventNames[fInput-1] ;
514 delete [] fEventNames ;
515 fEventNames = new TString[fInput+1] ;
516 fEventNames[fInput-1] = tempo ;
518 fInputFileNames[fInput] = alirunFileName ;
519 fEventNames[fInput] = eventFolderName ;
523 //__________________________________________________________________
524 void AliEMCALDigitizer::Print()const
526 // Print Digitizer's parameters
527 printf("Print: \n------------------- %s -------------", GetName() ) ;
528 if( strcmp(fEventFolderName.Data(), "") != 0 ){
529 printf(" Writing Digits to branch with title %s\n", fEventFolderName.Data()) ;
533 nStreams = GetNInputStreams() ;
538 for (index = 0 ; index < nStreams ; index++) {
539 TString tempo(fEventNames[index]) ;
541 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[index], tempo) ;
542 TString fileName( gime->GetSDigitsFileName() ) ;
543 if ( fEventNames[index] != AliConfig::fgkDefaultEventFolderName) // only if not the default folder name
544 fileName = fileName.ReplaceAll(".root", "") + "_" + fEventNames[index] + ".root" ;
545 printf ("Adding SDigits from %s %s\n", fInputFileNames[index].Data(), fileName.Data()) ;
547 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
548 printf("\nWriting digits to %s", gime->GetDigitsFileName().Data()) ;
550 printf("\nWith following parameters:\n") ;
552 printf(" Electronics noise in EMC (fPinNoise) = %f\n", fPinNoise) ;
553 printf(" Threshold in EMC (fDigitThreshold) = %f\n", fDigitThreshold) ;
554 printf("---------------------------------------------------\n") ;
557 printf("Print: AliEMCALDigitizer not initialized") ;
560 //__________________________________________________________________
561 void AliEMCALDigitizer::PrintDigits(Option_t * option){
563 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
564 TClonesArray * digits = gime->Digits() ;
566 printf("PrintDigits: %d", digits->GetEntriesFast()) ;
567 printf("\nevent %d", gAlice->GetEvNumber()) ;
568 printf("\n Number of entries in Digits list %d", digits->GetEntriesFast() ) ;
570 if(strstr(option,"all")){
572 AliEMCALDigit * digit;
573 printf("\nEMC digits (with primaries):\n") ;
574 printf("\n Id Amplitude Time Index Nprim: Primaries list \n") ;
576 for (index = 0 ; index < digits->GetEntries() ; index++) {
577 digit = dynamic_cast<AliEMCALDigit *>(digits->At(index)) ;
578 printf("\n%6d %8d %6.5e %4d %2d : ",
579 digit->GetId(), digit->GetAmp(), digit->GetTime(), digit->GetIndexInList(), digit->GetNprimary()) ;
581 for (iprimary=0; iprimary<digit->GetNprimary(); iprimary++) {
582 printf("%d ",digit->GetPrimary(iprimary+1) ) ;
588 //__________________________________________________________________
589 Float_t AliEMCALDigitizer::TimeOfNoise(void)
590 { // Calculates the time signal generated by noise
591 //to be rewritten, now returns just big number
596 //__________________________________________________________________
597 void AliEMCALDigitizer::Unload()
599 // Unloads the SDigits and Digits
601 for(i = 1 ; i < fInput ; i++){
602 TString tempo(fEventNames[i]) ;
604 AliEMCALGetter * gime = AliEMCALGetter::Instance(fInputFileNames[i], tempo) ;
605 gime->EmcalLoader()->UnloadSDigits() ;
608 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
609 gime->EmcalLoader()->UnloadDigits() ;
612 //_________________________________________________________________________________________
613 void AliEMCALDigitizer::WriteDigits()
616 // Makes TreeD in the output file.
617 // Check if branch already exists:
618 // if yes, exit without writing: ROOT TTree does not support overwriting/updating of
619 // already existing branches.
620 // else creates branch with Digits, named "EMCAL", title "...",
621 // and branch "AliEMCALDigitizer", with the same title to keep all the parameters
622 // and names of files, from which digits are made.
624 AliEMCALGetter * gime = AliEMCALGetter::Instance(GetTitle(), fEventFolderName) ;
625 const TClonesArray * digits = gime->Digits() ;
626 TTree * treeD = gime->TreeD();
628 // -- create Digits branch
629 Int_t bufferSize = 32000 ;
630 TBranch * digitsBranch = treeD->Branch("EMCAL",&digits,bufferSize);
631 digitsBranch->SetTitle(fEventFolderName);
632 digitsBranch->Fill() ;
634 gime->WriteDigits("OVERWRITE");
635 gime->WriteDigitizer("OVERWRITE");