Bug fix
[u/mrichter/AliRoot.git] / MUON / AliMUONCalibrationData.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 #include "AliMUONCalibrationData.h"
19
20 #include "AliCDBEntry.h"
21 #include "AliCDBManager.h"
22 #include "AliLog.h"
23 #include "AliMUONTriggerEfficiencyCells.h"
24 #include "AliMUONTriggerLut.h"
25 #include "AliMUONVStore.h"
26 #include "AliMUONVStore.h"
27 #include "AliMUONVCalibParam.h"
28 #include "Riostream.h"
29 #include "TMap.h"
30
31 //-----------------------------------------------------------------------------
32 /// \class AliMUONCalibrationData
33 ///
34 /// For the moment, this class stores pedestals, gains, hv (for tracker)
35 /// and lut, masks and efficiencies (for trigger) that are fetched from the CDB.
36 ///
37 /// This class is to be considered as a convenience class.
38 /// Its aim is to ease retrieval of calibration data from the 
39 /// condition database.
40 ///
41 /// It acts as a "facade" to a bunch of underlying 
42 /// containers/calibration classes.
43 ///
44 /// \author Laurent Aphecetche
45 //-----------------------------------------------------------------------------
46
47 /// \cond CLASSIMP
48 ClassImp(AliMUONCalibrationData)
49 /// \endcond
50
51 //_____________________________________________________________________________
52 AliMUONCalibrationData::AliMUONCalibrationData(Int_t runNumber, 
53                                                Bool_t deferredInitialization) 
54 : TObject(), 
55 fIsValid(kTRUE),
56 fRunNumber(runNumber), 
57 fGains(0x0), 
58 fPedestals(0x0),
59 fHV(0x0),
60 fLocalTriggerBoardMasks(0x0),
61 fRegionalTriggerBoardMasks(0x0),
62 fGlobalTriggerBoardMasks(0x0),
63 fTriggerLut(0x0),
64 fTriggerEfficiency(0x0),
65 fCapacitances(0x0),
66 fNeighbours(0x0)
67 {
68 /// Default ctor.
69
70   // If deferredInitialization is false, we read *all* calibrations
71   // at once.
72   // So when using this class to access only one kind of calibrations (e.g.
73   // only pedestals), you should put deferredInitialization to kTRUE, which
74   // will instruct this object to fetch the data only when neeeded.
75
76   if ( deferredInitialization == kFALSE )
77   {
78     Gains();
79     Pedestals();
80     HV();
81     LocalTriggerBoardMasks(0);
82     RegionalTriggerBoardMasks(0);
83     GlobalTriggerBoardMasks();
84     TriggerLut();
85     TriggerEfficiency();
86     Capacitances();
87     Neighbours();
88   }
89 }
90
91 //_____________________________________________________________________________
92 AliMUONCalibrationData::~AliMUONCalibrationData()
93 {
94   /// Destructor. Note that we're the owner of our pointers.
95   Reset();
96 }
97
98 //_____________________________________________________________________________
99 AliMUONVStore*
100 AliMUONCalibrationData::Capacitances() const
101 {
102   /// Create (if needed) and return the internal store for capacitances.
103   
104   if (!fCapacitances)
105   {
106     fCapacitances = CreateCapacitances(fRunNumber);
107   }
108   return fCapacitances;
109 }
110
111 //_____________________________________________________________________________
112 AliMUONVStore*
113 AliMUONCalibrationData::CreateCapacitances(Int_t runNumber)
114 {
115   /// Create capa store from OCDB for a given run
116   
117   return dynamic_cast<AliMUONVStore*>(CreateObject(runNumber,"MUON/Calib/Capacitances"));
118 }
119
120 //_____________________________________________________________________________
121 AliMUONVStore*
122 AliMUONCalibrationData::CreateGains(Int_t runNumber)
123 {
124   /// Create a new gain store from the OCDB for a given run
125   return dynamic_cast<AliMUONVStore*>(CreateObject(runNumber,"MUON/Calib/Gains"));
126 }
127
128 //_____________________________________________________________________________
129 AliMUONVCalibParam*
130 AliMUONCalibrationData::CreateGlobalTriggerBoardMasks(Int_t runNumber)
131 {
132   /// Create the internal store for GlobalTriggerBoardMasks from OCDB
133   
134   return dynamic_cast<AliMUONVCalibParam*>(CreateObject(runNumber,"MUON/Calib/GlobalTriggerBoardMasks"));
135 }
136
137 //_____________________________________________________________________________
138 TMap*
139 AliMUONCalibrationData::CreateHV(Int_t runNumber)
140 {
141   /// Create a new HV map from the OCDB for a given run
142   return dynamic_cast<TMap*>(CreateObject(runNumber,"MUON/Calib/HV"));
143 }
144
145 //_____________________________________________________________________________
146 AliMUONVStore*
147 AliMUONCalibrationData::CreateLocalTriggerBoardMasks(Int_t runNumber)
148 {
149   /// Get the internal store for LocalTriggerBoardMasks from OCDB
150   
151   return dynamic_cast<AliMUONVStore*>(CreateObject(runNumber,"MUON/Calib/LocalTriggerBoardMasks"));
152 }
153
154 //_____________________________________________________________________________
155 AliMUONVStore*
156 AliMUONCalibrationData::CreateNeighbours(Int_t runNumber)
157 {
158   /// Create a neighbour store from the OCDB for a given run
159   return dynamic_cast<AliMUONVStore*>(CreateObject(runNumber,"MUON/Calib/Neighbours"));
160 }
161
162 //_____________________________________________________________________________
163 TObject*
164 AliMUONCalibrationData::CreateObject(Int_t runNumber, const char* path)
165 {
166   /// Access the CDB for a given path (e.g. MUON/Calib/Pedestals),
167   /// and return the corresponding TObject.
168   
169   AliCDBManager* man = AliCDBManager::Instance();
170   
171   Bool_t cacheStatus = man->GetCacheFlag();
172   
173   man->SetCacheFlag(kFALSE);
174   
175   AliCDBEntry* entry =  AliCDBManager::Instance()->Get(path,runNumber);
176   
177   man->SetCacheFlag(cacheStatus);
178   
179   if (entry)
180   {
181     return entry->GetObject();
182   }
183   
184   return 0x0;
185 }
186
187 //_____________________________________________________________________________
188 AliMUONVStore*
189 AliMUONCalibrationData::CreatePedestals(Int_t runNumber)
190 {
191   /// Create a new pedestal store from the OCDB for a given run
192   return dynamic_cast<AliMUONVStore*>(CreateObject(runNumber,"MUON/Calib/Pedestals"));
193 }
194
195 //_____________________________________________________________________________
196 AliMUONVStore*
197 AliMUONCalibrationData::CreateRegionalTriggerBoardMasks(Int_t runNumber)
198 {
199   /// Create the internal store for RegionalTriggerBoardMasks from OCDB
200   
201   return dynamic_cast<AliMUONVStore*>(CreateObject(runNumber,"MUON/Calib/RegionalTriggerBoardMasks"));
202 }
203
204 //_____________________________________________________________________________
205 AliMUONTriggerEfficiencyCells* 
206 AliMUONCalibrationData::CreateTriggerEfficiency(Int_t runNumber)
207 {
208   /// Create trigger efficiency object from OCBD
209   
210   return dynamic_cast<AliMUONTriggerEfficiencyCells*>(CreateObject(runNumber,"MUON/Calib/TriggerEfficiency"));
211 }
212
213 //_____________________________________________________________________________
214 AliMUONTriggerLut* 
215 AliMUONCalibrationData::CreateTriggerLut(Int_t runNumber)
216 {
217   /// Create trigger LUT from OCDB
218   
219   return dynamic_cast<AliMUONTriggerLut*>(CreateObject(runNumber,"MUON/Calib/TriggerLut"));
220 }
221
222 //_____________________________________________________________________________
223 AliMUONVStore*
224 AliMUONCalibrationData::Gains() const
225 {
226   /// Create (if needed) and return the internal store for gains.
227   if (!fGains)
228   {
229     fGains = CreateGains(fRunNumber);
230   }
231   return fGains;
232 }
233
234 //_____________________________________________________________________________
235 AliMUONVCalibParam*
236 AliMUONCalibrationData::Gains(Int_t detElemId, Int_t manuId) const
237 {
238 /// Return the gains for a given (detElemId, manuId) pair
239 /// Note that, unlike the DeadChannel case, if the result is 0x0, that's an
240 /// error (meaning that we should get gains for all channels).
241
242   AliMUONVStore* gains = Gains();
243   if (!gains)
244   {
245     return 0x0;
246   }
247   
248   return static_cast<AliMUONVCalibParam*>(gains->FindObject(detElemId,manuId));
249 }
250
251 //_____________________________________________________________________________
252 AliMUONVCalibParam* 
253 AliMUONCalibrationData::GlobalTriggerBoardMasks() const
254 {
255   /// Return the masks for the global trigger board.
256   
257   if (!fGlobalTriggerBoardMasks)
258   {
259     fGlobalTriggerBoardMasks = CreateGlobalTriggerBoardMasks(fRunNumber);
260   }
261   return fGlobalTriggerBoardMasks;
262 }
263
264 //_____________________________________________________________________________
265 TMap*
266 AliMUONCalibrationData::HV() const
267 {
268   /// Return the calibration for a given (detElemId, manuId) pair
269   
270   if (!fHV)
271   {
272     fHV = CreateHV(fRunNumber);
273   }
274   return fHV;
275 }
276
277 //_____________________________________________________________________________
278 AliMUONVStore*
279 AliMUONCalibrationData::Neighbours() const
280 {
281   /// Create (if needed) and return the internal store for neighbours.
282   if (!fNeighbours)
283   {
284     fNeighbours = CreateNeighbours(fRunNumber);
285   }
286   return fNeighbours;
287 }
288
289 //_____________________________________________________________________________
290 AliMUONVCalibParam* 
291 AliMUONCalibrationData::LocalTriggerBoardMasks(Int_t localBoardNumber) const
292 {
293 /// Return the masks for a given trigger local board.
294
295   if (!fLocalTriggerBoardMasks)
296   {
297     fLocalTriggerBoardMasks = CreateLocalTriggerBoardMasks(fRunNumber);
298   }
299
300   if ( fLocalTriggerBoardMasks ) 
301   {
302     AliMUONVCalibParam* ltbm = 
303       static_cast<AliMUONVCalibParam*>(fLocalTriggerBoardMasks->FindObject(localBoardNumber));
304     if (!ltbm)
305     {
306       AliError(Form("Could not get mask for localBoardNumber=%d",localBoardNumber));
307     }
308     return ltbm;  
309   }
310   return 0x0;
311 }
312
313 //_____________________________________________________________________________
314 AliMUONVStore*
315 AliMUONCalibrationData::Pedestals() const
316 {
317   /// Return pedestals
318   if (!fPedestals)
319   {
320     fPedestals = CreatePedestals(fRunNumber);
321   }
322   return fPedestals;
323 }
324
325 //_____________________________________________________________________________
326 AliMUONVCalibParam*
327 AliMUONCalibrationData::Pedestals(Int_t detElemId, Int_t manuId) const
328 {
329   /// Return the pedestals for a given (detElemId, manuId) pair.
330   /// A return value of 0x0 is considered an error, meaning we should get
331   /// pedestals for all channels.
332   
333   AliMUONVStore* pedestals = Pedestals();
334   if (!pedestals) 
335   {
336     return 0x0;
337   }
338   
339   return static_cast<AliMUONVCalibParam*>(pedestals->FindObject(detElemId,manuId));
340 }
341
342 //_____________________________________________________________________________
343 void
344 AliMUONCalibrationData::Print(Option_t*) const
345 {
346   /// A very basic dump of our guts.
347
348   cout << "RunNumber " << RunNumber()
349   << " fGains=" << fGains
350   << " fPedestals=" << fPedestals
351   << " fHV=" << fHV
352   << " fLocalTriggerBoardMasks=" << fLocalTriggerBoardMasks
353   << " fRegionalTriggerBoardMasks=" << fRegionalTriggerBoardMasks
354   << " fGlobalTriggerBoardMasks=" << fGlobalTriggerBoardMasks
355   << " fTriggerLut=" << fTriggerLut
356   << endl;
357 }
358
359 //_____________________________________________________________________________
360 AliMUONVCalibParam* 
361 AliMUONCalibrationData::RegionalTriggerBoardMasks(Int_t regionalBoardNumber) const
362 {
363 /// Return the masks for a given trigger regional board.
364
365   if ( !fRegionalTriggerBoardMasks ) 
366   {
367     fRegionalTriggerBoardMasks = CreateRegionalTriggerBoardMasks(fRunNumber);
368   }
369   
370   if ( fRegionalTriggerBoardMasks ) 
371   {
372     AliMUONVCalibParam* rtbm = 
373       static_cast<AliMUONVCalibParam*>(fRegionalTriggerBoardMasks->FindObject(regionalBoardNumber));
374     
375     if (!rtbm)
376     {
377       AliError(Form("Could not get mask for regionalBoard index=%d",regionalBoardNumber));
378     }
379     return rtbm;  
380   }
381   return 0x0;
382 }
383
384 //_____________________________________________________________________________
385 AliMUONTriggerEfficiencyCells*
386 AliMUONCalibrationData::TriggerEfficiency() const
387 {
388 /// Return the trigger efficiency.
389
390   if (!fTriggerEfficiency)
391   {
392     fTriggerEfficiency = CreateTriggerEfficiency(fRunNumber);
393   }
394   return fTriggerEfficiency;
395 }
396
397
398 //_____________________________________________________________________________
399 AliMUONTriggerLut*
400 AliMUONCalibrationData::TriggerLut() const
401 {
402 /// Return the trigger look up table.
403
404   if (!fTriggerLut)
405   {
406     fTriggerLut = CreateTriggerLut(fRunNumber);
407   }
408   return fTriggerLut;
409 }
410
411 //_____________________________________________________________________________
412 void
413 AliMUONCalibrationData::Reset()
414 {
415 /// Reset all data
416
417   delete fPedestals;
418   fPedestals = 0x0;
419   delete fGains;
420   fGains = 0x0;
421   delete fHV;
422   fHV = 0x0;
423   delete fLocalTriggerBoardMasks;
424   fLocalTriggerBoardMasks = 0x0;
425   delete fRegionalTriggerBoardMasks;
426   fRegionalTriggerBoardMasks = 0x0;
427   delete fGlobalTriggerBoardMasks;
428   fGlobalTriggerBoardMasks = 0x0;
429   delete fTriggerLut;
430   fTriggerLut = 0x0;
431   delete fTriggerEfficiency;
432   fTriggerEfficiency = 0x0;
433   delete fCapacitances;
434   fCapacitances = 0x0;
435   delete fNeighbours;
436   fNeighbours = 0x0;
437 }
438
439
440