coverity and RuleChecker viol fixes
[u/mrichter/AliRoot.git] / EMCAL / AliEMCALRawUtils.cxx
CommitLineData
168c7b3c 1// -*- mode: c++ -*-
ee299369 2/**************************************************************************
3 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * *
5 * Author: The ALICE Off-line Project. *
6 * Contributors are mentioned in the code where appropriate. *
7 * *
8 * Permission to use, copy, modify and distribute this software and its *
9 * documentation strictly for non-commercial purposes is hereby granted *
10 * without fee, provided that the above copyright notice appears in all *
11 * copies and that both the copyright notice and this permission notice *
12 * appear in the supporting documentation. The authors make no claims *
13 * about the suitability of this software for any purpose. It is *
14 * provided "as is" without express or implied warranty. *
15 **************************************************************************/
16
17/* $Id$ */
ee299369 18
de39a0ff 19
e5bbbc4e 20//_________________________________________________________________________
21// Utility Class for handling Raw data
22// Does all transitions from Digits to Raw and vice versa,
23// for simu and reconstruction
24//
25// Note: the current version is still simplified. Only
26// one raw signal per digit is generated; either high-gain or low-gain
27// Need to add concurrent high and low-gain info in the future
28// No pedestal is added to the raw signal.
ee299369 29//*-- Author: Marco van Leeuwen (LBL)
77eac271 30//*-- Major refactoring by Per Thomas Hille
92d9f317 31
ee299369 32#include "AliEMCALRawUtils.h"
72c58de0 33#include "AliRun.h"
ee299369 34#include "AliRunLoader.h"
ee299369 35#include "AliAltroBuffer.h"
36#include "AliRawReader.h"
32cd4c24 37#include "AliCaloRawStreamV3.h"
ee299369 38#include "AliDAQ.h"
feedcab9 39#include "AliEMCALRecParam.h"
ee299369 40#include "AliEMCALLoader.h"
41#include "AliEMCALGeometry.h"
ee299369 42#include "AliEMCALDigit.h"
916f1e76 43#include "AliEMCALRawDigit.h"
20b636fc 44#include "AliEMCAL.h"
5e3106bc 45#include "AliCaloCalibPedestal.h"
16605c06 46#include "AliCaloBunchInfo.h"
47#include "AliCaloFitResults.h"
de39a0ff 48#include "AliEMCALTriggerRawDigitMaker.h"
49#include "AliEMCALTriggerSTURawStream.h"
50#include "AliEMCALTriggerData.h"
92d9f317 51#include "AliCaloConstants.h"
52#include "AliCaloRawAnalyzer.h"
53#include "AliCaloRawAnalyzerFactory.h"
1f847d9f 54#include "AliEMCALRawResponse.h"
9f467289 55
92d9f317 56using namespace CALO;
57using namespace EMCAL;
ee299369 58
92d9f317 59ClassImp(AliEMCALRawUtils)
60
b4133f05 61
92d9f317 62AliEMCALRawUtils::AliEMCALRawUtils( Algo::fitAlgorithm fitAlgo) : fNoiseThreshold(3),
63 fNPedSamples(4),
64 fGeom(0),
65 fOption(""),
66 fRemoveBadChannels(kFALSE),
77eac271 67 fFittingAlgorithm(fitAlgo),
92d9f317 68 fTimeMin(-1.),
69 fTimeMax(1.),
70 fUseFALTRO(kTRUE),
71 fRawAnalyzer(0),
72 fTriggerRawDigitMaker(0x0)
dab4328c 73{ // ctor; set up fit algo etc
4fe71e02 74 SetFittingAlgorithm(fitAlgo);
65bdc82f 75 const TObjArray* maps = AliEMCALRecParam::GetMappings();
76 if(!maps) AliFatal("Cannot retrieve ALTRO mappings!!");
77eac271 77 for(Int_t i = 0; i < 4; i++)
78 {
79 fMapping[i] = (AliAltroMapping*)maps->At(i);
80 }
81
33c3c91a 82 AliRunLoader *rl = AliRunLoader::Instance();
77eac271 83 if (rl && rl->GetAliRun())
84 {
a2339fea 85 AliEMCAL * emcal = dynamic_cast<AliEMCAL*>(rl->GetAliRun()->GetDetector("EMCAL"));
77eac271 86 if(emcal)
87 {
88 fGeom = emcal->GetGeometry();
89 }
90 else
91 {
92 AliDebug(1, Form("Using default geometry in raw reco"));
93 fGeom = AliEMCALGeometry::GetInstance(AliEMCALGeometry::GetDefaultGeometryName());
94 }
95 }
96 else
97 {
a2339fea 98 AliDebug(1, Form("Using default geometry in raw reco"));
99 fGeom = AliEMCALGeometry::GetInstance(AliEMCALGeometry::GetDefaultGeometryName());
100 }
92d9f317 101
5544799a 102 if(!fGeom) AliFatal(Form("Could not get geometry!"));
77eac271 103 fTriggerRawDigitMaker = new AliEMCALTriggerRawDigitMaker();
5544799a 104}
105
65bdc82f 106
92d9f317 107AliEMCALRawUtils::~AliEMCALRawUtils()
65bdc82f 108{
e5bbbc4e 109 //dtor
48b634ff 110 delete fRawAnalyzer;
111 delete fTriggerRawDigitMaker;
ee299369 112}
65bdc82f 113
92d9f317 114
65bdc82f 115void AliEMCALRawUtils::Digits2Raw()
ee299369 116{
117 // convert digits of the current event to raw data
33c3c91a 118 AliRunLoader *rl = AliRunLoader::Instance();
ee299369 119 AliEMCALLoader *loader = dynamic_cast<AliEMCALLoader*>(rl->GetDetectorLoader("EMCAL"));
ee299369 120 loader->LoadDigits("EMCAL");
121 loader->GetEvent();
122 TClonesArray* digits = loader->Digits() ;
123
124 if (!digits) {
125 Warning("Digits2Raw", "no digits found !");
126 return;
127 }
a2339fea 128
ee299369 129 static const Int_t nDDL = 12*2; // 12 SM hardcoded for now. Buffers allocated dynamically, when needed, so just need an upper limit here
130 AliAltroBuffer* buffers[nDDL];
131 for (Int_t i=0; i < nDDL; i++)
132 buffers[i] = 0;
a2339fea 133
92d9f317 134 TArrayI adcValuesLow( TIMEBINS );
135 TArrayI adcValuesHigh( TIMEBINS );
de39a0ff 136
ee299369 137 // loop over digits (assume ordered digits)
92d9f317 138 for (Int_t iDigit = 0; iDigit < digits->GetEntries(); iDigit++)
139 {
140 AliEMCALDigit* digit = dynamic_cast<AliEMCALDigit *>(digits->At(iDigit)) ;
141 if(!digit)
142 {
143 AliFatal("NULL Digit");
144 }
145 else
146 {
1f847d9f 147 if (digit->GetAmplitude() < AliEMCALRawResponse::GetRawFormatThreshold() )
92d9f317 148 {
149 continue;
150 }
151 //get cell indices
152 Int_t nSM = 0;
153 Int_t nIphi = 0;
154 Int_t nIeta = 0;
155 Int_t iphi = 0;
156 Int_t ieta = 0;
157 Int_t nModule = 0;
158 fGeom->GetCellIndex(digit->GetId(), nSM, nModule, nIphi, nIeta);
159 fGeom->GetCellPhiEtaIndexInSModule(nSM, nModule, nIphi, nIeta,iphi, ieta) ;
de39a0ff 160
92d9f317 161 //Check which is the RCU, 0 or 1, of the cell.
162 Int_t iRCU = -111;
77eac271 163 if (0<=iphi&&iphi<8) iRCU=0; // first cable row
164 else if (8<=iphi&&iphi<16 && 0<=ieta&&ieta<24) iRCU=0; // first half;
165 else if(8<=iphi&&iphi<16 && 24<=ieta&&ieta<48) iRCU=1; // second half;
166 //second cable row
167 else if(16<=iphi&&iphi<24) iRCU=1; // third cable row
168
169 if (nSM%2==1) iRCU = 1 - iRCU; // swap for odd=C side, to allow us to cable both sides the same
170
171 if (iRCU<0)
172 Fatal("Digits2Raw()","Non-existent RCU number: %d", iRCU);
de39a0ff 173
77eac271 174 //Which DDL?
175 Int_t iDDL = NRCUSPERMODULE*nSM + iRCU;
176 if (iDDL < 0 || iDDL >= nDDL){
177 Fatal("Digits2Raw()","Non-existent DDL board number: %d", iDDL);
178 }
179 else{
180 if (buffers[iDDL] == 0)
181 {
182 // open new file and write dummy header
183 TString fileName = AliDAQ::DdlFileName("EMCAL",iDDL);
184 //Select mapping file RCU0A, RCU0C, RCU1A, RCU1C
a2339fea 185 Int_t iRCUside=iRCU+(nSM%2)*2;
186 //iRCU=0 and even (0) SM -> RCU0A.data 0
187 //iRCU=1 and even (0) SM -> RCU1A.data 1
188 //iRCU=0 and odd (1) SM -> RCU0C.data 2
189 //iRCU=1 and odd (1) SM -> RCU1C.data 3
77eac271 190 buffers[iDDL] = new AliAltroBuffer(fileName.Data(),fMapping[iRCUside]);
a2339fea 191 buffers[iDDL]->WriteDataHeader(kTRUE, kFALSE); //Dummy;
192 }
193
194 // out of time range signal (?)
92d9f317 195 if (digit->GetTimeR() > TIMEBINMAX ) {
a2339fea 196 AliInfo("Signal is out of time range.\n");
197 buffers[iDDL]->FillBuffer((Int_t)digit->GetAmplitude());
92d9f317 198 buffers[iDDL]->FillBuffer( TIMEBINS ); // time bin
a2339fea 199 buffers[iDDL]->FillBuffer(3); // bunch length
200 buffers[iDDL]->WriteTrailer(3, ieta, iphi, nSM); // trailer
201 // calculate the time response function
202 } else {
1f847d9f 203 Bool_t lowgain = AliEMCALRawResponse::RawSampledResponse(digit->GetTimeR(), digit->GetAmplitude(),
204 adcValuesHigh.GetArray(), adcValuesLow.GetArray()) ;
205
206 if (lowgain)
207 buffers[iDDL]->WriteChannel(ieta, iphi, 0, TIMEBINS, adcValuesLow.GetArray(), AliEMCALRawResponse::GetRawFormatThreshold() );
a2339fea 208 else
1f847d9f 209 buffers[iDDL]->WriteChannel(ieta,iphi, 1, TIMEBINS, adcValuesHigh.GetArray(), AliEMCALRawResponse::GetRawFormatThreshold() );
a2339fea 210 }
211 }// iDDL under the limits
de39a0ff 212 }//digit exists
213 }//Digit loop
a2339fea 214
ee299369 215 // write headers and close files
216 for (Int_t i=0; i < nDDL; i++) {
217 if (buffers[i]) {
218 buffers[i]->Flush();
219 buffers[i]->WriteDataHeader(kFALSE, kFALSE);
220 delete buffers[i];
221 }
222 }
de39a0ff 223
ee299369 224 loader->UnloadDigits();
225}
226
92d9f317 227
77eac271 228
92d9f317 229void AliEMCALRawUtils::AddDigit(TClonesArray *digitsArr, Int_t id, Int_t lowGain, Float_t amp, Float_t time, Float_t chi2, Int_t ndf)
230{
77eac271 231 // comment
92d9f317 232 AliEMCALDigit *digit = 0, *tmpdigit = 0;
233 TIter nextdigit(digitsArr);
234
235 while (digit == 0 && (tmpdigit = (AliEMCALDigit*) nextdigit()))
236 {
237 if (tmpdigit->GetId() == id) digit = tmpdigit;
238 }
239
240 if (!digit) { // no digit existed for this tower; create one
241 Int_t type = AliEMCALDigit::kHG; // use enum in AliEMCALDigit
242 if (lowGain)
243 {
244 amp *= HGLGFACTOR;
245 type = AliEMCALDigit::kLGnoHG;
246 }
247
248 Int_t idigit = digitsArr->GetEntries();
249 new((*digitsArr)[idigit]) AliEMCALDigit( -1, -1, id, amp, time, type, idigit, chi2, ndf);
250 AliDebug(2,Form("Add digit Id %d for the first time, type %d", id, type));
251 }//digit added first time
252 else
253 { // a digit already exists, check range
254 // (use high gain if signal < cut value, otherwise low gain)
255 if (lowGain)
256 { // new digit is low gain
257 if (digit->GetAmplitude() > OVERFLOWCUT )
258 { // use if previously stored (HG) digit is out of range
259 digit->SetAmplitude( HGLGFACTOR * amp);
260 digit->SetTime(time);
261 digit->SetType(AliEMCALDigit::kLG);
262 AliDebug(2,Form("Add LG digit ID %d for the second time, type %d", digit->GetId(), digit->GetType()));
263 }
264 }//new low gain digit
265 else { // new digit is high gain
266
267 if (amp < OVERFLOWCUT )
268 { // new digit is high gain; use if not out of range
269 digit->SetAmplitude(amp);
270 digit->SetTime(time);
271 digit->SetType(AliEMCALDigit::kHG);
272 AliDebug(2,Form("Add HG digit ID %d for the second time, type %d", digit->GetId(), digit->GetType()));
273 }
274 else
275 { // HG out of range, just change flag value to show that HG did exist
276 digit->SetType(AliEMCALDigit::kLG);
277 AliDebug(2,Form("Change LG digit to HG, ID %d, type %d", digit->GetId(), digit->GetType()));
278 }
279 }//new high gain digit
280 }//digit existed replace it
281}
282
283
de39a0ff 284void AliEMCALRawUtils::Raw2Digits(AliRawReader* reader,TClonesArray *digitsArr, const AliCaloCalibPedestal* pedbadmap, TClonesArray *digitsTRG, AliEMCALTriggerData* trgData)
ee299369 285{
77eac271 286 //conversion of raw data to digits
de39a0ff 287 if(digitsArr) digitsArr->Clear("C");
92d9f317 288 if (!digitsArr) { Error("Raw2Digits", "no digits found !");return;}
289 if (!reader) {Error("Raw2Digits", "no raw reader found !");return;}
de39a0ff 290 AliEMCALTriggerSTURawStream inSTU(reader);
de39a0ff 291 AliCaloRawStreamV3 in(reader,"EMCAL",fMapping);
7643e728 292 reader->Select("EMCAL",0,43); // 43 = AliEMCALGeoParams::fgkLastAltroDDL
de39a0ff 293 fTriggerRawDigitMaker->Reset();
294 fTriggerRawDigitMaker->SetIO(reader, in, inSTU, digitsTRG, trgData);
16605c06 295 fRawAnalyzer->SetIsZeroSuppressed(true); // TMP - should use stream->IsZeroSuppressed(), or altro cfg registers later
92d9f317 296
829ba234 297 Int_t lowGain = 0;
e5bbbc4e 298 Int_t caloFlag = 0; // low, high gain, or TRU, or LED ref.
a2339fea 299
74867dce 300 Float_t bcTimePhaseCorr = 0; // for BC-based L1 phase correction
301 Int_t bcMod4 = (reader->GetBCID() % 4); // LHC uses 40 MHz, EMCal uses 10 MHz clock
302 if (bcMod4==0 || bcMod4==1) {
303 bcTimePhaseCorr = -1e-7; // subtract 100 ns for certain BC values
304 }
305
92d9f317 306 while (in.NextDDL())
307 {
92d9f317 308 while (in.NextChannel())
309 {
92d9f317 310 caloFlag = in.GetCaloFlag();
311 if (caloFlag > 2) continue; // Work with ALTRO and FALTRO
312 if(caloFlag < 2 && fRemoveBadChannels && pedbadmap->IsBadChannel(in.GetModule(),in.GetColumn(),in.GetRow()))
313 {
314 continue;
315 }
316 vector<AliCaloBunchInfo> bunchlist;
317 while (in.NextBunch())
318 {
319 bunchlist.push_back( AliCaloBunchInfo(in.GetStartTimeBin(), in.GetBunchLength(), in.GetSignals() ) );
320 }
321 if (bunchlist.size() == 0) continue;
322 if ( caloFlag < 2 )
323 { // ALTRO
324 Int_t id = fGeom->GetAbsCellIdFromCellIndexes(in.GetModule(), in.GetRow(), in.GetColumn()) ;
325 lowGain = in.IsLowGain();
326 fRawAnalyzer->SetL1Phase( in.GetL1Phase() );
327 AliCaloFitResults res = fRawAnalyzer->Evaluate( bunchlist, in.GetAltroCFG1(), in.GetAltroCFG2());
328 if(res.GetAmp() >= fNoiseThreshold )
329 {
74867dce 330 AddDigit(digitsArr, id, lowGain, res.GetAmp(), res.GetTime()+bcTimePhaseCorr, res.GetChi2(), res.GetNdf() );
92d9f317 331 }
332 }//ALTRO
333 else if(fUseFALTRO)
334 {// Fake ALTRO
335 fTriggerRawDigitMaker->Add( bunchlist );
336 }//Fake ALTRO
337 } // end while over channel
338 } //end while over DDL's, of input stream
de39a0ff 339 fTriggerRawDigitMaker->PostProcess();
f4a4dc82 340 TrimDigits(digitsArr);
ee299369 341}
342
f4a4dc82 343
f4a4dc82 344void AliEMCALRawUtils::TrimDigits(TClonesArray *digitsArr)
dab4328c 345{ // rm entries with LGnoHG (unphysical), out of time window, and too bad chi2
f4a4dc82 346 AliEMCALDigit *digit = 0;
347 Int_t n = 0;
348 Int_t nDigits = digitsArr->GetEntriesFast();
349 TIter nextdigit(digitsArr);
350 while ((digit = (AliEMCALDigit*) nextdigit())) {
f4a4dc82 351 if (digit->GetType() == AliEMCALDigit::kLGnoHG) {
92d9f317 352 AliDebug(1,Form("Remove digit with id %d, LGnoHG",digit->GetId()));
f4a4dc82 353 digitsArr->Remove(digit);
82cbdfca 354 }
f4a4dc82 355 else if(fTimeMin > digit->GetTime() || fTimeMax < digit->GetTime()) {
356 digitsArr->Remove(digit);
92d9f317 357 AliDebug(1,Form("Remove digit with id %d, Bad Time %e",digit->GetId(), digit->GetTime()));
82cbdfca 358 }
2cd0ffda 359 else if (0 > digit->GetChi2()) {
360 digitsArr->Remove(digit);
92d9f317 361 AliDebug(1,Form("Remove digit with id %d, Bad Chi2 %e",digit->GetId(), digit->GetChi2()));
2cd0ffda 362 }
f4a4dc82 363 else {
364 digit->SetIndexInList(n);
365 n++;
366 }
367 }//while
368
369 digitsArr->Compress();
370 AliDebug(1,Form("N Digits before trimming : %d; after array compression %d",nDigits,digitsArr->GetEntriesFast()));
16605c06 371}
8cb998bd 372
16605c06 373
4fe71e02 374void AliEMCALRawUtils::SetFittingAlgorithm(Int_t fitAlgo)
dab4328c 375{ // select which fitting algo should be used
48b634ff 376 delete fRawAnalyzer; // delete doesn't do anything if the pointer is 0x0
92d9f317 377 fRawAnalyzer = AliCaloRawAnalyzerFactory::CreateAnalyzer( fitAlgo );
378 fRawAnalyzer->SetNsampleCut(5); // requirement for fits to be done, for the new methods
379 fRawAnalyzer->SetOverflowCut ( OVERFLOWCUT );
380 fRawAnalyzer->SetAmpCut(fNoiseThreshold);
381 fRawAnalyzer->SetFitArrayCut(fNoiseThreshold);
4fe71e02 382}
383
384
92d9f317 385