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