1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
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
23 // Author: Boris Polichtchouk, 4 October 2006
24 ///////////////////////////////////////////////////////////////////////////////
26 #include "AliPHOSPreprocessor.h"
28 #include "AliCDBMetaData.h"
29 #include "AliCDBEntry.h"
30 #include "AliPHOSEmcCalibData.h"
39 #include "TObjString.h"
40 #include "TObjArray.h"
45 #include "AliPHOSEmcBadChannelsMap.h"
47 ClassImp(AliPHOSPreprocessor)
49 Double_t rgaus(Double_t *x, Double_t *par)
51 Double_t gaus = par[0] * TMath::Exp( -(x[0]-par[1])*(x[0]-par[1]) /
56 //_______________________________________________________________________________________
57 AliPHOSPreprocessor::AliPHOSPreprocessor() :
58 AliPreprocessor("PHS",0)
63 //_______________________________________________________________________________________
64 AliPHOSPreprocessor::AliPHOSPreprocessor(AliShuttleInterface* shuttle):
65 AliPreprocessor("PHS",shuttle)
69 AddRunType("PHYSICS");
73 //_______________________________________________________________________________________
74 UInt_t AliPHOSPreprocessor::Process(TMap* /*valueSet*/)
76 // process data retrieved by the Shuttle
78 TString runType = GetRunType();
79 Log(Form("Run type: %s",runType.Data()));
82 Bool_t ledOK = ProcessLEDRun();
83 Bool_t badmap_OK = FindBadChannelsEmc();
84 if(!badmap_OK) Log(Form("WARNING! FindBadChannels() completed with BAD status!"));
90 if(runType=="PHYSICS") {
92 Bool_t calibEmc_OK = CalibrateEmc();
94 if(calibEmc_OK) return 0;
99 Log(Form("Unknown run type %s. Do nothing and return OK.",runType.Data()));
105 Bool_t AliPHOSPreprocessor::ProcessLEDRun()
107 //Process LED run, update High Gain/Low Gain ratios.
109 AliPHOSEmcCalibData calibData;
111 TList* list = GetFileSources(kDAQ, "LED");
113 Log("Sources list for LED run not found, exit.");
117 if(!list->GetEntries()) {
118 Log("Sources list for LED run is empty, exit.");
122 //Retrieve the last EMC calibration object
123 const AliPHOSEmcCalibData* clb=0;
124 AliCDBEntry* entryCalib = GetFromOCDB("Calib", "EmcGainPedestals");
127 Log(Form("Cannot find any AliCDBEntry for [Calib, EmcGainPedestals]!"));
129 clb = (AliPHOSEmcCalibData*)entryCalib->GetObject();
134 while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
136 AliInfo(Form("found source %s", source->String().Data()));
138 TString fileName = GetFile(kDAQ, "LED", source->GetName());
139 AliInfo(Form("Got filename: %s",fileName.Data()));
144 Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
148 TH1I* fFiredCells = (TH1I*)f.Get("fFiredCells");
151 const Double_t nFiredCells = fFiredCells->GetMean();
152 Log(Form("Number of fired cells per event is %.1f",nFiredCells));
155 const Int_t nMod=5; // 1:5 modules
156 const Int_t nCol=56; //1:56 columns in each module
157 const Int_t nRow=64; //1:64 rows in each module
159 for(Int_t mod=0; mod<nMod; mod++) {
160 for(Int_t col=0; col<nCol; col++) {
161 for(Int_t row=0; row<nRow; row++) {
164 Float_t hg2lg = clb->GetHighLowRatioEmc(5-mod,col+1,row+1);
165 Double_t coeff = clb->GetADCchannelEmc(5-mod,col+1,row+1);
166 calibData.SetADCchannelEmc(5-mod,col+1,row+1,coeff);
167 calibData.SetHighLowRatioEmc(5-mod,col+1,row+1,hg2lg);
170 //High Gain to Low Gain ratio
171 Float_t ratio = HG2LG(mod,row,col,&f);
173 calibData.SetHighLowRatioEmc(5-mod,col+1,row+1,ratio);
174 AliInfo(Form("mod %d iX %d iZ %d ratio %.3f\n",mod,row,col,ratio));
180 } // end of loop over files
182 //Store the updated High Gain/Low Gain ratios
183 AliCDBMetaData emcMetaData;
185 //Data valid from current run until updated (validityInfinite=kTRUE)
186 //Bool_t result = Store("Calib","EmcGainPedestals",&calibData,&emcMetaData,0,kTRUE);
188 //Store reference data
189 Bool_t refOK = StoreReferenceLED(list);
190 if(refOK) Log(Form("LED reference data successfully stored."));
196 Float_t AliPHOSPreprocessor::HG2LG(Int_t mod, Int_t X, Int_t Z, TFile* f)
198 //Calculates High gain to Low gain ratio
199 //for crystal at the position (X,Z) in the PHOS module mod.
202 sprintf(hname,"%d_%d_%d",mod,X,Z);
204 TH1F* h1 = (TH1F*)f->Get(hname);
207 if(h1->GetEntries()<2000.) return 16.;
209 if(h1->GetMaximum()<10.) h1->Rebin(4);
210 if(h1->GetMaximum()<10.) return 16.;
212 Double_t max = h1->GetBinCenter(h1->GetMaximumBin()); // peak
213 Double_t xmin = max - (h1->GetRMS()/3);
214 Double_t xmax = max + (h1->GetRMS()/2);
215 // Double_t xmin = max - (h1->GetRMS());
216 // Double_t xmax = max + (h1->GetRMS());
218 TF1* gaus1 = new TF1("gaus1",rgaus,xmin,xmax,3);
219 gaus1->SetParNames("Constant","Mean","Sigma");
220 gaus1->SetParameter("Constant",h1->GetMaximum());
221 gaus1->SetParameter("Mean",max);
222 gaus1->SetParameter("Sigma",1.);
223 gaus1->SetLineColor(kBlue);
225 Double_t mean_min = h1->GetXaxis()->GetXmin();
226 Double_t mean_max = h1->GetXaxis()->GetXmax();
227 gaus1->SetParLimits(1,mean_min,mean_max);
229 h1->Fit(gaus1,"RQ+");
230 Double_t hg2lg = gaus1->GetParameter("Mean");
231 if( (hg2lg-mean_min<0.001) || (mean_max-hg2lg<0.001)) hg2lg=max;
233 AliInfo(Form("%s: %.1f entries, mean=%.3f, peak=%.3f, rms= %.3f. HG/LG = %.3f\n",
234 h1->GetTitle(),h1->GetEntries(),h1->GetMean(),max,h1->GetRMS(),hg2lg));
240 Bool_t AliPHOSPreprocessor::FindBadChannelsEmc()
242 //Loop over two systems: DAQ and HLT.
243 //For each system the same algorithm implemented in DoFindBadChannelsEmc() invokes.
248 Int_t system[2] = { kDAQ, kHLT };
249 const char* sysn[] = { "DAQ","HLT" };
250 Bool_t result[2] = { kTRUE, kTRUE };
252 for (Int_t i=0; i<2; i++) {
254 if(system[i] == kHLT) continue;
256 AliPHOSEmcBadChannelsMap badMap;
257 list = GetFileSources(system[i], "BAD_CHANNELS");
260 Log(Form("%s sources list for BAD_CHANNELS not found!",sysn[i]));
265 if(!list->GetEntries()) {
266 Log(Form("Got empty sources list. It seems %s DA2 did not produce any files!",sysn[i]));
271 result[i] *= DoFindBadChannelsEmc(system[i],list,badMap);
273 // Store the bad channels map.
276 md.SetResponsible("Boris Polishchuk");
278 if(system[i] == kDAQ)
283 // Data valid from current run until being updated (validityInfinite=kTRUE)
284 result[i] *= Store(path.Data(), "EmcBadChannels", &badMap, &md, 0, kTRUE);
288 if(result[0] || result[1]) return kTRUE;
292 Bool_t AliPHOSPreprocessor::DoFindBadChannelsEmc(Int_t system, TList* list, AliPHOSEmcBadChannelsMap& badMap)
294 //Creates the bad channels map for PHOS EMC.
296 // The file fileName contains histograms which have been produced by DA2 detector algorithm.
297 // It is a responsibility of the SHUTTLE framework to form the fileName.
304 const Float_t fQualityCut = 1.;
305 Int_t nGoods[5] = {0,0,0,0,0};
307 while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
309 AliInfo(Form("found source %s", source->String().Data()));
311 TString fileName = GetFile(system, "BAD_CHANNELS", source->GetName());
312 AliInfo(Form("Got filename: %s",fileName.Data()));
317 Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
321 Log(Form("Begin check for bad channels."));
323 for(Int_t mod=0; mod<5; mod++) {
324 for(Int_t iX=0; iX<64; iX++) {
325 for(Int_t iZ=0; iZ<56; iZ++) {
327 sprintf(hnam,"%d_%d_%d_%d",mod,iX,iZ,1); // high gain
328 h1 = (TH1F*)f.Get(hnam);
331 Double_t mean = h1->GetMean();
334 Log(Form("iX=%d iZ=%d gain=%d mean=%.3f\n",iX,iZ,1,mean));
336 if( mean>0 && mean<fQualityCut ) {
340 badMap.SetBadChannel(mod+1,iZ+1,iX+1); //module, col,row
347 Log(Form("Module %d: %d good channels.",mod,nGoods[mod]));
351 } // end of loop over sources
356 Bool_t AliPHOSPreprocessor::CalibrateEmc()
358 //Loop over two systems: DAQ and HLT.
359 //For each system the same algorithm implemented in DoCalibrateEmc() invokes.
361 AliPHOSEmcCalibData* lastCalib=0;
362 const AliPHOSEmcBadChannelsMap* badMap=0;
363 AliCDBEntry* entryBCM=0;
364 AliCDBEntry* entryEmc=0;
368 Int_t system[2] = { kDAQ, kHLT };
369 const char* sysn[] = { "DAQ","HLT" };
370 Bool_t result[2] = { kTRUE, kTRUE };
372 for (Int_t i=0; i<2; i++) {
374 if(system[i] == kHLT) continue;
376 AliPHOSEmcCalibData calibData;
377 list = GetFileSources(system[i], "AMPLITUDES");
380 Log(Form("%s sources list not found!",sysn[i]));
385 if(!list->GetEntries()) {
386 Log(Form("Got empty sources list. It seems %s DA1 did not produce any files!",sysn[i]));
391 // Retrieve the Bad Channels Map (BCM)
393 if(system[i] == kDAQ)
398 entryBCM = GetFromOCDB(path.Data(), "EmcBadChannels");
401 Log(Form("WARNING!! Cannot find any AliCDBEntry for [%s, EmcBadChannels]!",path.Data()));
403 badMap = (AliPHOSEmcBadChannelsMap*)entryBCM->GetObject();
406 Log(Form("WARNING!! Nothing for %s in AliCDBEntry. All cells considered GOOD!",sysn[i]));
408 // Retrieve the last EMC calibration object
410 entryEmc = GetFromOCDB(path.Data(), "EmcGainPedestals");
413 Log(Form("Cannot find any EmcGainPedestals entry for this run and path %s",path.Data()));
415 lastCalib = (AliPHOSEmcCalibData*)entryEmc->GetObject();
418 result[i] *= DoCalibrateEmc(system[i],list,badMap,*lastCalib);
420 result[i] *= DoCalibrateEmc(system[i],list,badMap,calibData);
422 //Store EMC calibration data
423 AliCDBMetaData emcMetaData;
426 // result[i] *= Store(path.Data(), "EmcGainPedestals", lastCalib, &emcMetaData, 0, kFALSE);
428 // result[i] *= Store(path.Data(), "EmcGainPedestals", &calibData, &emcMetaData, 0, kFALSE);
430 //Store reference data
431 Bool_t refOK = StoreReferenceEmc(system[i],list);
432 if(refOK) Log(Form("Reference data for %s amplitudes successfully stored.",sysn[i]));
436 if(result[0] || result[1]) return kTRUE;
440 Bool_t AliPHOSPreprocessor::StoreReferenceEmc(Int_t system, TList* list)
442 //Put 2D calibration histograms (E vs Time) prepared by DAQ/HLT to the reference storage.
443 //system is DAQ or HLT, TList is the list of FES sources.
445 if(system!=kDAQ) return kFALSE;
447 TObjString *source = dynamic_cast<TObjString *> (list->First());
448 if(!source) return kFALSE;
450 TString fileName = GetFile(system, "AMPLITUDES", source->GetName());
452 Bool_t resultRef = StoreReferenceFile(fileName.Data(),"CalibRefPHOS.root");
457 Bool_t AliPHOSPreprocessor::StoreReferenceLED(TList* list)
459 //Put HG/LG histograms to the reference storage.
461 TObjString *source = dynamic_cast<TObjString *> (list->First());
462 if(!source) return kFALSE;
464 TString fileName = GetFile(kDAQ, "LED", source->GetName());
466 Bool_t resultRef = StoreReferenceFile(fileName.Data(),"LEDRefPHOS.root");
472 Bool_t AliPHOSPreprocessor::DoCalibrateEmc(Int_t system, TList* list, const AliPHOSEmcBadChannelsMap* badMap, AliPHOSEmcCalibData& calibData)
474 // Return kTRUE if OK.
475 // I. Calculates the set of calibration coefficients to equalyze the mean energies deposited at high gain.
476 // II. Extracts High_Gain/Low_Gain ratio for each channel.
478 // The file fileName contains histograms which have been produced by DA1 detector algorithm.
479 // It is a responsibility of the SHUTTLE framework to form the fileName.
481 gRandom->SetSeed(0); //the seed is set to the current machine clock!
482 Int_t minEntries=1000; // recalculate calibration coeff. if Nentries > minEntries.
487 while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
488 AliInfo(Form("found source %s", source->String().Data()));
490 TString fileName = GetFile(system, "AMPLITUDES", source->GetName());
491 AliInfo(Form("Got filename: %s",fileName.Data()));
496 Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
500 const Int_t nMod=5; // 1:5 modules
501 const Int_t nCol=56; //1:56 columns in each module
502 const Int_t nRow=64; //1:64 rows in each module
509 //Get the reference histogram
510 //(author: Gustavo Conesa Balbastre)
512 TList * keylist = f.GetListOfKeys();
513 Int_t nkeys = f.GetNkeys();
520 //Check if the file contains any histogram
523 Log(Form("Not enough histograms (%d) for calibration.",nkeys));
524 return 1; // it's not fatal! May be short run..
528 ikey = gRandom->Integer(nkeys);
529 key = (TKey*)keylist->At(ikey);
530 TObject* obj = f.Get(key->GetName());
531 TString cname(obj->ClassName());
532 if(cname == "TH2F") {
534 TString htitl = h2->GetTitle();
535 if(htitl.Contains("and gain 1")) {
536 hRef = h2->ProjectionX();
537 hRef->GetXaxis()->SetRangeUser(10.,1000.); // to cut off saturation peak and noise
538 // Check if the reference histogram has too little statistics
539 if(hRef->GetMean() && hRef->GetEntries()>minEntries) ok=kTRUE;
541 const TString delim = "_";
542 TString str = hRef->GetName();
543 TObjArray* tks = str.Tokenize(delim);
544 const Int_t md = ((TObjString*)tks->At(0))->GetString().Atoi();
545 const Int_t X = ((TObjString*)tks->At(1))->GetString().Atoi();
546 const Int_t Z = ((TObjString*)tks->At(2))->GetString().Atoi();
549 if(badMap->IsBadChannel(5-md,Z+1,X+1)) {
550 AliInfo(Form("Cell mod=%d col=%d row=%d is bad. Histogram %s rejected.",
551 5-md,Z+1,X+1,hRef->GetName()));
561 if(!ok && counter > nkeys){
562 Log("No histogram with enough statistics for reference. Exit.");
563 return 1; // Not fatal, just wait..
567 Log(Form("reference histogram %s, %.1f entries, mean=%.3f, rms=%.3f.",
568 hRef->GetName(),hRef->GetEntries(),
569 hRef->GetMean(),hRef->GetRMS()));
571 Double_t refMean=hRef->GetMean();
573 // Calculates relative calibration coefficients for all non-zero channels
575 for(Int_t mod=0; mod<nMod; mod++) {
576 for(Int_t col=0; col<nCol; col++) {
577 for(Int_t row=0; row<nRow; row++) {
579 sprintf(hnam,"%d_%d_%d_1",mod,row,col); // high gain!
580 h2 = (TH2F*)f.Get(hnam);
582 //TODO: dead channels exclusion!
584 h1 = h2->ProjectionX();
585 h1->GetXaxis()->SetRangeUser(10.,1000.); //to cut off saturation peak and noise
586 coeff = h1->GetMean()/refMean;
587 if(coeff>0 && h1->GetEntries()>minEntries) {
588 calibData.SetADCchannelEmc(5-mod,col+1,row+1,0.005/coeff);
589 AliInfo(Form("mod %d col %d row %d coeff %f\n",mod,col,row,coeff));