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();
133 Bool_t firedOK = kFALSE;
135 while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
137 AliInfo(Form("found source %s", source->String().Data()));
139 TString fileName = GetFile(kDAQ, "LED", source->GetName());
140 AliInfo(Form("Got filename: %s",fileName.Data()));
145 Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
149 TH1I* fFiredCells = (TH1I*)f.Get("fFiredCells");
152 Log(Form("fFiredCells histogram not found in %s, skip this source.",fileName.Data()));
156 const Double_t nFiredCells = fFiredCells->GetMean();
157 if(nFiredCells>100 && nFiredCells<600) {
159 Log(Form("Number of fired cells per event is %.1f.",nFiredCells));
162 Log(Form("Number of fired cells per event is %.1f, possibly not a LED run!",nFiredCells));
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
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++) {
176 //High Gain to Low Gain ratio
178 Float_t ratio = HG2LG(mod,row,col,&f);
179 calibData.SetHighLowRatioEmc(mod+1,col+1,row+1,ratio);
181 AliInfo(Form("mod %d iX %d iZ %d ratio %.3f\n",mod,row,col,ratio));
185 Double_t coeff = clb->GetADCchannelEmc(mod+1,col+1,row+1);
186 calibData.SetADCchannelEmc(mod+1,col+1,row+1,coeff);
189 calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005);
195 } // end of loop over files
197 //Store the updated High Gain/Low Gain ratios
198 AliCDBMetaData emcMetaData;
200 //Data valid from current run fRun until updated (validityInfinite=kTRUE)
201 Bool_t result = Store("Calib","EmcGainPedestals",&calibData,&emcMetaData,fRun,kTRUE);
206 Float_t AliPHOSPreprocessor::HG2LG(Int_t mod, Int_t X, Int_t Z, TFile* f)
208 //Calculates High gain to Low gain ratio
209 //for crystal at the position (X,Z) in the PHOS module mod.
212 sprintf(hname,"%d_%d_%d",mod,X,Z);
214 TH1F* h1 = (TH1F*)f->Get(hname);
217 if(!h1->GetEntries()) return 16.;
220 if(h1->GetMaximum()<10.) return 16.;
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());
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);
235 Double_t mean_min = h1->GetXaxis()->GetXmin();
236 Double_t mean_max = h1->GetXaxis()->GetXmax();
237 gaus1->SetParLimits(1,mean_min,mean_max);
239 h1->Fit(gaus1,"LERQ+");
241 AliInfo(Form("%s: %.1f entries, mean=%.3f, peak=%.3f, rms= %.3f. HG/LG = %.3f\n",
242 h1->GetTitle(),h1->GetEntries(),h1->GetMean(),max,h1->GetRMS(),
243 gaus1->GetParameter("Mean")));
245 return gaus1->GetParameter("Mean");
249 Bool_t AliPHOSPreprocessor::FindBadChannelsEmc()
251 //Loop over two systems: DAQ and HLT.
252 //For each system the same algorithm implemented in DoFindBadChannelsEmc() invokes.
257 Int_t system[2] = { kDAQ, kHLT };
258 const char* sysn[] = { "DAQ","HLT" };
259 Bool_t result[2] = { kTRUE, kTRUE };
261 for (Int_t i=0; i<2; i++) {
263 AliPHOSEmcBadChannelsMap badMap;
264 list = GetFileSources(system[i], "BAD_CHANNELS");
267 Log(Form("%s sources list for BAD_CHANNELS not found!",sysn[i]));
272 if(!list->GetEntries()) {
273 Log(Form("Got empty sources list. It seems %s DA2 did not produce any files!",sysn[i]));
278 result[i] *= DoFindBadChannelsEmc(system[i],list,badMap);
280 // Store the bad channels map.
283 md.SetResponsible("Boris Polishchuk");
285 if(system[i] == kDAQ)
290 // Data valid from current run fRun until being updated (validityInfinite=kTRUE)
291 result[i] *= Store(path.Data(), "EmcBadChannels", &badMap, &md, fRun, kTRUE);
295 if(result[0] || result[1]) return kTRUE;
299 Bool_t AliPHOSPreprocessor::DoFindBadChannelsEmc(Int_t system, TList* list, AliPHOSEmcBadChannelsMap& badMap)
301 //Creates the bad channels map for PHOS EMC.
303 // The file fileName contains histograms which have been produced by DA2 detector algorithm.
304 // It is a responsibility of the SHUTTLE framework to form the fileName.
311 const Float_t fQualityCut = 1.;
312 Int_t nGoods[5] = {0,0,0,0,0};
314 while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
316 AliInfo(Form("found source %s", source->String().Data()));
318 TString fileName = GetFile(system, "BAD_CHANNELS", source->GetName());
319 AliInfo(Form("Got filename: %s",fileName.Data()));
324 Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
328 TH1I* fFiredCells = (TH1I*)f.Get("fFiredCells");
331 Log(Form("fFiredCells histogram not found in %s, skip this source.",fileName.Data()));
335 const Double_t nFiredCells = fFiredCells->GetMean();
337 if(nFiredCells<100. || nFiredCells>600. ) {
338 Log(Form("Number of fired cells per event is %.1f, possibly not a LED run!",nFiredCells));
339 continue; // not a LED run!
342 Log(Form("Number of fired cells per event %.1f. Begin check for bad channels.",nFiredCells));
344 for(Int_t mod=0; mod<5; mod++) {
345 for(Int_t iX=0; iX<64; iX++) {
346 for(Int_t iZ=0; iZ<56; iZ++) {
348 sprintf(hnam,"%d_%d_%d_%d",mod,iX,iZ,1); // high gain
349 h1 = (TH1F*)f.Get(hnam);
352 Double_t mean = h1->GetMean();
355 Log(Form("iX=%d iZ=%d gain=%d mean=%.3f\n",iX,iZ,1,mean));
357 if( mean>0 && mean<fQualityCut ) {
361 badMap.SetBadChannel(mod+1,iZ+1,iX+1); //module, col,row
368 Log(Form("Module %d: %d good channels.",mod,nGoods[mod]));
372 } // end of loop over sources
377 Bool_t AliPHOSPreprocessor::CalibrateEmc()
379 //Loop over two systems: DAQ and HLT.
380 //For each system the same algorithm implemented in DoCalibrateEmc() invokes.
382 const AliPHOSEmcBadChannelsMap* badMap=0;
383 AliCDBEntry* entryBCM=0;
387 Int_t system[2] = { kDAQ, kHLT };
388 const char* sysn[] = { "DAQ","HLT" };
389 Bool_t result[2] = { kTRUE, kTRUE };
391 for (Int_t i=0; i<2; i++) {
393 AliPHOSEmcCalibData calibData;
394 list = GetFileSources(system[i], "AMPLITUDES");
397 Log(Form("%s sources list not found!",sysn[i]));
402 if(!list->GetEntries()) {
403 Log(Form("Got empty sources list. It seems %s DA1 did not produce any files!",sysn[i]));
408 // Retrieve the Bad Channels Map (BCM)
410 if(system[i] == kDAQ)
415 entryBCM = GetFromOCDB(path.Data(), "EmcBadChannels");
418 Log(Form("WARNING!! Cannot find any AliCDBEntry for [%s, EmcBadChannels]!",path.Data()));
420 badMap = (AliPHOSEmcBadChannelsMap*)entryBCM->GetObject();
423 Log(Form("WARNING!! Nothing for %s in AliCDBEntry. All cells considered GOOD!",sysn[i]));
425 result[i] *= DoCalibrateEmc(system[i],list,badMap,calibData);
427 //Store EMC calibration data
429 AliCDBMetaData emcMetaData;
430 result[i] *= Store(path.Data(), "EmcGainPedestals", &calibData, &emcMetaData, 0, kTRUE);
434 if(result[0] || result[1]) return kTRUE;
439 Bool_t AliPHOSPreprocessor::DoCalibrateEmc(Int_t system, TList* list, const AliPHOSEmcBadChannelsMap* badMap, AliPHOSEmcCalibData& calibData)
441 // Return kTRUE if OK.
442 // I. Calculates the set of calibration coefficients to equalyze the mean energies deposited at high gain.
443 // II. Extracts High_Gain/Low_Gain ratio for each channel.
445 // The file fileName contains histograms which have been produced by DA1 detector algorithm.
446 // It is a responsibility of the SHUTTLE framework to form the fileName.
448 gRandom->SetSeed(0); //the seed is set to the current machine clock!
453 while ((source = dynamic_cast<TObjString *> (iter.Next()))) {
454 AliInfo(Form("found source %s", source->String().Data()));
456 TString fileName = GetFile(system, "AMPLITUDES", source->GetName());
457 AliInfo(Form("Got filename: %s",fileName.Data()));
462 Log(Form("File %s is not opened, something goes wrong!",fileName.Data()));
466 const Int_t nMod=5; // 1:5 modules
467 const Int_t nCol=56; //1:56 columns in each module
468 const Int_t nRow=64; //1:64 rows in each module
475 //Get the reference histogram
476 //(author: Gustavo Conesa Balbastre)
478 TList * keylist = f.GetListOfKeys();
479 Int_t nkeys = f.GetNkeys();
486 //Check if the file contains any histogram
489 Log(Form("Not enough histograms (%d) for calibration.",nkeys));
490 return 1; // it's not fatal! May be short run..
494 ikey = gRandom->Integer(nkeys);
495 key = (TKey*)keylist->At(ikey);
496 TObject* obj = f.Get(key->GetName());
497 TString cname(obj->ClassName());
498 if(cname == "TH2F") {
500 TString htitl = h2->GetTitle();
501 if(htitl.Contains("and gain 1")) {
502 hRef = h2->ProjectionX();
503 hRef->GetXaxis()->SetRange(10,1000); // to cut off saturation peak and noise
504 // Check if the reference histogram has too little statistics
505 if(hRef->GetMean() && hRef->GetEntries()>2) ok=kTRUE;
507 const TString delim = "_";
508 TString str = hRef->GetName();
509 TObjArray* tks = str.Tokenize(delim);
510 const Int_t md = ((TObjString*)tks->At(0))->GetString().Atoi();
511 const Int_t X = ((TObjString*)tks->At(1))->GetString().Atoi();
512 const Int_t Z = ((TObjString*)tks->At(2))->GetString().Atoi();
515 if(badMap->IsBadChannel(md+1,Z+1,X+1)) {
516 AliInfo(Form("Cell mod=%d col=%d row=%d is bad. Histogram %s rejected.",
517 md+1,Z+1,X+1,hRef->GetName()));
527 if(!ok && counter > nkeys){
528 Log("No histogram with enough statistics for reference. Exit.");
529 return 1; // Not fatal, just wait..
533 Log(Form("reference histogram %s, %.1f entries, mean=%.3f, rms=%.3f.",
534 hRef->GetName(),hRef->GetEntries(),
535 hRef->GetMean(),hRef->GetRMS()));
537 Double_t refMean=hRef->GetMean();
539 // Calculates relative calibration coefficients for all non-zero channels
541 for(Int_t mod=0; mod<nMod; mod++) {
542 for(Int_t col=0; col<nCol; col++) {
543 for(Int_t row=0; row<nRow; row++) {
545 sprintf(hnam,"%d_%d_%d_1",mod,row,col); // high gain!
546 h2 = (TH2F*)f.Get(hnam);
548 //TODO: dead channels exclusion!
550 h1 = h2->ProjectionX();
551 h1->GetXaxis()->SetRange(10,1000); //to cut off saturation peak and noise
552 coeff = h1->GetMean()/refMean;
554 calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005/coeff);
556 calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005);
557 AliInfo(Form("mod %d col %d row %d coeff %f\n",mod,col,row,coeff));
560 calibData.SetADCchannelEmc(mod+1,col+1,row+1,0.005);