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 %.1f.",nFiredCells));
 160       }
 161       else {
 162         Log(Form("Number of fired cells per event is %.1f, 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,0.005);
 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   if(h1->GetMaximum()<10.) 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
 235   Double_t mean_min = h1->GetXaxis()->GetXmin();
 236   Double_t mean_max = h1->GetXaxis()->GetXmax();
 237   gaus1->SetParLimits(1,mean_min,mean_max);
 238
 239   h1->Fit(gaus1,"RQ+");
 240   Double_t hg2lg = gaus1->GetParameter("Mean");
 241   if( (hg2lg-mean_min<0.001) || (mean_max-hg2lg<0.001)) hg2lg=max;
 242
 243   AliInfo(Form("%s: %.1f entries, mean=%.3f, peak=%.3f, rms= %.3f. HG/LG = %.3f\n",
 244           h1->GetTitle(),h1->GetEntries(),h1->GetMean(),max,h1->GetRMS(),hg2lg));
 245
 246   return hg2lg;
 247
 248 }
 249
 250 Bool_t AliPHOSPreprocessor::FindBadChannelsEmc()
 251 {
 252   //Loop over two systems: DAQ and HLT.
 253   //For each system the same algorithm implemented in DoFindBadChannelsEmc() invokes.
 254
 255   TList* list=0;
 256   TString path;
 257
 258   Int_t system[2] = { kDAQ, kHLT };
 259   const char* sysn[] = { "DAQ","HLT" };
 260   Bool_t result[2] = { kTRUE, kTRUE };
 261
 262   for (Int_t i=0; i<2; i++) {
 263
 264     AliPHOSEmcBadChannelsMap badMap;
 265     list = GetFileSources(system[i], "BAD_CHANNELS");
 266
 267     if(!list) {
 268       Log(Form("%s sources list for BAD_CHANNELS not found!",sysn[i]));
 269       result[i] = kFALSE;
 270       continue;
 271     }
 272
 273     if(!list->GetEntries()) {
 274       Log(Form("Got empty sources list. It seems %s DA2 did not produce any files!",sysn[i]));
 275       result[i] = kFALSE;
 276       continue;
 277     }
 278
 279     result[i] *= DoFindBadChannelsEmc(system[i],list,badMap);
 280
 281     // Store the bad channels map.
 282
 283     AliCDBMetaData md;
 284     md.SetResponsible("Boris Polishchuk");
 285
 286     if(system[i] == kDAQ)
 287       path = "Calib";
 288     else
 289       path = "HLT";
 290
 291     // Data valid from current run fRun until being updated (validityInfinite=kTRUE)
 292     result[i] *= Store(path.Data(), "EmcBadChannels", &badMap, &md, fRun, kTRUE);
 293
 294   }
 295
 296   if(result[0] || result[1]) return kTRUE;
 297   else return kFALSE;
 298 }
 299
 300 Bool_t AliPHOSPreprocessor::DoFindBadChannelsEmc(Int_t system, TList* list, AliPHOSEmcBadChannelsMap& badMap)
 301 {
 302   //Creates the bad channels map for PHOS EMC.
 303
 304   // The file fileName contains histograms which have been produced by DA2 detector algorithm.
 305   // It is a responsibility of the SHUTTLE framework to form the fileName.
 306
 307   TIter iter(list);
 308   TObjString *source;
 309   char hnam[80];
 310   TH1F* h1=0;
 311
 312   const Float_t fQualityCut = 1.;
 313   Int_t nGoods[5] = {0,0,0,0,0};
 314
 315   while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
 316
 317     AliInfo(Form("found source %s", source->String().Data()));
 318
 319     TString fileName = GetFile(system, "BAD_CHANNELS", source->GetName());
 320     AliInfo(Form("Got filename: %s",fileName.Data()));
 321
 322     TFile f(fileName);
 323
 324     if(!f.IsOpen()) {
 325       Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
 326       return kFALSE;
 327     }
 328
 329     TH1I* fFiredCells = (TH1I*)f.Get("fFiredCells");
 330
 331     if(!fFiredCells) {
 332       Log(Form("fFiredCells histogram not found in %s, skip this source.",fileName.Data()));
 333       continue;
 334     }
 335
 336     const Double_t nFiredCells = fFiredCells->GetMean();
 337
 338     if(nFiredCells<100. || nFiredCells>600. ) {
 339       Log(Form("Number of fired cells per event is %.1f, possibly not a LED run!",nFiredCells));
 340       continue; // not a LED run!
 341     }
 342
 343     Log(Form("Number of fired cells per event %.1f. Begin check for bad channels.",nFiredCells));
 344
 345     for(Int_t mod=0; mod<5; mod++) {
 346       for(Int_t iX=0; iX<64; iX++) {
 347         for(Int_t iZ=0; iZ<56; iZ++) {
 348
 349           sprintf(hnam,"%d_%d_%d_%d",mod,iX,iZ,1); // high gain
 350           h1 = (TH1F*)f.Get(hnam);
 351
 352           if(h1) {
 353             Double_t mean = h1->GetMean();
 354
 355             if(mean)
 356               Log(Form("iX=%d iZ=%d gain=%d   mean=%.3f\n",iX,iZ,1,mean));
 357
 358             if( mean>0 && mean<fQualityCut ) {
 359               nGoods[mod]++;
 360             }
 361             else
 362               badMap.SetBadChannel(mod+1,iZ+1,iX+1); //module, col,row
 363           }
 364
 365         }
 366       }
 367
 368       if(nGoods[mod])
 369         Log(Form("Module %d: %d good channels.",mod,nGoods[mod]));
 370     }
 371
 372
 373   } // end of loop over sources
 374
 375   return kTRUE;
 376 }
 377
 378 Bool_t AliPHOSPreprocessor::CalibrateEmc()
 379 {
 380   //Loop over two systems: DAQ and HLT.
 381   //For each system the same algorithm implemented in DoCalibrateEmc() invokes.
 382
 383   const AliPHOSEmcBadChannelsMap* badMap=0;
 384   AliCDBEntry* entryBCM=0;
 385   TList* list=0;
 386   TString path;
 387
 388   Int_t system[2] = { kDAQ, kHLT };
 389   const char* sysn[] = { "DAQ","HLT" };
 390   Bool_t result[2] = { kTRUE, kTRUE };
 391
 392   for (Int_t i=0; i<2; i++) {
 393
 394     AliPHOSEmcCalibData calibData;
 395     list = GetFileSources(system[i], "AMPLITUDES");
 396
 397     if(!list) {
 398       Log(Form("%s sources list not found!",sysn[i]));
 399       result[i] = kFALSE;
 400       continue;
 401     }
 402
 403     if(!list->GetEntries()) {
 404       Log(Form("Got empty sources list. It seems %s DA1 did not produce any files!",sysn[i]));
 405       result[i] = kFALSE;
 406       continue;
 407     }
 408
 409     // Retrieve the Bad Channels Map (BCM)
 410
 411     if(system[i] == kDAQ)
 412       path = "Calib";
 413     else
 414       path = "HLT";
 415
 416     entryBCM = GetFromOCDB(path.Data(), "EmcBadChannels");
 417
 418     if(!entryBCM)
 419       Log(Form("WARNING!! Cannot find any AliCDBEntry for [%s, EmcBadChannels]!",path.Data()));
 420     else
 421       badMap = (AliPHOSEmcBadChannelsMap*)entryBCM->GetObject();
 422
 423     if(!badMap)
 424       Log(Form("WARNING!! Nothing for %s in AliCDBEntry. All cells considered GOOD!",sysn[i]));
 425
 426     result[i] *= DoCalibrateEmc(system[i],list,badMap,calibData);
 427
 428     //Store EMC calibration data
 429
 430     AliCDBMetaData emcMetaData;
 431     result[i] *= Store(path.Data(), "EmcGainPedestals", &calibData, &emcMetaData, 0, kTRUE);
 432
 433   }
 434
 435   if(result[0] || result[1]) return kTRUE;
 436   else return kFALSE;
 437 }
 438
 439
 440 Bool_t AliPHOSPreprocessor::DoCalibrateEmc(Int_t system, TList* list, const AliPHOSEmcBadChannelsMap* badMap, AliPHOSEmcCalibData& calibData)
 441 {
 442   // Return kTRUE if OK.
 443   // I.  Calculates the set of calibration coefficients to equalyze the mean energies deposited at high gain.
 444   // II. Extracts High_Gain/Low_Gain ratio for each channel.
 445
 446   // The file fileName contains histograms which have been produced by DA1 detector algorithm.
 447   // It is a responsibility of the SHUTTLE framework to form the fileName.
 448
 449   gRandom->SetSeed(0); //the seed is set to the current  machine clock!
 450
 451   TIter iter(list);
 452   TObjString *source;
 453
 454   while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
 455     AliInfo(Form("found source %s", source->String().Data()));
 456
 457     TString fileName = GetFile(system, "AMPLITUDES", source->GetName());
 458     AliInfo(Form("Got filename: %s",fileName.Data()));
 459
 460     TFile f(fileName);
 461
 462     if(!f.IsOpen()) {
 463       Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
 464       return kFALSE;
 465     }
 466
 467     const Int_t nMod=5; // 1:5 modules
 468     const Int_t nCol=56; //1:56 columns in each module
 469     const Int_t nRow=64; //1:64 rows in each module
 470
 471     Double_t coeff;
 472     char hnam[80];
 473     TH2F* h2=0;
 474     TH1D* h1=0;
 475
 476     //Get the reference histogram
 477     //(author: Gustavo Conesa Balbastre)
 478
 479     TList * keylist = f.GetListOfKeys();
 480     Int_t nkeys   = f.GetNkeys();
 481     Bool_t ok = kFALSE;
 482     TKey  *key;
 483     Int_t ikey = 0;
 484     Int_t counter = 0;
 485     TH1D* hRef = 0;
 486
 487     //Check if the file contains any histogram
 488
 489     if(nkeys< 2){
 490       Log(Form("Not enough histograms (%d) for calibration.",nkeys));
 491       return 1; // it's not fatal! May be short run..
 492     }
 493
 494     while(!ok){
 495       ikey = gRandom->Integer(nkeys);
 496       key = (TKey*)keylist->At(ikey);
 497       TObject* obj = f.Get(key->GetName());
 498       TString cname(obj->ClassName());
 499       if(cname == "TH2F") {
 500         h2 = (TH2F*)obj;
 501         TString htitl = h2->GetTitle();
 502         if(htitl.Contains("and gain 1")) {
 503           hRef = h2->ProjectionX();
 504           hRef->GetXaxis()->SetRange(10,1000); // to cut off saturation peak and noise
 505           // Check if the reference histogram has too little statistics
 506           if(hRef->GetMean() && hRef->GetEntries()>2) ok=kTRUE;
 507
 508           const TString delim = "_";
 509           TString str = hRef->GetName();
 510           TObjArray* tks = str.Tokenize(delim);
 511           const Int_t md = ((TObjString*)tks->At(0))->GetString().Atoi();
 512           const Int_t X   = ((TObjString*)tks->At(1))->GetString().Atoi();
 513           const Int_t Z   = ((TObjString*)tks->At(2))->GetString().Atoi();
 514
 515           if(badMap) {
 516             if(badMap->IsBadChannel(md+1,Z+1,X+1)) {
 517               AliInfo(Form("Cell mod=%d col=%d row=%d is bad. Histogram %s rejected.",
 518                            md+1,Z+1,X+1,hRef->GetName()));
 519               ok=kFALSE;
 520             }
 521           }
 522
 523         }
 524       }
 525
 526       counter++;
 527
 528       if(!ok && counter > nkeys){
 529         Log("No histogram with enough statistics for reference. Exit.");
 530         return 1; // Not fatal, just wait..
 531       }
 532     }
 533
 534     Log(Form("reference histogram %s, %.1f entries, mean=%.3f, rms=%.3f.",
 535              hRef->GetName(),hRef->GetEntries(),
 536              hRef->GetMean(),hRef->GetRMS()));
 537
 538     Double_t refMean=hRef->GetMean();
 539
 540     // Calculates relative calibration coefficients for all non-zero channels
 541
 542     for(Int_t mod=0; mod<nMod; mod++) {
 543       for(Int_t col=0; col<nCol; col++) {
 544         for(Int_t row=0; row<nRow; row++) {
 545
 546           sprintf(hnam,"%d_%d_%d_1",mod,row,col); // high gain!
 547           h2 = (TH2F*)f.Get(hnam);
 548
 549           //TODO: dead channels exclusion!
 550           if(h2) {
 551             h1 = h2->ProjectionX();
 552             h1->GetXaxis()->SetRange(10,1000); //to cut off saturation peak and noise
 553             coeff = h1->GetMean()/refMean;
 554             if(coeff>0)
 555               calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005/coeff);
 556             else
 557               calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005);
 558             AliInfo(Form("mod %d col %d row %d  coeff %f\n",mod,col,row,coeff));
 559           }
 560           else
 561             calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005);
 562         }
 563       }
 564     }
 565
 566     f.Close();
 567   }
 568
 569   return 1;
 570 }
 571
 572
 573