TOF/AliTOFDigitizer.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-2000, 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 //_________________________________________________________________________//
  17 //                                                                         //
  18 // This is a TTask that makes TOF-Digits out of TOF-SDigits.               //
  19 // The simulation of the detector is performed at sdigits level:           //
  20 // during digitization the unique task is the sum of all sdigits in the    //
  21 // same pad.                                                               //
  22 // Digits are written to TreeD in branch "TOF".                            //
  23 //                                                                         //
  24 // -- Author :  F. Pierella (Bologna University) pierella@bo.infn.it       //
  25 //                                                                         //
  26 //_________________________________________________________________________//
  27
  28 #include "Riostream.h"
  29
  30 #include "TFile.h"
  31 #include "TH1F.h"
  32 #include "TTree.h"
  33 #include "TRandom.h"
  34 #include "TObjArray.h"
  35
  36 #include "AliLoader.h"
  37 #include "AliLog.h"
  38 #include "AliRunDigitizer.h"
  39 #include "AliRunLoader.h"
  40 #include "AliRun.h"
  41
  42 #include "AliTOFcalib.h"
  43 #include "AliTOFChannelOnline.h"
  44 #include "AliTOFChannelOffline.h"
  45 #include "AliTOFDigitizer.h"
  46 #include "AliTOFdigit.h"
  47 #include "AliTOFHitMap.h"
  48 #include "AliTOFGeometry.h"
  49 #include "AliTOFSDigit.h"
  50 #include "AliTOF.h"
  51
  52 extern TDirectory *gDirectory;
  53 extern TFile *gFile;
  54 extern TRandom *gRandom;
  55
  56 extern AliRun *gAlice;
  57
  58
  59 ClassImp(AliTOFDigitizer)
  60
  61 //___________________________________________
  62   AliTOFDigitizer::AliTOFDigitizer()  :
  63     AliDigitizer(),
  64     fDigits(0x0),
  65     fSDigitsArray(0x0),
  66     fhitMap(0x0)
  67 {
  68   // Default ctor - don't use it
  69 }
  70
  71 //___________________________________________
  72 AliTOFDigitizer::AliTOFDigitizer(AliRunDigitizer* manager):
  73   AliDigitizer(manager),
  74   fDigits(0x0),
  75   fSDigitsArray(0x0),
  76   fhitMap(0x0)
  77 {
  78   //ctor with RunDigitizer
  79 }
  80
  81 //------------------------------------------------------------------------
  82 AliTOFDigitizer::AliTOFDigitizer(const AliTOFDigitizer &source):
  83   AliDigitizer(source),
  84   fDigits(0),
  85   fSDigitsArray(0),
  86   fhitMap(0)
  87 {
  88   // copy constructor
  89   this->fDigits=source.fDigits;
  90   this->fSDigitsArray=source.fSDigitsArray;
  91   this->fhitMap=source.fhitMap;
  92
  93 }
  94
  95 //------------------------------------------------------------------------
  96   AliTOFDigitizer& AliTOFDigitizer::operator=(const AliTOFDigitizer &source)
  97 {
  98   // ass. op.
  99   this->fDigits=source.fDigits;
 100   this->fSDigitsArray=source.fSDigitsArray;
 101   this->fhitMap=source.fhitMap;
 102   return *this;
 103
 104 }
 105
 106 //------------------------------------------------------------------------
 107 AliTOFDigitizer::~AliTOFDigitizer()
 108 {
 109   // Destructor
 110 }
 111
 112 //---------------------------------------------------------------------
 113
 114 void AliTOFDigitizer::Exec(Option_t* /*option*/)
 115 {
 116   //
 117   // Perform digitization and merging.
 118   // The algorithm is the following:
 119   // - a hitmap is created to check if a pad is already activated;
 120   // - an sdigits container is created to collect all sdigits from
 121   //   different files;
 122   // - sdigits are summed using the hitmap;
 123   // - the sdigits container is used to create the array of AliTOFdigit.
 124   //
 125
 126   AliDebug(1, "");
 127
 128
 129   // get the ptr to TOF detector
 130   AliTOF * tof = (AliTOF *) gAlice->GetDetector("TOF") ;
 131
 132   //Make branches
 133   char branchname[20];
 134   sprintf (branchname, "%s", tof->GetName ());
 135
 136   fDigits=new TClonesArray("AliTOFdigit",4000);
 137
 138   AliRunLoader* outrl = AliRunLoader::GetRunLoader(fManager->GetOutputFolderName());
 139   if (outrl == 0x0)
 140    {
 141      AliError("Can not find Run Loader in output folder.");
 142      return;
 143    }
 144
 145   /*
 146   outrl->CdGAFile();
 147   TFile *in=(TFile*)gFile;
 148   TDirectory *savedir=gDirectory;
 149
 150
 151   //when fGeom was needed
 152
 153   if (!in->IsOpen()) {
 154     AliWarning("Geometry file is not open default  TOF geometry will be used");
 155     fGeom = new AliTOFGeometry();
 156   }
 157   else {
 158     in->cd();
 159     fGeom = (AliTOFGeometry*)in->Get("TOFgeometry");
 160   }
 161
 162   savedir->cd();
 163   */
 164   AliLoader* outgime = outrl->GetLoader("TOFLoader");
 165   if (outgime == 0x0)
 166    {
 167      AliError("Can not get TOF Loader from Output Run Loader.");
 168      return;
 169    }
 170
 171   TTree* treeD = outgime->TreeD();
 172   if (treeD == 0x0)
 173    {
 174      outgime->MakeTree("D");
 175      treeD = outgime->TreeD();
 176    }
 177   //Make branch for digits (to be created in Init())
 178   tof->MakeBranchInTree(treeD,branchname,&fDigits,4000);
 179
 180   // container for all summed sdigits (to be created in Init())
 181   fSDigitsArray=new TClonesArray("AliTOFSDigit",1000);
 182
 183   // create hit map (to be created in Init())
 184   fhitMap = new AliTOFHitMap(fSDigitsArray);
 185
 186   // Loop over files to digitize
 187
 188   for (Int_t inputFile=0; inputFile<fManager->GetNinputs();
 189        inputFile++) {
 190     ReadSDigit(inputFile);
 191    }
 192
 193   // create digits
 194   CreateDigits();
 195
 196   // free used memory for Hit Map in current event
 197   delete fhitMap;
 198   fSDigitsArray->Delete();
 199   delete fSDigitsArray;
 200
 201   treeD->Fill();
 202
 203   outgime->WriteDigits("OVERWRITE");
 204   outgime->UnloadDigits();
 205   fDigits->Delete();
 206   delete fDigits;
 207
 208 }
 209
 210 //---------------------------------------------------------------------
 211
 212 void AliTOFDigitizer::CreateDigits()
 213 {
 214   // loop on sdigits container to fill the AliTOFdigit TClonesArray
 215   // start digitizing all the collected sdigits
 216
 217   Int_t ndump=0; // dump the first ndump created digits for each event
 218
 219   // get the total number of collected sdigits
 220   Int_t ndig = fSDigitsArray->GetEntriesFast();
 221
 222   for (Int_t k = 0; k < ndig; k++) {
 223
 224     Int_t  vol[5];  // location for a digit
 225     for (Int_t i=0; i<5; i++) vol[i] = -1;
 226
 227     // Get the information for this digit
 228     AliTOFSDigit *tofsdigit = (AliTOFSDigit *) fSDigitsArray->UncheckedAt(k);
 229
 230     Int_t nslot=tofsdigit->GetNDigits(); // get the number of slots
 231     // for current sdigit
 232
 233     // TOF sdigit volumes (always the same for all slots)
 234     Int_t sector    = tofsdigit->GetSector(); // range [0-17]
 235     Int_t plate     = tofsdigit->GetPlate();  // range [0- 4]
 236     Int_t strip     = tofsdigit->GetStrip();  // range [0-14/18/19]
 237     Int_t padz      = tofsdigit->GetPadz();   // range [0- 1]
 238     Int_t padx      = tofsdigit->GetPadx();   // range [0-47]
 239
 240     vol[0] = sector;
 241     vol[1] = plate;
 242     vol[2] = strip;
 243     vol[3] = padx;
 244     vol[4] = padz;
 245
 246     //--------------------- QA section ----------------------
 247     // in the while, I perform QA
 248     Bool_t isSDigitBad = (sector<0 || sector>17 || plate<0 || plate >4 || padz<0 || padz>1 || padx<0 || padx>47);
 249
 250     if (isSDigitBad) {
 251       //AliFatal("strange sdigit found");
 252       AliFatal(Form("strange sdigit found   %3i  %2i  %2i  %3i    %3i", sector, plate, padz, padx, strip));
 253     }
 254     //-------------------------------------------------------
 255
 256     //------------------- Dump section ----------------------
 257     if(k<ndump){
 258       AliInfo(Form("%2i-th | Sector %2i | Plate %1i | Strip %2i | PadZ %1i | PadX %2i ", k, sector, plate, strip, padz, padx));
 259       AliInfo(Form("%2i-th", k));
 260       AliInfo("----------------------------------------------------");
 261     }
 262     // ------------------------------------------------------
 263
 264     // start loop on number of slots for current sdigit
 265     for (Int_t islot = 0; islot < nslot; islot++) {
 266       Int_t  digit[4] = {-1,-1,-1,-1};     // TOF digit variables
 267       Int_t tracknum[AliTOFSDigit::kMAXDIGITS];     // contributing tracks for the current slot
 268
 269       Int_t tdc=tofsdigit->GetTdc(islot); digit[0]=tdc;
 270       Int_t adc=tofsdigit->GetAdc(islot); digit[1]=adc;
 271
 272       tracknum[0]=tofsdigit->GetTrack(islot,0);
 273       tracknum[1]=tofsdigit->GetTrack(islot,1);
 274       tracknum[2]=tofsdigit->GetTrack(islot,2);
 275
 276       // new with placement must be used
 277       // adding a TOF digit for each slot
 278       TClonesArray &aDigits = *fDigits;
 279       Int_t last=fDigits->GetEntriesFast();
 280       new (aDigits[last]) AliTOFdigit(tracknum, vol, digit);
 281
 282     }
 283
 284   } // end loop on sdigits - end digitizing all collected sdigits
 285
 286   //Insert Decalibration
 287   AliInfo("in digitizer, create digits");
 288   AliTOFcalib * calib = new AliTOFcalib();
 289   InitDecalibration(calib);
 290   DecalibrateTOFSignal(calib);
 291   delete calib;
 292 }
 293
 294 //---------------------------------------------------------------------
 295
 296 void AliTOFDigitizer::ReadSDigit(Int_t inputFile )
 297 {
 298   // Read sdigits for current event and inputFile;
 299   // store them into the sdigits container
 300   // and update the hit map
 301   // SDigits from different files are assumed to
 302   // be created with the same simulation parameters.
 303
 304   // get the treeS from manager
 305   AliRunLoader* rl = AliRunLoader::GetRunLoader(fManager->GetInputFolderName(inputFile));
 306   if (rl == 0x0)
 307    {
 308      AliError(Form("Can not find Run Loader in input %d folder.",inputFile));
 309      return;
 310    }
 311
 312   AliLoader* gime = rl->GetLoader("TOFLoader");
 313   if (gime == 0x0)
 314    {
 315      AliError(Form("Can not get TOF Loader from Input %d Run Loader.",inputFile));
 316      return;
 317    }
 318
 319   TTree* currentTreeS=gime->TreeS();
 320   if (currentTreeS == 0x0)
 321    {
 322      Int_t retval = gime->LoadSDigits();
 323      if (retval)
 324       {
 325          AliError(Form("Error occured while loading S. Digits for Input %d",inputFile));
 326          return;
 327       }
 328      currentTreeS=gime->TreeS();
 329      if (currentTreeS == 0x0)
 330       {
 331          AliError(Form("Can not get S. Digits Tree for Input %d",inputFile));
 332          return;
 333       }
 334    }
 335   // get the branch TOF inside the treeS
 336   TClonesArray * sdigitsDummyContainer= new TClonesArray("AliTOFSDigit",  1000);
 337
 338   // check if the branch exist
 339   TBranch* tofBranch=currentTreeS->GetBranch("TOF");
 340
 341   if(!tofBranch){
 342     AliFatal(Form("TOF branch not found for input %d",inputFile));
 343   }
 344
 345   tofBranch->SetAddress(&sdigitsDummyContainer);
 346
 347   Int_t nEntries = (Int_t)tofBranch->GetEntries();
 348
 349   // Loop through all entries in the tree
 350   Int_t nbytes = 0;
 351
 352   for (Int_t iEntry = 0; iEntry < nEntries; iEntry++) {
 353
 354     // Import the tree
 355     nbytes += tofBranch->GetEvent(iEntry);
 356
 357     // Get the number of sdigits
 358     Int_t ndig = sdigitsDummyContainer->GetEntriesFast();
 359
 360     for (Int_t k=0; k<ndig; k++) {
 361       AliTOFSDigit *tofSdigit= (AliTOFSDigit*) sdigitsDummyContainer->UncheckedAt(k);
 362
 363       Int_t  vol[5]; // location for a sdigit
 364       for (Int_t i=0; i<5; i++) vol[i] = -1;
 365
 366       // check the sdigit volume
 367       vol[0] = tofSdigit->GetSector();
 368       vol[1] = tofSdigit->GetPlate();
 369       vol[2] = tofSdigit->GetStrip();
 370       vol[3] = tofSdigit->GetPadx();
 371       vol[4] = tofSdigit->GetPadz();
 372
 373       if (fhitMap->TestHit(vol) != kEmpty) {
 374         AliTOFSDigit *sdig = static_cast<AliTOFSDigit*>(fhitMap->GetHit(vol));
 375         sdig->Update(tofSdigit);
 376
 377       } else {
 378
 379         CollectSDigit(tofSdigit); // collect the current sdigit
 380         fhitMap->SetHit(vol);     // update the hitmap for location vol
 381
 382       } // if (hitMap->TestHit(vol) != kEmpty)
 383
 384     } // for (Int_t k=0; k<ndig; k++)
 385     sdigitsDummyContainer->Delete();
 386
 387   } // end loop on entries
 388
 389   delete sdigitsDummyContainer;
 390
 391 }
 392
 393
 394 //_____________________________________________________________________________
 395 void AliTOFDigitizer::CollectSDigit(AliTOFSDigit * sdigit)
 396 {
 397   //
 398   // Add a TOF sdigit in container
 399   // new with placement must be used
 400   TClonesArray &aSDigitsArray = *fSDigitsArray;
 401   Int_t last=fSDigitsArray->GetEntriesFast();
 402   // make a copy of the current sdigit and
 403   // put it into tmp array
 404   new (aSDigitsArray[last]) AliTOFSDigit(*sdigit);
 405 }
 406
 407 //_____________________________________________________________________________
 408 void AliTOFDigitizer::InitDecalibration( AliTOFcalib *calib) const {
 409   calib->CreateSimCalArrays();
 410   calib->ReadSimParOnlineFromCDB("TOF/Calib", -1); // use AliCDBManager's number
 411   calib->ReadSimParOfflineFromCDB("TOF/Calib", -1); // use AliCDBManager's number
 412 }
 413 //---------------------------------------------------------------------
 414 void AliTOFDigitizer::DecalibrateTOFSignal( AliTOFcalib *calib){
 415
 416   // Read Calibration parameters from the CDB
 417
 418   TObjArray * calOnline= calib->GetTOFSimCalArrayOnline();
 419   TObjArray * calOffline= calib->GetTOFSimCalArrayOffline();
 420
 421   AliDebug(2,Form("Size of array for Online Calibration = %i",calOnline->GetEntries()));
 422   AliDebug(2,Form("Size of array for Offline Calibration = %i",calOffline->GetEntries()));
 423
 424   // Initialize Quantities to Simulate ToT Spectra
 425
 426   TH1F * hToT= calib->GetTOFSimToT();
 427   Int_t nbins = hToT->GetNbinsX();
 428   Float_t delta = hToT->GetBinWidth(1);
 429   Float_t maxch = hToT->GetBinLowEdge(nbins)+delta;
 430   Float_t minch = hToT->GetBinLowEdge(1);
 431   Float_t max=0,min=0; //maximum and minimum value of the distribution
 432   Int_t maxbin=0,minbin=0; //maximum and minimum bin of the distribution
 433
 434   for (Int_t ii=nbins; ii>0; ii--){
 435     if (hToT->GetBinContent(ii)!= 0) {
 436       max = maxch - (nbins-ii-1)*delta;
 437       maxbin = ii;
 438       break;}
 439   }
 440   for (Int_t j=1; j<nbins; j++){
 441     if (hToT->GetBinContent(j)!= 0) {
 442       min = minch + (j-1)*delta;
 443       minbin = j;
 444       break;}
 445   }
 446
 447   Float_t maxToT=max;
 448   Float_t minToT=min;
 449
 450   Float_t maxToTDistr=hToT->GetMaximum();
 451
 452   AliDebug (1, Form(" The minimum ToT = %f", minToT));
 453   AliDebug (1, Form(" The maximum ToT = %f", maxToT));
 454   AliDebug (1, Form(" The maximum peak in ToT = %f", maxToTDistr));
 455
 456   // Loop on TOF Digits
 457
 458   Bool_t isToTSimulated=kFALSE;
 459   Bool_t misCalibPars=kFALSE;
 460   if(hToT->GetEntries()>0)isToTSimulated=kTRUE;
 461   Int_t ndigits = fDigits->GetEntriesFast();
 462   for (Int_t i=0;i<ndigits;i++){
 463     AliTOFdigit * dig = (AliTOFdigit*)fDigits->At(i);
 464     Int_t detId[5];
 465     detId[0] = dig->GetSector();
 466     detId[1] = dig->GetPlate();
 467     detId[2] = dig->GetStrip();
 468     detId[3] = dig->GetPadz();
 469     detId[4] = dig->GetPadx();
 470     dig->SetTdcND(dig->GetTdc()); // save the non decalibrated time
 471     if(isToTSimulated){
 472
 473       //A realistic ToT Spectrum was found in input,
 474       //decalibrated TOF Digits likely to be simulated....
 475
 476       Int_t index = AliTOFGeometry::GetIndex(detId); // The channel index
 477       AliTOFChannelOnline *calChannelOnline = (AliTOFChannelOnline *)calOnline->At(index); //retrieve the info for time delay
 478       AliTOFChannelOffline *calChannelOffline = (AliTOFChannelOffline *)calOffline->At(index); //retrieve the info for time slewing
 479       Double_t timedelay = (Double_t)calChannelOnline->GetDelay(); //The global channel delay, ns
 480       Double_t par[6];  // time slewing parameters
 481
 482       //check whether we actually ask for miscalibration
 483
 484       if(timedelay!=0)misCalibPars=kTRUE;
 485       for (Int_t j = 0; j<6; j++){
 486         par[j]=(Double_t)calChannelOffline->GetSlewPar(j);
 487         if(par[j]!=0)misCalibPars=kTRUE;
 488       }
 489       AliDebug(2,Form(" Calib Pars = %f, %f, %f, %f, %f, %f ",par[0],par[1],par[2],par[3],par[4],par[5]));
 490       // Now generate Realistic ToT distribution from TestBeam Data.
 491       // Tot is in ns, assuming a Matching Window of 10 ns.
 492
 493       Float_t simToT = 0;
 494       Float_t trix = 0;
 495       Float_t triy = 0;
 496       Double_t timeCorr;
 497       Double_t tToT;
 498       while (simToT <= triy){
 499         trix = gRandom->Rndm(i);
 500         triy = gRandom->Rndm(i);
 501         trix = (maxToT-minToT)*trix + minToT;
 502         triy = maxToTDistr*triy;
 503         Int_t binx=hToT->FindBin(trix);
 504         simToT=hToT->GetBinContent(binx);
 505       }
 506       // the generated ToT (ns)
 507       tToT= (Double_t) trix; // to apply slewing we start from ns..
 508       // transform TOF signal in ns
 509       AliDebug(2,Form(" The Initial Time (counts): %i: ",dig->GetTdc()));
 510       AliDebug(2,Form(" Time before miscalibration (ps) %e: ",dig->GetTdc()*(Double_t)AliTOFGeometry::TdcBinWidth()));
 511       // add slewing effect
 512       timeCorr=par[0] + tToT*(par[1] +tToT*(par[2] +tToT*(par[3] +tToT*(par[4] +tToT*par[5]))));
 513       AliDebug(2,Form(" The Time slewing (ns): %f: ",timeCorr));
 514       AliDebug(2,Form(" The Time delay (ns): %f: ",timedelay));
 515       // add global time shift
 516       timeCorr = timeCorr + timedelay;
 517       AliDebug(2,Form(" The Time Slewing + delay (ns): %f: ",timeCorr));
 518       //convert to ps
 519       timeCorr*=1E3;
 520       Double_t timeMis = (Double_t)(dig->GetTdc())*(Double_t)AliTOFGeometry::TdcBinWidth();
 521       timeMis = timeMis+timeCorr;
 522       AliDebug(2,Form(" The Miscalibrated time (ps): %e: ",timeMis));
 523
 524       // now update the digit info
 525
 526       Int_t tdcCorr= (Int_t)(timeMis/AliTOFGeometry::TdcBinWidth());
 527       AliDebug(2,Form(" Final Time (counts): %i: ",tdcCorr));
 528       // Setting Decalibrated Time signal (TDC counts)
 529       dig->SetTdc(tdcCorr);
 530       // Setting realistic ToT signal (TDC counts)
 531       tToT*=1E3; //back to ps
 532       Int_t tot=(Int_t)(tToT/AliTOFGeometry::ToTBinWidth());//(factor 1E3 as input ToT is in ns)
 533       dig->SetToT(tot);
 534       AliDebug(2,Form(" Final Time and ToT (counts): %i: , %i:",dig->GetTdc(),dig->GetToT()));
 535       if(tdcCorr<0){
 536         AliWarning (Form(" The bad Slewed Time(TDC counts)= %i ", tdcCorr));
 537         AliWarning(Form(" The bad ToT (TDC counts)= %i ", tot));
 538       }
 539     }
 540     else{
 541     // For Data with no Miscalibration, set ToT signal == Adc
 542       dig->SetToT((Int_t)(dig->GetAdc()/AliTOFGeometry::ToTBinWidth())); //remove the factor 10^3 just to have a reasonable ToT range for raw data simulation even in the case of non-realistic ToT distribution (n.b. fAdc is practically an arbitrary quantity, and ToT has no impact on the TOF reco for non-miscalibrated digits)
 543     }
 544   }
 545
 546   if(!isToTSimulated){
 547     AliDebug(1,"Standard Production, no miscalibrated digits");
 548   }else{
 549     if(!misCalibPars){
 550     AliDebug(1,"Standard Production, no miscalibrated digits");
 551     }
 552     else {
 553       AliDebug(1,"Simulating miscalibrated digits");
 554     }
 555   }
 556   return;
 557 }
 558