PHOS/AliPHOSPreprocessor.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, 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 /* $Id$ */
  17
  18 ///////////////////////////////////////////////////////////////////////////////
  19 // PHOS Preprocessor class. It runs by Shuttle at the end of the run,
  20 // calculates calibration coefficients and dead/bad channels
  21 // to be posted in OCDB
  22 //
  23 // Author: Boris Polichtchouk, 4 October 2006
  24 ///////////////////////////////////////////////////////////////////////////////
  25
  26 #include "AliPHOSPreprocessor.h"
  27 #include "AliLog.h"
  28 #include "AliCDBMetaData.h"
  29 #include "AliCDBEntry.h"
  30 #include "AliPHOSEmcCalibData.h"
  31 #include "TFile.h"
  32 #include "TH1.h"
  33 #include "TF1.h"
  34 #include "TH2.h"
  35 #include "TMap.h"
  36 #include "TRandom.h"
  37 #include "TKey.h"
  38 #include "TList.h"
  39 #include "TObjString.h"
  40 #include "TObjArray.h"
  41 #include "TObject.h"
  42 #include "TString.h"
  43 #include "TMath.h"
  44 #include "TAxis.h"
  45 #include "AliPHOSEmcBadChannelsMap.h"
  46
  47 ClassImp(AliPHOSPreprocessor)
  48
  49   Double_t rgaus(Double_t *x, Double_t *par)
  50 {
  51   Double_t gaus = par[0] * TMath::Exp( -(x[0]-par[1])*(x[0]-par[1]) /
  52                                        (2*par[2]*par[2]) );
  53   return gaus;
  54 }
  55
  56 //_______________________________________________________________________________________
  57 AliPHOSPreprocessor::AliPHOSPreprocessor() :
  58 AliPreprocessor("PHS",0)
  59 {
  60   //default constructor
  61 }
  62
  63 //_______________________________________________________________________________________
  64 AliPHOSPreprocessor::AliPHOSPreprocessor(AliShuttleInterface* shuttle):
  65 AliPreprocessor("PHS",shuttle)
  66 {
  67   // Constructor
  68
  69   AddRunType("PHYSICS");
  70   AddRunType("LED");
  71 }
  72
  73 //_______________________________________________________________________________________
  74 UInt_t AliPHOSPreprocessor::Process(TMap* /*valueSet*/)
  75 {
  76   // process data retrieved by the Shuttle
  77
  78   TString runType = GetRunType();
  79   Log(Form("Run type: %s",runType.Data()));
  80
  81   if(runType=="LED") {
  82     Bool_t ledOK = ProcessLEDRun();
  83     Bool_t badmap_OK = FindBadChannelsEmc();
  84     if(!badmap_OK) Log(Form("WARNING! FindBadChannels() completed with BAD status!"));
  85     if(ledOK) return 0;
  86     else
  87       return 1;
  88   }
  89
  90   if(runType=="PHYSICS") {
  91
  92     Bool_t calibEmc_OK = CalibrateEmc();
  93
  94     if(calibEmc_OK) return 0;
  95     else
  96       return 1;
  97   }
  98
  99   Log(Form("Unknown run type %s. Do nothing and return OK.",runType.Data()));
 100   return 0;
 101
 102 }
 103
 104
 105 Bool_t AliPHOSPreprocessor::ProcessLEDRun()
 106 {
 107   //Process LED run, update High Gain/Low Gain ratios.
 108
 109   AliPHOSEmcCalibData calibData;
 110
 111   TList* list = GetFileSources(kDAQ, "LED");
 112   if(!list) {
 113     Log("Sources list for LED run not found, exit.");
 114     return kFALSE;
 115   }
 116
 117   if(!list->GetEntries()) {
 118     Log("Sources list for LED run is empty, exit.");
 119     return kFALSE;
 120   }
 121
 122   //Retrieve the last EMC calibration object
 123   const AliPHOSEmcCalibData* clb=0;
 124   AliCDBEntry* entryCalib = GetFromOCDB("Calib", "EmcGainPedestals");
 125
 126   if(!entryCalib)
 127     Log(Form("Cannot find any AliCDBEntry for [Calib, EmcGainPedestals]!"));
 128   else
 129     clb = (AliPHOSEmcCalibData*)entryCalib->GetObject();
 130
 131   TIter iter(list);
 132   TObjString *source;
 133   Bool_t firedOK = kFALSE;
 134
 135   while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
 136
 137     AliInfo(Form("found source %s", source->String().Data()));
 138
 139     TString fileName = GetFile(kDAQ, "LED", source->GetName());
 140     AliInfo(Form("Got filename: %s",fileName.Data()));
 141
 142     TFile f(fileName);
 143
 144     if(!f.IsOpen()) {
 145       Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
 146       return kFALSE;
 147     }
 148
 149     TH1I* fFiredCells = (TH1I*)f.Get("fFiredCells");
 150
 151     if(!fFiredCells) {
 152       Log(Form("fFiredCells histogram not found in %s, skip this source.",fileName.Data()));
 153       firedOK=kFALSE;
 154     }
 155     else {
 156       const Double_t nFiredCells = fFiredCells->GetMean();
 157       if(nFiredCells>100 && nFiredCells<600) {
 158         firedOK = kTRUE;
 159         Log(Form("Number of fired cells per event is %d.",nFiredCells));
 160       }
 161       else {
 162         Log(Form("Number of fired cells per event is %d, possibly not a LED run!",nFiredCells));
 163         firedOK = kFALSE;
 164       }
 165
 166     }
 167
 168     const Int_t nMod=5; // 1:5 modules
 169     const Int_t nCol=56; //1:56 columns in each module
 170     const Int_t nRow=64; //1:64 rows in each module
 171
 172     for(Int_t mod=0; mod<nMod; mod++) {
 173       for(Int_t col=0; col<nCol; col++) {
 174         for(Int_t row=0; row<nRow; row++) {
 175
 176           //High Gain to Low Gain ratio
 177           if(firedOK) {
 178             Float_t ratio = HG2LG(mod,row,col,&f);
 179             calibData.SetHighLowRatioEmc(mod+1,col+1,row+1,ratio);
 180             if(ratio != 16.)
 181               AliInfo(Form("mod %d iX %d iZ %d  ratio %.3f\n",mod,row,col,ratio));
 182           }
 183
 184           if(clb) {
 185             Double_t coeff = clb->GetADCchannelEmc(mod+1,col+1,row+1);
 186             calibData.SetADCchannelEmc(mod+1,col+1,row+1,coeff);
 187           }
 188           else
 189             calibData.SetADCchannelEmc(mod+1,col+1,row+1,1.);
 190
 191         }
 192       }
 193     }
 194
 195   } // end of loop over files
 196
 197   //Store the updated High Gain/Low Gain ratios
 198   AliCDBMetaData emcMetaData;
 199
 200   //Data valid from current run fRun until updated (validityInfinite=kTRUE)
 201   Bool_t result = Store("Calib","EmcGainPedestals",&calibData,&emcMetaData,fRun,kTRUE);
 202   return result;
 203
 204 }
 205
 206 Float_t AliPHOSPreprocessor::HG2LG(Int_t mod, Int_t X, Int_t Z, TFile* f)
 207 {
 208   //Calculates High gain to Low gain ratio
 209   //for crystal at the position (X,Z) in the PHOS module mod.
 210
 211   char hname[128];
 212   sprintf(hname,"%d_%d_%d",mod,X,Z);
 213
 214   TH1F* h1 = (TH1F*)f->Get(hname);
 215   if(!h1) return 16.;
 216
 217   if(!h1->GetEntries()) return 16.;
 218
 219   h1->Rebin(4);
 220   if(h1->GetMaximum()<10.) return 16.;
 221
 222   Double_t max = h1->GetBinCenter(h1->GetMaximumBin()); // peak
 223   Double_t xmin = max - (h1->GetRMS()/3);
 224   Double_t xmax = max + (h1->GetRMS()/2);
 225   //       Double_t xmin = max - (h1->GetRMS());
 226   //       Double_t xmax = max + (h1->GetRMS());
 227
 228   TF1* gaus1 = new TF1("gaus1",rgaus,xmin,xmax,3);
 229   gaus1->SetParNames("Constant","Mean","Sigma");
 230   gaus1->SetParameter("Constant",h1->GetMaximum());
 231   gaus1->SetParameter("Mean",max);
 232   gaus1->SetParameter("Sigma",1.);
 233   gaus1->SetLineColor(kBlue);
 234   h1->Fit(gaus1,"LERQ+");
 235
 236   AliInfo(Form("%s: %d entries, mean=%.3f, peak=%.3f, rms= %.3f. HG/LG = %.3f\n",
 237            h1->GetTitle(),h1->GetEntries(),h1->GetMean(),max,h1->GetRMS(),
 238            gaus1->GetParameter("Mean")));
 239
 240   return gaus1->GetParameter("Mean");
 241
 242 }
 243
 244 Bool_t AliPHOSPreprocessor::FindBadChannelsEmc()
 245 {
 246   //Loop over two systems: DAQ and HLT.
 247   //For each system the same algorithm implemented in DoFindBadChannelsEmc() invokes.
 248
 249   TList* list=0;
 250   TString path;
 251
 252   Int_t system[2] = { kDAQ, kHLT };
 253   const char* sysn[] = { "DAQ","HLT" };
 254   Bool_t result[2] = { kTRUE, kTRUE };
 255
 256   for (Int_t i=0; i<2; i++) {
 257
 258     AliPHOSEmcBadChannelsMap badMap;
 259     list = GetFileSources(system[i], "BAD_CHANNELS");
 260
 261     if(!list) {
 262       Log(Form("%s sources list for BAD_CHANNELS not found!",sysn[i]));
 263       result[i] = kFALSE;
 264       continue;
 265     }
 266
 267     if(!list->GetEntries()) {
 268       Log(Form("Got empty sources list. It seems %s DA2 did not produce any files!",sysn[i]));
 269       result[i] = kFALSE;
 270       continue;
 271     }
 272
 273     result[i] *= DoFindBadChannelsEmc(system[i],list,badMap);
 274
 275     // Store the bad channels map.
 276
 277     AliCDBMetaData md;
 278     md.SetResponsible("Boris Polishchuk");
 279
 280     if(system[i] == kDAQ)
 281       path = "Calib";
 282     else
 283       path = "HLT";
 284
 285     // Data valid from current run fRun until being updated (validityInfinite=kTRUE)
 286     result[i] *= Store(path.Data(), "EmcBadChannels", &badMap, &md, fRun, kTRUE);
 287
 288   }
 289
 290   if(result[0] || result[1]) return kTRUE;
 291   else return kFALSE;
 292 }
 293
 294 Bool_t AliPHOSPreprocessor::DoFindBadChannelsEmc(Int_t system, TList* list, AliPHOSEmcBadChannelsMap& badMap)
 295 {
 296   //Creates the bad channels map for PHOS EMC.
 297
 298   // The file fileName contains histograms which have been produced by DA2 detector algorithm.
 299   // It is a responsibility of the SHUTTLE framework to form the fileName.
 300
 301   TIter iter(list);
 302   TObjString *source;
 303   char hnam[80];
 304   TH1F* h1=0;
 305
 306   const Float_t fQualityCut = 1.;
 307   Int_t nGoods[5] = {0,0,0,0,0};
 308
 309   while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
 310
 311     AliInfo(Form("found source %s", source->String().Data()));
 312
 313     TString fileName = GetFile(system, "BAD_CHANNELS", source->GetName());
 314     AliInfo(Form("Got filename: %s",fileName.Data()));
 315
 316     TFile f(fileName);
 317
 318     if(!f.IsOpen()) {
 319       Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
 320       return kFALSE;
 321     }
 322
 323     TH1I* fFiredCells = (TH1I*)f.Get("fFiredCells");
 324
 325     if(!fFiredCells) {
 326       Log(Form("fFiredCells histogram not found in %s, skip this source.",fileName.Data()));
 327       continue;
 328     }
 329
 330     const Double_t nFiredCells = fFiredCells->GetMean();
 331
 332     if(nFiredCells<100. || nFiredCells>600. ) {
 333       Log(Form("Number of fired cells per event is %d, possibly not a LED run!",nFiredCells));
 334       continue; // not a LED run!
 335     }
 336
 337     Log(Form("Number of fired cells per event %d. Begin check for bad channels.",nFiredCells));
 338
 339     for(Int_t mod=0; mod<5; mod++) {
 340       for(Int_t iX=0; iX<64; iX++) {
 341         for(Int_t iZ=0; iZ<56; iZ++) {
 342
 343           sprintf(hnam,"%d_%d_%d_%d",mod,iX,iZ,1); // high gain
 344           h1 = (TH1F*)f.Get(hnam);
 345
 346           if(h1) {
 347             Double_t mean = h1->GetMean();
 348
 349             if(mean)
 350               Log(Form("iX=%d iZ=%d gain=%d   mean=%.3f\n",iX,iZ,1,mean));
 351
 352             if( mean>0 && mean<fQualityCut ) {
 353               nGoods[mod]++;
 354             }
 355             else
 356               badMap.SetBadChannel(mod+1,iZ+1,iX+1); //module, col,row
 357           }
 358
 359         }
 360       }
 361
 362       if(nGoods[mod])
 363         Log(Form("Module %d: %d good channels.",mod,nGoods[mod]));
 364     }
 365
 366
 367   } // end of loop over sources
 368
 369   return kTRUE;
 370 }
 371
 372 Bool_t AliPHOSPreprocessor::CalibrateEmc()
 373 {
 374   //Loop over two systems: DAQ and HLT.
 375   //For each system the same algorithm implemented in DoCalibrateEmc() invokes.
 376
 377   const AliPHOSEmcBadChannelsMap* badMap=0;
 378   AliCDBEntry* entryBCM=0;
 379   TList* list=0;
 380   TString path;
 381
 382   Int_t system[2] = { kDAQ, kHLT };
 383   const char* sysn[] = { "DAQ","HLT" };
 384   Bool_t result[2] = { kTRUE, kTRUE };
 385
 386   for (Int_t i=0; i<2; i++) {
 387
 388     AliPHOSEmcCalibData calibData;
 389     list = GetFileSources(system[i], "AMPLITUDES");
 390
 391     if(!list) {
 392       Log(Form("%s sources list not found!",sysn[i]));
 393       result[i] = kFALSE;
 394       continue;
 395     }
 396
 397     if(!list->GetEntries()) {
 398       Log(Form("Got empty sources list. It seems %s DA1 did not produce any files!",sysn[i]));
 399       result[i] = kFALSE;
 400       continue;
 401     }
 402
 403     // Retrieve the Bad Channels Map (BCM)
 404
 405     if(system[i] == kDAQ)
 406       path = "Calib";
 407     else
 408       path = "HLT";
 409
 410     entryBCM = GetFromOCDB(path.Data(), "EmcBadChannels");
 411
 412     if(!entryBCM)
 413       Log(Form("WARNING!! Cannot find any AliCDBEntry for [%s, EmcBadChannels]!",path.Data()));
 414     else
 415       badMap = (AliPHOSEmcBadChannelsMap*)entryBCM->GetObject();
 416
 417     if(!badMap)
 418       Log(Form("WARNING!! Nothing for %s in AliCDBEntry. All cells considered GOOD!",sysn[i]));
 419
 420     result[i] *= DoCalibrateEmc(system[i],list,badMap,calibData);
 421
 422     //Store EMC calibration data
 423
 424     AliCDBMetaData emcMetaData;
 425     result[i] *= Store(path.Data(), "EmcGainPedestals", &calibData, &emcMetaData, 0, kTRUE);
 426
 427   }
 428
 429   if(result[0] || result[1]) return kTRUE;
 430   else return kFALSE;
 431 }
 432
 433
 434 Bool_t AliPHOSPreprocessor::DoCalibrateEmc(Int_t system, TList* list, const AliPHOSEmcBadChannelsMap* badMap, AliPHOSEmcCalibData& calibData)
 435 {
 436   // Return kTRUE if OK.
 437   // I.  Calculates the set of calibration coefficients to equalyze the mean energies deposited at high gain.
 438   // II. Extracts High_Gain/Low_Gain ratio for each channel.
 439
 440   // The file fileName contains histograms which have been produced by DA1 detector algorithm.
 441   // It is a responsibility of the SHUTTLE framework to form the fileName.
 442
 443   gRandom->SetSeed(0); //the seed is set to the current  machine clock!
 444
 445   TIter iter(list);
 446   TObjString *source;
 447
 448   while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
 449     AliInfo(Form("found source %s", source->String().Data()));
 450
 451     TString fileName = GetFile(system, "AMPLITUDES", source->GetName());
 452     AliInfo(Form("Got filename: %s",fileName.Data()));
 453
 454     TFile f(fileName);
 455
 456     if(!f.IsOpen()) {
 457       Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
 458       return kFALSE;
 459     }
 460
 461     const Int_t nMod=5; // 1:5 modules
 462     const Int_t nCol=56; //1:56 columns in each module
 463     const Int_t nRow=64; //1:64 rows in each module
 464
 465     Double_t coeff;
 466     char hnam[80];
 467     TH2F* h2=0;
 468     TH1D* h1=0;
 469
 470     //Get the reference histogram
 471     //(author: Gustavo Conesa Balbastre)
 472
 473     TList * keylist = f.GetListOfKeys();
 474     Int_t nkeys   = f.GetNkeys();
 475     Bool_t ok = kFALSE;
 476     TKey  *key;
 477     Int_t ikey = 0;
 478     Int_t counter = 0;
 479     TH1D* hRef = 0;
 480
 481     //Check if the file contains any histogram
 482
 483     if(nkeys< 2){
 484       Log(Form("Not enough histograms (%d) for calibration.",nkeys));
 485       return 1; // it's not fatal! May be short run..
 486     }
 487
 488     while(!ok){
 489       ikey = gRandom->Integer(nkeys);
 490       key = (TKey*)keylist->At(ikey);
 491       TObject* obj = f.Get(key->GetName());
 492       TString cname(obj->ClassName());
 493       if(cname == "TH2F") {
 494         h2 = (TH2F*)obj;
 495         TString htitl = h2->GetTitle();
 496         if(htitl.Contains("and gain 1")) {
 497           hRef = h2->ProjectionX();
 498           hRef->GetXaxis()->SetRange(10,1000); // to cut off saturation peak and noise
 499           // Check if the reference histogram has too little statistics
 500           if(hRef->GetMean() && hRef->GetEntries()>2) ok=kTRUE;
 501
 502           const TString delim = "_";
 503           TString str = hRef->GetName();
 504           TObjArray* tks = str.Tokenize(delim);
 505           const Int_t md = ((TObjString*)tks->At(0))->GetString().Atoi();
 506           const Int_t X   = ((TObjString*)tks->At(1))->GetString().Atoi();
 507           const Int_t Z   = ((TObjString*)tks->At(2))->GetString().Atoi();
 508
 509           if(badMap) {
 510             if(badMap->IsBadChannel(md+1,Z+1,X+1)) {
 511               AliInfo(Form("Cell mod=%d col=%d row=%d is bad. Histogram %s rejected.",
 512                            md+1,Z+1,X+1,hRef->GetName()));
 513               ok=kFALSE;
 514             }
 515           }
 516
 517         }
 518       }
 519
 520       counter++;
 521
 522       if(!ok && counter > nkeys){
 523         Log("No histogram with enough statistics for reference. Exit.");
 524         return 1; // Not fatal, just wait..
 525       }
 526     }
 527
 528     Log(Form("reference histogram %s, %.1f entries, mean=%.3f, rms=%.3f.",
 529              hRef->GetName(),hRef->GetEntries(),
 530              hRef->GetMean(),hRef->GetRMS()));
 531
 532     Double_t refMean=hRef->GetMean();
 533
 534     // Calculates relative calibration coefficients for all non-zero channels
 535
 536     for(Int_t mod=0; mod<nMod; mod++) {
 537       for(Int_t col=0; col<nCol; col++) {
 538         for(Int_t row=0; row<nRow; row++) {
 539
 540           sprintf(hnam,"%d_%d_%d_1",mod,row,col); // high gain!
 541           h2 = (TH2F*)f.Get(hnam);
 542
 543           //TODO: dead channels exclusion!
 544           if(h2) {
 545             h1 = h2->ProjectionX();
 546             h1->GetXaxis()->SetRange(10,1000); //to cut off saturation peak and noise
 547             coeff = h1->GetMean()/refMean;
 548             if(coeff>0)
 549               calibData.SetADCchannelEmc(mod+1,col+1,row+1,1./coeff);
 550             else
 551               calibData.SetADCchannelEmc(mod+1,col+1,row+1,1.);
 552             AliInfo(Form("mod %d col %d row %d  coeff %f\n",mod,col,row,coeff));
 553           }
 554           else
 555             calibData.SetADCchannelEmc(mod+1,col+1,row+1,1.);
 556         }
 557       }
 558     }
 559
 560     f.Close();
 561   }
 562
 563   return 1;
 564 }
 565
 566
 567