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"
21 #include "AliMUONCalibrationData.h"
22 #include "AliMUONLogger.h"
23 #include "AliMUONPadStatusMaker.h"
24 #include "AliMUONPadStatusMapMaker.h"
25 #include "AliMUONRecoParam.h"
26 #include "AliMUONVCalibParam.h"
27 #include "AliMUONVDigit.h"
28 #include "AliMUONVDigitStore.h"
29 #include "AliMUONVStore.h"
30 #include "AliMpBusPatch.h"
31 #include "AliMpConstants.h"
33 #include "AliMpDDLStore.h"
34 #include "AliMpDEIterator.h"
35 #include "AliMpDetElement.h"
36 #include "AliMpManuStore.h"
38 //-----------------------------------------------------------------------------
39 /// \class AliMUONDigitCalibrator
40 /// Class used to calibrate digits (either real or simulated ones).
42 /// The calibration consists of subtracting the pedestal
43 /// and multiplying by a gain, so that
44 /// Signal = (ADC-pedestal)*gain
46 /// Please note also that for the moment, if a digit lies on a dead channel
47 /// we remove this digit from the list of digits.
48 /// FIXME: this has to be revisited. By using the AliMUONDigit::fFlags we
49 /// should in principle flag a digit as bad w/o removing it, but this
50 /// then requires some changes in the cluster finder to deal with this extra
51 /// information correctly (e.g. to set a quality for the cluster if it contains
54 /// \author Laurent Aphecetche
55 //-----------------------------------------------------------------------------
59 ClassImp(AliMUONDigitCalibrator)
62 const Int_t AliMUONDigitCalibrator::fgkNoGain(0);
63 const Int_t AliMUONDigitCalibrator::fgkGainConstantCapa(1);
64 const Int_t AliMUONDigitCalibrator::fgkGain(2);
66 //_____________________________________________________________________________
67 AliMUONDigitCalibrator::AliMUONDigitCalibrator(const AliMUONCalibrationData& calib,
68 const AliMUONRecoParam* recoParams,
69 const char* calibMode)
71 fLogger(new AliMUONLogger(20000)),
84 Ctor(calibMode,calib,recoParams);
87 //_____________________________________________________________________________
88 AliMUONDigitCalibrator::AliMUONDigitCalibrator(const AliMUONCalibrationData& calib,
89 const char* calibMode)
91 fLogger(new AliMUONLogger(20000)),
104 Ctor(calibMode,calib,0x0);
107 //_____________________________________________________________________________
109 AliMUONDigitCalibrator::Ctor(const char* calibMode,
110 const AliMUONCalibrationData& calib,
111 const AliMUONRecoParam* recoParams)
115 TString cMode(calibMode);
118 if ( cMode == "NOGAIN" )
120 fApplyGains = fgkNoGain;
121 AliInfo("Will NOT apply gain correction");
123 else if ( cMode == "GAINCONSTANTCAPA" )
125 fApplyGains = fgkGainConstantCapa;
126 AliInfo("Will apply gain correction, but with constant capacitance");
128 else if ( cMode == "GAIN" )
130 fApplyGains = fgkGain;
131 AliInfo("Will apply gain correction, with measured capacitances");
135 AliError(Form("Invalid calib mode = %s. Will use NOGAIN instead",calibMode));
136 fApplyGains = fgkNoGain;
139 // Load mapping manu store
140 if ( ! AliMpCDB::LoadManuStore() ) {
141 AliFatal("Could not access manu store from OCDB !");
144 fStatusMaker = new AliMUONPadStatusMaker(calib);
146 // Set default values, as loose as reasonable
148 fChargeSigmaCut = 3.0;
150 Int_t mask(0x8080); // reject pads where ped *or* hv are missing
154 // if we have reco params, we use limits and cuts from there :
156 fStatusMaker->SetHVSt12Limits(recoParams->HVSt12LowLimit(),recoParams->HVSt12HighLimit());
157 fStatusMaker->SetHVSt345Limits(recoParams->HVSt345LowLimit(),recoParams->HVSt345HighLimit());
158 fStatusMaker->SetPedMeanLimits(recoParams->PedMeanLowLimit(),recoParams->PedMeanHighLimit());
159 fStatusMaker->SetPedSigmaLimits(recoParams->PedSigmaLowLimit(),recoParams->PedSigmaHighLimit());
160 fStatusMaker->SetGainA1Limits(recoParams->GainA1LowLimit(),recoParams->GainA1HighLimit());
161 fStatusMaker->SetGainA2Limits(recoParams->GainA2LowLimit(),recoParams->GainA2HighLimit());
162 fStatusMaker->SetGainThresLimits(recoParams->GainThresLowLimit(),recoParams->GainThresHighLimit());
164 mask = recoParams->PadGoodnessMask();
165 //WARNING : getting this mask wrong is a very effective way of getting
166 //no digits at all out of this class ;-)
168 fChargeSigmaCut = recoParams->ChargeSigmaCut();
171 Bool_t deferredInitialization = kTRUE;
173 fStatusMapMaker = new AliMUONPadStatusMapMaker(*fStatusMaker,mask,deferredInitialization);
175 fPedestals = calib.Pedestals();
177 fGains = calib.Gains(); // we get gains whatever the calibMode is, in order
178 // to get the saturation value...
180 if ( fApplyGains == fgkGain )
182 fCapacitances = calib.Capacitances();
186 //_____________________________________________________________________________
187 AliMUONDigitCalibrator::~AliMUONDigitCalibrator()
191 delete fStatusMapMaker;
193 AliInfo("Summary of messages:");
196 AliInfo(Form("We have seen %g pads, and rejected %g (%7.2f %%)",
197 fNumberOfPads,fNumberOfBadPads,
198 ( fNumberOfPads > 0 ) ? fNumberOfBadPads*100.0/fNumberOfPads : 0 ));
203 //_____________________________________________________________________________
205 AliMUONDigitCalibrator::Calibrate(AliMUONVDigitStore& digitStore)
207 /// Calibrate the digits contained in digitStore
208 TIter next(digitStore.CreateTrackerIterator());
209 AliMUONVDigit* digit;
211 Double_t nsigmas = fChargeSigmaCut;
213 AliDebug(1,Form("# of digits = %d",digitStore.GetSize()));
215 while ( ( digit = static_cast<AliMUONVDigit*>(next() ) ) )
217 if ( digit->IsCalibrated() )
219 fLogger->Log("ERROR : trying to calibrate a digit twice");
223 digit->Calibrated(kTRUE);
225 if ( digit->DetElemId() != detElemId )
227 // Find out occupancy of that DE
228 detElemId = digit->DetElemId();
229 AliMpDetElement* de = AliMpDDLStore::Instance()->GetDetElement(detElemId);
230 Double_t nchannels = de->NofChannels();
231 Double_t occ = digitStore.GetSize(detElemId)/nchannels;
234 nsigmas = 10.0; // enlarge (a lot) sigma cut if occupancy is high
235 // (which probably means zero suppression was not exactly OK).
236 fLogger->Log(Form("Will use %5.0f*sigma cut for DE %04d "
237 "due to high occupancy",nsigmas,detElemId));
241 nsigmas = fChargeSigmaCut;
247 Bool_t isSaturated(kFALSE);
251 Bool_t ok = IsValidDigit(digit->DetElemId(),digit->ManuId(),digit->ManuChannel(),&statusMap);
253 digit->SetStatusMap(statusMap);
257 charge = CalibrateDigit(digit->DetElemId(),digit->ManuId(),digit->ManuChannel(),
258 digit->ADC(),nsigmas,&isSaturated);
265 digit->SetCharge(charge);
266 digit->Saturated(isSaturated);
270 //_____________________________________________________________________________
272 AliMUONDigitCalibrator::CalibrateDigit(Int_t detElemId, Int_t manuId, Int_t manuChannel,
273 Float_t adc, Float_t nsigmas,
274 Bool_t* isSaturated) const
277 /// Calibrate one digit
280 AliMUONVCalibParam* pedestal = static_cast<AliMUONVCalibParam*>
281 (fPedestals->FindObject(detElemId,manuId));
285 // no pedestal -> no charge
286 fLogger->Log(Form("Got a null pedestal object for DE,manu=%d,%d",detElemId,manuId));
291 AliMUONVCalibParam* gain = static_cast<AliMUONVCalibParam*>
292 (fGains->FindObject(detElemId,manuId));
296 if ( fApplyGains != fgkNoGain )
298 // no gain -> no charge
299 fLogger->Log(Form("Got a null gain object for DE,manu=%d,%d",
305 Float_t padc = adc-pedestal->ValueAsFloat(manuChannel,0);
309 if ( fApplyGains == fgkGainConstantCapa )
313 else if ( fApplyGains == fgkGain )
318 = AliMpManuStore::Instance()->GetManuSerial(detElemId, manuId);
320 AliMUONVCalibParam* param = static_cast<AliMUONVCalibParam*>(fCapacitances->FindObject(serialNumber));
324 capa = param->ValueAsFloat(manuChannel);
328 fLogger->Log(Form("No capa found for serialNumber=%d",serialNumber));
333 if ( padc > nsigmas*pedestal->ValueAsFloat(manuChannel,1) )
335 if ( fApplyGains != fgkNoGain )
337 Float_t a0 = gain->ValueAsFloat(manuChannel,0);
338 Float_t a1 = gain->ValueAsFloat(manuChannel,1);
339 Int_t thres = gain->ValueAsInt(manuChannel,2);
346 charge = a0*thres + a0*(padc-thres) + a1*(padc-thres)*(padc-thres);
359 Int_t saturation(3000);
361 if ( gain && ( fApplyGains != fgkNoGain ) )
363 saturation = gain->ValueAsInt(manuChannel,4);
366 if ( padc >= saturation )
368 *isSaturated = kTRUE;
372 *isSaturated = kFALSE;
379 //_____________________________________________________________________________
381 AliMUONDigitCalibrator::IsValidDigit(Int_t detElemId, Int_t manuId, Int_t manuChannel,
382 Int_t* statusMap) const
385 /// Check if a given pad is ok or not.
387 // First a protection against bad input parameters
388 AliMpDetElement* de = AliMpDDLStore::Instance()->GetDetElement(detElemId);
389 if (!de) return kFALSE; // not existing DE
390 if (!de->IsExistingChannel(manuId,manuChannel))
392 // non-existing (might happen when we get parity errors in read-out
393 // that spoils the manuId
396 if (!de->IsConnectedChannel(manuId,manuChannel))
398 // existing (in read-out), but not connected channel
402 // ok, now we have a valid channel number, so let's see if that pad
403 // behaves or not ;-)
405 Int_t sm = fStatusMapMaker->StatusMap(detElemId,manuId,manuChannel);
407 if (statusMap) *statusMap = sm;
409 if ( ( sm & AliMUONPadStatusMapMaker::SelfDeadMask() ) != 0 )
411 // pad itself is bad (not testing its neighbours at this stage)
418 //_____________________________________________________________________________
420 AliMUONDigitCalibrator::PadStatus(Int_t detElemId, Int_t manuId, Int_t manuChannel) const
422 /// Return the status of the given pad
423 return fStatusMaker->PadStatus(detElemId,manuId,manuChannel);
426 //_____________________________________________________________________________
428 AliMUONDigitCalibrator::StatusMap(Int_t detElemId, Int_t manuId, Int_t manuChannel) const
430 /// Return the status map of the given pad
431 return fStatusMapMaker->StatusMap(detElemId,manuId,manuChannel);