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