skip asking for default pedestal and signal object
[u/mrichter/AliRoot.git] / EMCAL / AliEMCALPreprocessor.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 // EMCAL Preprocessor class. It runs by Shuttle at the end of the run,
20 // calculates stuff to be posted in OCDB
21 //
22 // Author: Boris Polichtchouk, 4 October 2006
23 // Adapted for EMCAL by Gustavo Conesa Balbastre, October 2006
24 // Updated by David Silvermyr May 2008, based on TPC code
25 ///////////////////////////////////////////////////////////////////////////////
26
27 //Root
28 #include "TFile.h"
29 #include "TTree.h"
30 #include "TEnv.h"
31 #include "TParameter.h"
32
33 #include <TTimeStamp.h>
34
35 //AliRoot
36 #include "AliShuttleInterface.h"
37 #include "AliEMCALPreprocessor.h"
38 #include "AliLog.h"
39 #include "AliCDBMetaData.h"
40 #include "AliCaloCalibPedestal.h"
41 #include "AliCaloCalibSignal.h"
42 #include "AliEMCALSensorTempArray.h"
43
44 const Int_t kValCutTemp = 100;               // discard temperatures > 100 degrees
45 const Int_t kDiffCutTemp = 5;                // discard temperature differences > 5 degrees
46 const TString kPedestalRunType = "PEDESTAL";  // pedestal run identifier
47 const TString kPhysicsRunType = "PHYSICS";   // physics run identifier
48 const TString kStandAloneRunType = "STANDALONE_BC"; // standalone run identifier
49 const TString kAmandaTemp = "PT_%02d.Temperature"; // Amanda string for temperature entries
50 //const Double_t kFitFraction = 0.7;                 // Fraction of DCS sensor fits required 
51 const Double_t kFitFraction = -1.0;          // Don't require minimum number of fits during commissioning 
52
53 const TString kMetaResponsible = "David Silvermyr";
54 //legacy comments and return codes from TPC
55 const TString kMetaComment = "Preprocessor AliEMCAL data base entries.";
56 const int kReturnCodeNoInfo = 9;
57 const int kReturnCodeNoObject = 2;
58 const int kReturnCodeNoEntries = 1;
59
60 ClassImp(AliEMCALPreprocessor)
61   
62 //_______________________________________________________________________________________
63 AliEMCALPreprocessor::AliEMCALPreprocessor() :
64   AliPreprocessor("EMC",0),
65   fConfEnv(0), 
66   fTemp(0), 
67   fConfigOK(kTRUE)
68 {
69   //default constructor
70 }
71
72 //_______________________________________________________________________________________
73 AliEMCALPreprocessor::AliEMCALPreprocessor(AliShuttleInterface* shuttle):
74   AliPreprocessor("EMC",shuttle),
75   fConfEnv(0), 
76   fTemp(0), 
77   fConfigOK(kTRUE)
78 {
79   // Constructor AddRunType(kPedestalRunType);
80   
81   // define run types to be processed
82   AddRunType(kPedestalRunType);
83   AddRunType(kPhysicsRunType);
84   AddRunType(kStandAloneRunType);
85 }
86
87 //______________________________________________________________________________________________
88 AliEMCALPreprocessor::AliEMCALPreprocessor(const AliEMCALPreprocessor&  ) :
89   AliPreprocessor("EMCAL",0),
90   fConfEnv(0), fTemp(0), fConfigOK(kTRUE)
91 {
92   Fatal("AliEMCALPreprocessor", "copy constructor not implemented");
93 }
94
95 // assignment operator; use copy ctor to make life easy.
96 //______________________________________________________________________________________________
97 AliEMCALPreprocessor& AliEMCALPreprocessor::operator = (const AliEMCALPreprocessor &source ) 
98 {
99   // assignment operator; use copy ctor
100   if (&source == this) return *this;
101   
102   new (this) AliEMCALPreprocessor(source);
103   return *this;
104 }
105
106 //____________________________________________________________________________
107 AliEMCALPreprocessor::~AliEMCALPreprocessor()
108 {
109   // destructor
110   if (fTemp) delete fTemp;
111 }
112
113 //______________________________________________________________________________________________
114 void AliEMCALPreprocessor::Initialize(Int_t run, UInt_t startTime,
115                                       UInt_t endTime)
116 {
117   // Creates AliTestDataDCS object -- start maps half an hour beforre actual run start
118   UInt_t startTimeLocal = startTime-1800;
119   AliPreprocessor::Initialize(run, startTimeLocal, endTime);
120   
121   AliInfo(Form("\n\tRun %d \n\tStartTime %s \n\tEndTime %s", run,
122                TTimeStamp((time_t)startTime,0).AsString(),
123                TTimeStamp((time_t)endTime,0).AsString()));
124   
125   // Preprocessor configuration
126   AliCDBEntry* entry = GetFromOCDB("Config", "Preprocessor");
127   if (entry) fConfEnv = (TEnv*) entry->GetObject();
128   if ( fConfEnv==0 ) {
129     Log("AliEMCALPreprocessor: Preprocessor Config OCDB entry missing.\n");
130     fConfigOK = kFALSE;
131     return;
132   }
133   
134   // Temperature sensors
135   TTree *confTree = 0;
136   
137   TString tempConf = fConfEnv->GetValue("Temperature","ON");
138   tempConf.ToUpper();
139   if (tempConf != "OFF" ) {
140     entry = GetFromOCDB("Config", "Temperature");
141     if (entry) confTree = (TTree*) entry->GetObject();
142     if ( confTree==0 ) {
143       Log("AliEMCALPreprocessor: Temperature Config OCDB entry missing.\n");
144       fConfigOK = kFALSE;
145       return;
146     }
147     fTemp = new AliEMCALSensorTempArray(startTimeLocal, fEndTime, confTree, kAmandaTemp);
148     fTemp->SetValCut(kValCutTemp);
149     fTemp->SetDiffCut(kDiffCutTemp);
150   }
151   
152   return;
153 }
154
155 //______________________________________________________________________________________________
156 UInt_t AliEMCALPreprocessor::Process(TMap* dcsAliasMap)
157 {
158   // Fills data into EMCAL calibrations objects
159   // Amanda servers provide information directly through dcsAliasMap
160   
161   if (!fConfigOK) return kReturnCodeNoInfo;
162   UInt_t result = 0;
163   TObjArray *resultArray = new TObjArray();
164   TString errorHandling = fConfEnv->GetValue("ErrorHandling","ON");
165   errorHandling.ToUpper();
166   TObject * status;
167   
168   UInt_t dcsResult=0;
169   if (errorHandling == "OFF" ) {
170     if (!dcsAliasMap) dcsResult = kReturnCodeNoEntries;
171     if (dcsAliasMap->GetEntries() == 0 ) dcsResult = kReturnCodeNoEntries;  
172     status = new TParameter<int>("dcsResult",dcsResult);
173     resultArray->Add(status);
174   } 
175   else {
176     if (!dcsAliasMap) return kReturnCodeNoInfo;
177     if (dcsAliasMap->GetEntries() == 0 ) return kReturnCodeNoInfo;
178   }
179   
180   TString runType = GetRunType();
181   
182   // Temperature sensors are processed by AliEMCALCalTemp
183   TString tempConf = fConfEnv->GetValue("Temperature","ON");
184   tempConf.ToUpper();
185   if (tempConf != "OFF" ) {
186     UInt_t tempResult = MapTemperature(dcsAliasMap);
187     result=tempResult;
188     status = new TParameter<int>("tempResult",tempResult);
189     resultArray->Add(status);
190   }
191   
192   // Other calibration information will be retrieved through FXS files
193   //  examples:
194   //    TList* fileSourcesDAQ = GetFile(AliShuttleInterface::kDAQ, "pedestals");
195   //    const char* fileNamePed = GetFile(AliShuttleInterface::kDAQ, "pedestals", "LDC1");
196   //
197   //    TList* fileSourcesHLT = GetFile(AliShuttleInterface::kHLT, "calib");
198   //    const char* fileNameHLT = GetFile(AliShuttleInterface::kHLT, "calib", "LDC1");
199   
200   // PEDESTAL ENTRIES:
201   
202   if (runType == kPedestalRunType || runType == kStandAloneRunType) {
203     Int_t numSources = 1;
204     Int_t pedestalSource[2] = {AliShuttleInterface::kDAQ, AliShuttleInterface::kHLT} ;
205     TString source = fConfEnv->GetValue("Pedestal","DAQ");
206     source.ToUpper();
207     if (source != "OFF" ) { 
208       if ( source == "HLT") pedestalSource[0] = AliShuttleInterface::kHLT;
209       if (!GetHLTStatus()) pedestalSource[0] = AliShuttleInterface::kDAQ;
210       if (source == "HLTDAQ" ) {
211         numSources=2;
212         pedestalSource[0] = AliShuttleInterface::kHLT;
213         pedestalSource[1] = AliShuttleInterface::kDAQ;
214       }
215       if (source == "DAQHLT" ) numSources=2;
216       UInt_t pedestalResult=0;
217       for (Int_t i=0; i<numSources; i++ ) {     
218         pedestalResult = ExtractPedestals(pedestalSource[i]);
219         if ( pedestalResult == 0 ) break;
220       }
221       result += pedestalResult;
222       status = new TParameter<int>("pedestalResult",pedestalResult);
223       resultArray->Add(status);
224     }
225   }
226   
227   // SIGNAL/LED ENTRIES:
228   
229   if( runType == kStandAloneRunType ) {
230     Int_t numSources = 1;
231     Int_t signalSource[2] = {AliShuttleInterface::kDAQ,AliShuttleInterface::kHLT} ;
232     TString source = fConfEnv->GetValue("Signal","DAQ");
233     source.ToUpper();
234     if ( source != "OFF") { 
235       if ( source == "HLT") signalSource[0] = AliShuttleInterface::kHLT;
236       if (!GetHLTStatus()) signalSource[0] = AliShuttleInterface::kDAQ;
237       if (source == "HLTDAQ" ) {
238         numSources=2;
239         signalSource[0] = AliShuttleInterface::kHLT;
240         signalSource[1] = AliShuttleInterface::kDAQ;
241       }
242       if (source == "DAQHLT" ) numSources=2;
243       UInt_t signalResult=0;
244       for (Int_t i=0; i<numSources; i++ ) {     
245         signalResult = ExtractSignal(signalSource[i]);
246         if ( signalResult == 0 ) break;
247       }
248       result += signalResult;
249       status = new TParameter<int>("signalResult",signalResult);
250       resultArray->Add(status);
251     }
252   }
253   
254   
255   // overall status at the end
256   if (errorHandling == "OFF" ) {
257     AliCDBMetaData metaData;
258     metaData.SetBeamPeriod(0);
259     metaData.SetResponsible(kMetaResponsible);
260     metaData.SetComment("Preprocessor AliEMCAL status.");
261     Store("Calib", "PreprocStatus", resultArray, &metaData, 0, kFALSE);
262     resultArray->Delete();
263     return 0;
264   } 
265   else { 
266     return result;
267   }
268   
269 }
270 //______________________________________________________________________________________________
271 UInt_t AliEMCALPreprocessor::MapTemperature(TMap* dcsAliasMap)
272 {
273   // extract DCS temperature maps. Perform fits to save space
274   UInt_t result=0;
275
276   TMap *map = fTemp->ExtractDCS(dcsAliasMap);
277   if (map) {
278     fTemp->MakeSplineFit(map);
279     Double_t fitFraction = 1.0*fTemp->NumFits()/fTemp->NumSensors(); 
280     if (fitFraction > kFitFraction ) {
281       AliInfo(Form("Temperature values extracted, fits performed.\n"));
282     } 
283     else { 
284       Log ("Too few temperature maps fitted. \n");
285       result = kReturnCodeNoInfo;
286     }
287   } 
288   else {
289     Log("No temperature map extracted. \n");
290     result = kReturnCodeNoInfo;
291   }
292   delete map;
293   // Now store the final CDB file
294   
295   if ( result == 0 ) { // some info was found
296     AliCDBMetaData metaData;
297     metaData.SetBeamPeriod(0);
298     metaData.SetResponsible(kMetaResponsible);
299     metaData.SetComment(kMetaComment);
300     
301     Bool_t storeOK = Store("Calib", "Temperature", fTemp, &metaData, 0, kFALSE);
302     if ( !storeOK )  result=1;
303   }
304   
305   return result;
306 }
307
308 //______________________________________________________________________________________________
309 UInt_t AliEMCALPreprocessor::ExtractPedestals(Int_t sourceFXS)
310 {
311   UInt_t result=0;
312   //
313   //  Read pedestal file from file exchange server
314   //  Only store if new pedestal info is available
315   //
316   AliCaloCalibPedestal *calibPed = new AliCaloCalibPedestal(AliCaloCalibPedestal::kEmCal);
317   
318   TList* list = GetFileSources(sourceFXS,"pedestals");
319   if (list && list->GetEntries()>0) {
320     
321     //  loop through all files from LDCs
322
323     int changes = 0;
324     UInt_t index = 0;
325     while (list->At(index)!=NULL) {
326       TObjString* fileNameEntry = (TObjString*) list->At(index);
327       if (fileNameEntry!=NULL) {
328         TString fileName = GetFile(sourceFXS, "pedestals",
329                                    fileNameEntry->GetString().Data());
330         TFile *f = TFile::Open(fileName);
331         if (!f) {
332           Log ("Error opening pedestal file.");
333           result = kReturnCodeNoObject;
334           break;
335         }
336         AliCaloCalibPedestal *calPed;
337         f->GetObject("emcCalibPedestal",calPed);
338         if ( !calPed ) {
339           Log ("No pedestal calibration object in file.");
340           result = kReturnCodeNoObject;
341           break;
342         }
343         if ( calPed->GetNEvents()>0 && calPed->GetNChanFills()>0 ) {
344           // add info for the modules available in the present file
345           Bool_t status = calibPed->AddInfo(calPed);
346           if (status) { changes++; }
347         }
348         
349         delete calPed; 
350         f->Close();
351       }
352       index++;
353     }  // while(list)
354     
355     //
356     //  Store updated pedestal entry to OCDB
357     //
358     if (changes>0) {
359       AliCDBMetaData metaData;
360       metaData.SetBeamPeriod(0);
361       metaData.SetResponsible(kMetaResponsible);
362       metaData.SetComment(kMetaComment); 
363       
364       Bool_t storeOK = StoreReferenceData("Calib", "Pedestals", calibPed, &metaData);
365       if ( !storeOK ) result++;
366     }
367   } 
368   else {
369     Log ("Error: no entries in input file list!");
370     result = kReturnCodeNoEntries;
371   }
372   
373   return result;
374 }
375
376 //______________________________________________________________________________________________
377 UInt_t AliEMCALPreprocessor::ExtractSignal(Int_t sourceFXS)
378 {
379   UInt_t result=0;
380   //
381   //  Read signal file from file exchange server
382   //  Only store if new signal info is available
383   //
384   AliCaloCalibSignal *calibSig = new AliCaloCalibSignal(AliCaloCalibSignal::kEmCal); 
385   
386   TList* list = GetFileSources(sourceFXS,"signal");
387   if (list && list->GetEntries()>0) {
388
389     //  loop through all files from LDCs
390     
391     int changes = 0;
392     UInt_t index = 0;
393     while (list->At(index)!=NULL) {
394       TObjString* fileNameEntry = (TObjString*) list->At(index);
395       if (fileNameEntry!=NULL) {
396         TString fileName = GetFile(sourceFXS, "signal",
397                                    fileNameEntry->GetString().Data());
398         TFile *f = TFile::Open(fileName);
399         if (!f) {
400           Log ("Error opening signal file.");
401           result = kReturnCodeNoObject;
402           break;
403         }
404         AliCaloCalibSignal *calSig;
405         f->GetObject("emcCalibSignal",calSig);
406         if ( !calSig ) {
407           Log ("No signal calibration object in file.");
408           result = kReturnCodeNoObject;
409           break;
410         }
411         if ( calSig->GetNEvents()>0 ) {
412           // add info for the modules available in the present file
413           Bool_t status = calibSig->AddInfo(calSig);
414           if (status) { changes++; }
415         }
416         
417         delete calSig; 
418         f->Close();
419       }
420       index++;
421     }  // while(list)
422     
423     //
424     //  Store updated signal entry to OCDB
425     //
426     if (changes>0) {
427       AliCDBMetaData metaData;
428       metaData.SetBeamPeriod(0);
429       metaData.SetResponsible(kMetaResponsible);
430       metaData.SetComment(kMetaComment); 
431       
432       Bool_t storeOK = Store("Calib", "LED", calibSig, &metaData, 0, kFALSE);
433       if ( !storeOK ) result++;
434     }
435   } 
436   else {
437     Log ("Error: no entries in input file list!");
438     result = kReturnCodeNoEntries;
439   }
440
441   return result;
442 }
443
444