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 #include "AliMUONDigitCalibrator.h"
20 #include "AliCDBEntry.h"
21 #include "AliCDBManager.h"
23 #include "AliMUONCalibrationData.h"
24 #include "AliMUONConstants.h"
25 #include "AliMUONLogger.h"
26 #include "AliMUONPadStatusMaker.h"
27 #include "AliMUONPadStatusMapMaker.h"
28 #include "AliMUONRecoParam.h"
29 #include "AliMUONVCalibParam.h"
30 #include "AliMUONVDigit.h"
31 #include "AliMUONVDigitStore.h"
32 #include "AliMUONVStore.h"
33 #include "AliMpBusPatch.h"
34 #include "AliMpConstants.h"
36 #include "AliMpDDLStore.h"
37 #include "AliMpDEIterator.h"
38 #include "AliMpDetElement.h"
39 #include "AliMpManuStore.h"
41 //-----------------------------------------------------------------------------
42 /// \class AliMUONDigitCalibrator
43 /// Class used to calibrate digits (either real or simulated ones).
45 /// The calibration consists of subtracting the pedestal
46 /// and multiplying by a gain, so that
47 /// Signal = (ADC-pedestal)*gain
49 /// Please note also that for the moment, if a digit lies on a dead channel
50 /// we remove this digit from the list of digits.
51 /// FIXME: this has to be revisited. By using the AliMUONDigit::fFlags we
52 /// should in principle flag a digit as bad w/o removing it, but this
53 /// then requires some changes in the cluster finder to deal with this extra
54 /// information correctly (e.g. to set a quality for the cluster if it contains
57 /// \author Laurent Aphecetche
58 //-----------------------------------------------------------------------------
62 ClassImp(AliMUONDigitCalibrator)
65 const Int_t AliMUONDigitCalibrator::fgkNoGain(0);
66 const Int_t AliMUONDigitCalibrator::fgkGainConstantCapa(1);
67 const Int_t AliMUONDigitCalibrator::fgkGain(2);
68 const Int_t AliMUONDigitCalibrator::fgkInjectionGain(3);
70 //_____________________________________________________________________________
71 AliMUONDigitCalibrator::AliMUONDigitCalibrator(Int_t runNumber)
73 fLogger(new AliMUONLogger(20000)),
87 AliMUONRecoParam* recoParam(0x0);
89 AliCDBEntry* e = AliCDBManager::Instance()->Get("MUON/Calib/RecoParam",runNumber);
92 TObject* o = e->GetObject();
93 if ( o->IsA() == TObjArray::Class() )
95 TObjArray* a = static_cast<TObjArray*>(o);
96 // a->SetOwner(kTRUE); // FIXME: this should be done but somehow makes the reco crash at the end at cleaning stage... investigate why ?
99 while ( ( p = static_cast<AliMUONRecoParam*>(next()) ))
101 if ( p->IsDefault()) recoParam = p;
106 recoParam = static_cast<AliMUONRecoParam*>(o);
111 AliError("Cannot get the recoParam. Failing");
115 // OK. Now get all we need and work...
117 AliMUONCalibrationData calib(runNumber);
119 Ctor(calib,recoParam,kFALSE);
122 //_____________________________________________________________________________
123 AliMUONDigitCalibrator::AliMUONDigitCalibrator(const AliMUONCalibrationData& calib,
124 const AliMUONRecoParam* recoParams)
126 fLogger(new AliMUONLogger(20000)),
128 fStatusMapMaker(0x0),
140 Ctor(calib,recoParams);
143 //_____________________________________________________________________________
144 AliMUONDigitCalibrator::AliMUONDigitCalibrator(const AliMUONCalibrationData& calib, int /*b*/)
146 fLogger(new AliMUONLogger(20000)),
148 fStatusMapMaker(0x0),
163 //_____________________________________________________________________________
165 AliMUONDigitCalibrator::Ctor(const AliMUONCalibrationData& calib,
166 const AliMUONRecoParam* recoParams,
167 Bool_t deferredInitialization)
171 TString cMode("NOGAIN");
172 if (recoParams) cMode=recoParams->GetCalibrationMode();
175 if ( cMode == "NOGAIN" )
177 fApplyGains = fgkNoGain;
178 AliInfo("Will NOT apply gain correction");
180 else if ( cMode == "GAINCONSTANTCAPA" )
182 fApplyGains = fgkGainConstantCapa;
183 AliInfo("Will apply gain correction, but with constant capacitance");
185 else if ( cMode == "GAIN" )
187 fApplyGains = fgkGain;
188 AliInfo("Will apply gain correction, with measured capacitances");
190 else if ( cMode == "INJECTIONGAIN")
192 fApplyGains = fgkInjectionGain;
193 AliInfo("Will apply injection gain correction, with EMELEC factory gains");
197 AliError(Form("Invalid calib mode = %s. Will use NOGAIN instead",cMode.Data()));
198 fApplyGains = fgkNoGain;
201 // Load mapping manu store
202 if ( ! AliMpCDB::LoadManuStore() ) {
203 AliFatal("Could not access manu store from OCDB !");
206 fStatusMaker = new AliMUONPadStatusMaker(calib);
208 // Set default values, as loose as reasonable
210 fChargeSigmaCut = 3.0;
212 fMask = 0x8080; // reject pads where ped *or* hv are missing
216 // if we have reco params, we use limits and cuts from there :
218 fStatusMaker->SetLimits(*recoParams);
220 fMask = recoParams->PadGoodnessMask();
221 //WARNING : getting this mask wrong is a very effective way of getting
222 //no digits at all out of this class ;-)
224 fChargeSigmaCut = recoParams->ChargeSigmaCut();
228 fLogger->Log("No RecoParam available");
229 fLogger->Log(Form("SigmaCut=%e",fChargeSigmaCut));
232 fStatusMapMaker = new AliMUONPadStatusMapMaker(*fStatusMaker,fMask,deferredInitialization);
234 fPedestals = calib.Pedestals();
236 fGains = calib.Gains(); // we get gains whatever the calibMode is, in order
237 // to get the saturation value...
239 if ( fApplyGains == fgkGain || fApplyGains == fgkInjectionGain )
241 fCapacitances = calib.Capacitances();
245 //_____________________________________________________________________________
246 AliMUONDigitCalibrator::~AliMUONDigitCalibrator()
250 if ( fNumberOfPads > 0 )
254 fStatusMaker->Report(fMask);
257 AliInfo("Summary of messages:");
261 AliInfo(Form("We have seen %g pads, and rejected %g (%7.2f %%)",
262 fNumberOfPads,fNumberOfBadPads,
263 ( fNumberOfPads > 0 ) ? fNumberOfBadPads*100.0/fNumberOfPads : 0 ));
267 delete fStatusMapMaker;
271 //_____________________________________________________________________________
273 AliMUONDigitCalibrator::Calibrate(AliMUONVDigitStore& digitStore)
275 /// Calibrate the digits contained in digitStore
276 TIter next(digitStore.CreateTrackerIterator());
277 AliMUONVDigit* digit;
279 fStatusMapMaker->RefreshRejectProbabilities(); // this will do something only for simulations
280 // (and only for those simulations where the reject list contain probabilities which are
281 // different from zero or one)
283 AliDebug(1,Form("# of digits = %d",digitStore.GetSize()));
285 while ( ( digit = static_cast<AliMUONVDigit*>(next() ) ) )
287 if ( digit->IsCalibrated() )
289 fLogger->Log("ERROR : trying to calibrate a digit twice");
293 digit->Calibrated(kTRUE);
294 digit->ChargeInFC(kTRUE);
298 Bool_t isSaturated(kFALSE);
302 Bool_t ok = IsValidDigit(digit->DetElemId(),digit->ManuId(),digit->ManuChannel(),&statusMap);
304 digit->SetStatusMap(statusMap);
308 charge = CalibrateDigit(digit->DetElemId(),digit->ManuId(),digit->ManuChannel(),
309 digit->ADC(),fChargeSigmaCut,&isSaturated);
316 digit->SetCharge(charge);
317 digit->Saturated(isSaturated);
322 //_____________________________________________________________________________
324 AliMUONDigitCalibrator::CalibrateDigit(Int_t detElemId, Int_t manuId, Int_t manuChannel,
325 Float_t adc, Float_t nsigmas,
326 Bool_t* isSaturated) const
329 /// Calibrate one digit
330 /// Return the digit charge, in fC
334 nsigmas = fChargeSigmaCut;
337 fLogger->Log(Form("ChargeSigmaCut used = %e",nsigmas));
339 AliMUONVCalibParam* pedestal = static_cast<AliMUONVCalibParam*>
340 (fPedestals->FindObject(detElemId,manuId));
344 // no pedestal -> no charge
345 fLogger->Log(Form("Got a null pedestal object for DE,manu=%d,%d",detElemId,manuId));
350 AliMUONVCalibParam* gain = static_cast<AliMUONVCalibParam*>
351 (fGains->FindObject(detElemId,manuId));
355 if ( fApplyGains != fgkNoGain )
357 // no gain -> no charge
358 fLogger->Log(Form("Got a null gain object for DE,manu=%d,%d",
364 Float_t padc = adc-pedestal->ValueAsFloat(manuChannel,0);
366 // Gain (mV/fC) = 1/(a0*capa) with a0~1.25 and capa~0.2
368 Float_t capa(AliMUONConstants::DefaultCapa()); // capa = 0.2 and a0 = 1.25
369 Float_t a0(AliMUONConstants::DefaultA0()); // is equivalent to gain = 4 mV/fC
371 Float_t adc2mv(AliMUONConstants::DefaultADC2MV()); // 1 ADC channel = 0.61 mV
372 Float_t injGain(4); // By default the gain is set to 4 mV/fC
374 // Note that the ChargeMax (for one pad) is roughly 4096 * 0.61 mV/channel / 4 mV/fC = 625 fC
376 if ( fApplyGains == fgkGain || fApplyGains == fgkInjectionGain )
379 = AliMpManuStore::Instance()->GetManuSerial(detElemId, manuId);
381 AliMUONVCalibParam* param = static_cast<AliMUONVCalibParam*>(fCapacitances->FindObject(serialNumber));
385 capa = param->ValueAsFloat(manuChannel,0);
386 injGain = param->ValueAsFloat(manuChannel,1);
389 fLogger->Log(Form("injGain is %e < 0 for serialNumber=%d",injGain,serialNumber));
395 // If capa not found in the OCDB we exit
396 fLogger->Log(Form("No capa (injGain) found for serialNumber=%d",serialNumber));
401 if ( padc > nsigmas*pedestal->ValueAsFloat(manuChannel,1) )
403 if ( fApplyGains == fgkGain || fApplyGains == fgkGainConstantCapa )
405 a0 = gain->ValueAsFloat(manuChannel,0);
406 a1 = gain->ValueAsFloat(manuChannel,1);
407 Int_t thres = gain->ValueAsInt(manuChannel,2);
414 charge = a0*thres + a0*(padc-thres) + a1*(padc-thres)*(padc-thres);
416 charge *= capa*adc2mv;
418 else if ( fApplyGains == fgkInjectionGain )
421 charge = padc*adc2mv/injGain;
425 charge = a0*padc*capa*adc2mv;
431 Int_t saturation(3000);
433 if ( gain && ( fApplyGains != fgkNoGain ) )
435 saturation = gain->ValueAsInt(manuChannel,4);
438 if ( padc >= saturation )
440 *isSaturated = kTRUE;
444 *isSaturated = kFALSE;
448 return ( charge > 0.0 ? charge : 0.0 );
451 //_____________________________________________________________________________
453 AliMUONDigitCalibrator::IsValidDigit(Int_t detElemId, Int_t manuId, Int_t manuChannel,
454 Int_t* statusMap) const
457 /// Check if a given pad is ok or not.
459 // initialize the statusmap to dead by default
460 if (statusMap) *statusMap = AliMUONPadStatusMapMaker::SelfDeadMask();
462 // First a protection against bad input parameters
463 AliMpDetElement* de = AliMpDDLStore::Instance()->GetDetElement(detElemId);
464 if (!de) return kFALSE; // not existing DE
465 if (!de->IsExistingChannel(manuId,manuChannel))
467 // non-existing (might happen when we get parity errors in read-out
468 // that spoils the manuId
471 if (!de->IsConnectedChannel(manuId,manuChannel))
473 // existing (in read-out), but not connected channel
477 // ok, now we have a valid channel number, so let's see if that pad
478 // behaves or not ;-)
480 Int_t sm = StatusMap(detElemId,manuId,manuChannel);
482 if (statusMap) *statusMap = sm;
484 if ( ( sm & AliMUONPadStatusMapMaker::SelfDeadMask() ) != 0 )
486 // pad itself is bad (not testing its neighbours at this stage)
493 //_____________________________________________________________________________
495 AliMUONDigitCalibrator::PadStatus(Int_t detElemId, Int_t manuId, Int_t manuChannel) const
497 /// Return the status of the given pad
498 return fStatusMaker->PadStatus(detElemId,manuId,manuChannel);
501 //_____________________________________________________________________________
503 AliMUONDigitCalibrator::StatusMap(Int_t detElemId, Int_t manuId, Int_t manuChannel) const
505 /// Return the status map of the given pad
506 return fStatusMapMaker->StatusMap(detElemId,manuId,manuChannel);