Fixes for report #68312: Improper usage of TClonesArrays in ITS
[u/mrichter/AliRoot.git] / ITS / AliITSClusterFinderV2SDD.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-2003, 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 //            Implementation of the ITS clusterer V2 class                //
20 //                                                                        //
21 //          Origin: Iouri Belikov, CERN, Jouri.Belikov@cern.ch            //
22 //                                                                        //
23 ///////////////////////////////////////////////////////////////////////////
24
25
26
27 #include <TClonesArray.h>
28 #include <TBits.h>
29 #include "AliITSClusterFinderV2SDD.h"
30 #include "AliITSRecPoint.h"
31 #include "AliITSRecPointContainer.h"
32 #include "AliITSDetTypeRec.h"
33 #include "AliRawReader.h"
34 #include "AliITSRawStreamSDD.h"
35 #include "AliITSRawStreamSDDCompressed.h"
36 #include "AliITSCalibrationSDD.h"
37 #include "AliITSresponseSDD.h"
38 #include "AliITSDetTypeRec.h"
39 #include "AliITSReconstructor.h"
40 #include "AliITSsegmentationSDD.h"
41 #include "AliITSdigitSDD.h"
42 #include "AliITSgeomTGeo.h"
43
44 ClassImp(AliITSClusterFinderV2SDD)
45
46 AliITSClusterFinderV2SDD::AliITSClusterFinderV2SDD(AliITSDetTypeRec* dettyp):AliITSClusterFinder(dettyp),
47   fNAnodes(0),
48   fNTimeBins(0),
49   fNZbins(0),
50   fNXbins(0),
51   fCutOnPeakLoose(0.),
52   fCutOnPeakTight(0.),
53   fMaxDrTimeForTightCut(0.)
54 {
55   //Default constructor
56
57   fNAnodes = GetSeg()->NpzHalf();
58   fNZbins = fNAnodes+2;
59   fNTimeBins = GetSeg()->Npx();
60   fNXbins = fNTimeBins+2;
61   AliDebug(2,Form("Cells in SDD cluster finder: Andoes=%d  TimeBins=%d",fNAnodes,fNTimeBins));
62   const Int_t kMaxBin=fNZbins*fNXbins;
63   for(Int_t iHyb=0;iHyb<kHybridsPerDDL;iHyb++){
64    fDDLBins[iHyb]=new AliBin[kMaxBin];
65   }
66   SetPeakSelection(15.,30.,2000.);
67 }
68  
69
70 //______________________________________________________________________
71 AliITSClusterFinderV2SDD::~AliITSClusterFinderV2SDD()
72 {
73   //Destructor
74   for(Int_t iHyb=0;iHyb<kHybridsPerDDL;iHyb++){ 
75     delete [] fDDLBins[iHyb];
76   }
77 }
78
79 //______________________________________________________________________
80 void AliITSClusterFinderV2SDD::FindRawClusters(Int_t mod){
81
82   //Find clusters V2
83   SetModule(mod);
84   FindClustersSDD(fDigits);
85
86 }
87
88 //______________________________________________________________________
89 void AliITSClusterFinderV2SDD::FindClustersSDD(TClonesArray *digits) {
90   //------------------------------------------------------------
91   // Actual SDD cluster finder
92   //------------------------------------------------------------
93
94   const Int_t kMaxBin=fNZbins*fNXbins;
95   AliBin *bins[2];
96   bins[0]=new AliBin[kMaxBin];
97   bins[1]=new AliBin[kMaxBin];
98   TBits *anodeFired[2];
99   anodeFired[0]=new TBits(fNAnodes);
100   anodeFired[1]=new TBits(fNAnodes);
101   anodeFired[0]->ResetAllBits();
102   anodeFired[1]->ResetAllBits();
103   AliITSCalibrationSDD* cal = (AliITSCalibrationSDD*)GetResp(fModule);
104   if(cal==0){
105     AliError(Form("Calibration object not present for SDD module %d\n",fModule));
106     return;
107   }
108
109   AliITSdigitSDD *d=0;
110   Int_t i, ndigits=digits->GetEntriesFast();
111   for (i=0; i<ndigits; i++) {
112      d=(AliITSdigitSDD*)digits->UncheckedAt(i);
113      Int_t ian=d->GetCoord1();
114      Int_t itb=d->GetCoord2();
115      Int_t iSide=0;
116      if (ian >= fNAnodes) iSide=1;    
117      Float_t gain=cal->GetChannelGain(ian)/fDetTypeRec->GetAverageGainSDD();
118      Float_t charge=d->GetSignal(); // returns expanded signal 
119                                     // (10 bit, low threshold already added)
120      Float_t baseline = cal->GetBaseline(ian);
121      if(charge>baseline) charge-=baseline;
122      else charge=0;
123
124      if(gain>0.){ // Bad channels have gain=0.
125        charge/=gain;
126        if(charge<cal->GetThresholdAnode(ian)) continue;
127        Int_t q=(Int_t)(charge+0.5);
128        Int_t y=itb+1;   
129        Int_t z=ian+1;   
130        if (z <= fNAnodes){
131          bins[0][y*fNZbins+z].SetQ(q);
132          bins[0][y*fNZbins+z].SetMask(1);
133          bins[0][y*fNZbins+z].SetIndex(i);
134          anodeFired[0]->SetBitNumber(ian);
135        } else {
136          z-=fNAnodes;
137          bins[1][y*fNZbins+z].SetQ(q);
138          bins[1][y*fNZbins+z].SetMask(1);
139          bins[1][y*fNZbins+z].SetIndex(i);
140          anodeFired[1]->SetBitNumber(ian-fNAnodes);
141        }
142      }
143   }
144   
145   FindClustersSDD(bins, anodeFired, digits);
146
147   delete[] bins[0];
148   delete[] bins[1];
149   delete anodeFired[0];
150   delete anodeFired[1];
151
152 }
153
154 //______________________________________________________________________
155 void AliITSClusterFinderV2SDD::
156 FindClustersSDD(AliBin* bins[2], TBits* anodeFired[2],  
157                 TClonesArray *digits, TClonesArray *clusters, Int_t jitter) {
158   //------------------------------------------------------------
159   // Actual SDD cluster finder
160   //------------------------------------------------------------
161
162   static AliITSRecoParam *repa = NULL;
163   if(!repa){
164     repa = (AliITSRecoParam*) AliITSReconstructor::GetRecoParam();
165     if(!repa){
166       repa = AliITSRecoParam::GetHighFluxParam();
167       AliWarning("Using default AliITSRecoParam class");
168     }
169   }
170   const TGeoHMatrix *mT2L=AliITSgeomTGeo::GetTracking2LocalMatrix(fModule);
171   AliITSCalibrationSDD* cal = (AliITSCalibrationSDD*)GetResp(fModule);
172   if(cal==0){
173     AliError(Form("Calibration object not present for SDD module %d\n",fModule));
174     return;
175   }
176   const Int_t kMaxBin=fNZbins*fNXbins;
177   Int_t ncl=0; 
178   TClonesArray &cl=*clusters;
179   for (Int_t s=0; s<2; s++){
180     for(Int_t iAnode=0; iAnode<GetSeg()->NpzHalf(); iAnode++){
181       if(anodeFired[s]->TestBitNumber(iAnode)==kFALSE) continue;
182       for(Int_t iTimeBin=0; iTimeBin<GetSeg()->Npx(); iTimeBin++){
183         Int_t index=(iTimeBin+1)*fNZbins+(iAnode+1);
184         if (bins[s][index].IsUsed()) continue;
185         if(NoiseSuppress(index,s,bins[s],cal)) continue;
186         Int_t idx[32]; UInt_t msk[32]; Int_t npeaks=0;
187         FindPeaks(index, fNZbins, bins[s], idx, msk, npeaks);
188
189         if (npeaks>30) continue;
190         if (npeaks==0) continue;
191
192         Int_t k,l;
193         Int_t nClust;
194         if(repa->GetUseUnfoldingInClusterFinderSDD()){
195           for (k=0; k<npeaks-1; k++){//mark adjacent peaks          
196             if (idx[k] < 0) continue; //this peak is already removed
197             for (l=k+1; l<npeaks; l++) {
198               if (idx[l] < 0) continue; //this peak is already removed
199               Int_t ki=idx[k]/fNZbins, kj=idx[k] - ki*fNZbins;
200               Int_t li=idx[l]/fNZbins, lj=idx[l] - li*fNZbins;
201               Int_t di=TMath::Abs(ki - li);
202               Int_t dj=TMath::Abs(kj - lj);
203               if (di>1 || dj>1) continue;
204               if (bins[s][idx[k]].GetQ() > bins[s][idx[l]].GetQ()) {
205                 msk[l]=msk[k];
206                 idx[l]*=-1;
207               } else {
208                 msk[k]=msk[l];
209                 idx[k]*=-1;
210                 break;
211               } 
212             }
213           }
214           nClust=npeaks;
215         }else{
216           for (k=1; k<npeaks; k++) msk[k]=msk[0];
217           nClust=1;
218         }
219         Float_t maxADC=0;
220         for (k=0; k<npeaks; k++) {
221           if(idx[k]>0. && bins[s][idx[k]].GetQ() > maxADC) maxADC=bins[s][idx[k]].GetQ();
222           MarkPeak(TMath::Abs(idx[k]), fNZbins, bins[s], msk[k]);
223         }
224         if(maxADC<fCutOnPeakLoose) continue;
225
226         for (k=0; k<nClust; k++) {
227           if (idx[k] < 0) continue; //removed peak
228           AliITSRecPoint c;
229           MakeCluster(idx[k], fNZbins, bins[s], msk[k], c);
230           //mi change
231           Int_t milab[10];
232           for (Int_t ilab=0;ilab<10;ilab++){
233             milab[ilab]=-2;
234           }
235           
236           if(digits) {
237             for (Int_t di=-2; di<=2;di++){
238               for (Int_t dj=-2;dj<=2;dj++){
239                 index = idx[k]+di+dj*fNZbins;
240                 if (index<0) continue;
241                 if (index>=kMaxBin) continue;
242                 AliBin *b=&bins[s][index];
243                 AliITSdigitSDD* d=(AliITSdigitSDD*)digits->UncheckedAt(b->GetIndex());
244                 for (Int_t itrack=0;itrack<10;itrack++){
245                   Int_t track = (d->GetTracks())[itrack];
246                   if (track>=0) {
247                     AddLabel(milab, track); 
248                   }
249                 }
250               }
251             }
252           }
253           
254
255           Int_t clSizAnode=fZmax-fZmin+1;
256           Int_t clSizTb=fXmax-fXmin+1;    
257           if(repa->GetUseSDDClusterSizeSelection()){
258             if(clSizTb==1) continue; // cut common mode noise spikes
259             if(clSizAnode>5)  continue; // cut common mode noise spikes
260             if(clSizTb>10)  continue; // cut clusters on noisy anodes
261             if(cal-> IsAMAt20MHz() && clSizTb>8)  continue; // cut clusters on noisy anodes
262           }
263           
264           AliITSresponseSDD* rsdd = fDetTypeRec->GetResponseSDD();
265           Float_t y=c.GetY(),z=c.GetZ(), q=c.GetQ();
266           y/=q; z/=q;
267           Float_t zAnode=z-0.5;  // to have anode in range 0.-255. and centered on the mid of the pitch
268           Float_t timebin=y-0.5;  // to have time bin in range 0.-255. amd centered on the mid of the bin
269           if(s==1) zAnode += GetSeg()->NpzHalf();  // right side has anodes from 256. to 511.
270           Float_t zdet = GetSeg()->GetLocalZFromAnode(zAnode);
271           Float_t driftTimeUncorr = GetSeg()->GetDriftTimeFromTb(timebin)+jitter*rsdd->GetCarlosRXClockPeriod();
272           Float_t driftTime=driftTimeUncorr-rsdd->GetTimeZero(fModule);
273           if(driftTime<fMaxDrTimeForTightCut && maxADC<fCutOnPeakTight) continue;
274
275           Float_t driftSpeed = cal->GetDriftSpeedAtAnode(zAnode) + rsdd->GetDeltaVDrift(fModule,zAnode>255);
276           Float_t driftPathMicron = driftTime*driftSpeed;
277           const Double_t kMicronTocm = 1.0e-4; 
278           Float_t xdet=(driftPathMicron-GetSeg()->Dx())*kMicronTocm; // xdet is negative
279           if (s==0) xdet=-xdet; // left side has positive local x
280           
281           if(repa->GetUseSDDCorrectionMaps()){
282             Float_t corrx=0, corrz=0;
283             cal->GetCorrections(zdet,xdet,corrz,corrx,GetSeg());
284             zdet+=corrz;
285             xdet+=corrx;
286           }
287           
288           Double_t loc[3]={xdet,0.,zdet},trk[3]={0.,0.,0.};
289           mT2L->MasterToLocal(loc,trk);
290           y=trk[1];
291           z=trk[2]; 
292           
293           q/=rsdd->GetADCtokeV(fModule);
294           q+=(driftTime*rsdd->GetChargevsTime()); // correction for zero supp.
295           if(cal-> IsAMAt20MHz()) q*=2.; // account for 1/2 sampling freq.
296           if(q<repa->GetMinClusterChargeSDD()) continue; // remove noise clusters
297           
298           Float_t hit[5] = {y, z, 0.0030*0.0030, 0.0020*0.0020, q};
299           Int_t  info[3] = {clSizTb, clSizAnode, fNlayer[fModule]};
300           if (digits) CheckLabels2(milab);
301           milab[3]=fNdet[fModule];
302           AliITSRecPoint cc(milab,hit,info);
303           cc.SetType(nClust*100+npeaks);
304           cc.SetDriftTime(driftTimeUncorr);
305           cc.SetDriftSide(s);
306           cc.SetChargeRatio(maxADC);
307           if(clusters) new (cl[ncl]) AliITSRecPoint(cc); 
308           else {
309             fDetTypeRec->AddRecPoint(cc);
310           }
311           ncl++;
312         }
313       }
314     }
315   }
316   AliDebug(2,Form("Clusters found on SDD module %d (unfolding %d) = %d\n",fModule,repa->GetUseUnfoldingInClusterFinderSDD(),ncl));
317
318
319 //______________________________________________________________________
320 void AliITSClusterFinderV2SDD::RawdataToClusters(AliRawReader* rawReader){
321     //------------------------------------------------------------
322   // This function creates ITS clusters from raw data
323   //------------------------------------------------------------
324
325   AliITSRawStream* inputSDD=AliITSRawStreamSDD::CreateRawStreamSDD(rawReader);
326   AliDebug(1,Form("%s is used",inputSDD->ClassName()));
327
328   AliITSDDLModuleMapSDD *ddlmap=(AliITSDDLModuleMapSDD*)fDetTypeRec->GetDDLModuleMapSDD();
329   inputSDD->SetDDLModuleMap(ddlmap);
330   for(Int_t iddl=0; iddl<AliITSDDLModuleMapSDD::GetNDDLs(); iddl++){
331     for(Int_t icar=0; icar<AliITSDDLModuleMapSDD::GetNModPerDDL();icar++){
332       Int_t iMod=ddlmap->GetModuleNumber(iddl,icar);
333       if(iMod==-1) continue;
334       AliITSCalibrationSDD* cal = (AliITSCalibrationSDD*)GetResp(iMod);
335       if(cal==0){
336         AliError(Form("Calibration object not present for SDD module %d\n",iMod));
337         continue;
338       }
339       Bool_t isZeroSupp=cal->GetZeroSupp();
340       if(isZeroSupp){ 
341         for(Int_t iSid=0; iSid<2; iSid++) inputSDD->SetZeroSuppLowThreshold(iMod-240,iSid,cal->GetZSLowThreshold(iSid));
342       }else{
343         for(Int_t iSid=0; iSid<2; iSid++) inputSDD->SetZeroSuppLowThreshold(iMod-240,iSid,0);
344       }
345     }
346   }
347   FindClustersSDD(inputSDD);
348   delete inputSDD;
349 }
350
351 void AliITSClusterFinderV2SDD::FindClustersSDD(AliITSRawStream* input) 
352 {
353   //------------------------------------------------------------
354   // Actual SDD cluster finder for raw data
355   //------------------------------------------------------------
356   AliITSRecPointContainer* rpc = AliITSRecPointContainer::Instance();
357   Int_t nClustersSDD = 0;
358   AliBin *bins[2];
359   TBits* anodeFired[2];
360   TBits* ddlAnodeFired[kHybridsPerDDL];
361   for(Int_t iHyb=0;iHyb<kHybridsPerDDL;iHyb++){
362     ddlAnodeFired[iHyb]=new TBits(fNAnodes);
363     ddlAnodeFired[iHyb]->ResetAllBits();
364   }
365   Int_t vectModId[kModulesPerDDL];
366   for(Int_t iMod=0; iMod<kModulesPerDDL; iMod++) vectModId[iMod]=-1;
367
368   // read raw data input stream
369   while (input->Next()) {
370     Int_t iModule = input->GetModuleID();
371     if(iModule<0){
372       AliWarning(Form("Invalid SDD module number %d\n", iModule));
373       continue;
374     }
375     Int_t iCarlos =input->GetCarlosId();
376     Int_t iSide = input->GetChannel();
377     Int_t iHybrid=iCarlos*2+iSide;
378
379     if (input->IsCompletedModule()) {
380       // store the module number
381       vectModId[iCarlos]=iModule;
382     }
383     else if (input->IsCompletedDDL()) {
384       // when all data from a DDL was read, search for clusters
385       Int_t jitter=input->GetJitter();
386       for(Int_t iMod=0; iMod<kModulesPerDDL; iMod++){
387         if(vectModId[iMod]>=0){
388           fModule = vectModId[iMod];
389           TClonesArray* clusters = rpc->UncheckedGetClusters(fModule);
390           bins[0]=fDDLBins[iMod*2];   // first hybrid of the module
391           bins[1]=fDDLBins[iMod*2+1]; // second hybrid of the module
392           anodeFired[0]=ddlAnodeFired[iMod*2];
393           anodeFired[1]=ddlAnodeFired[iMod*2+1];
394           FindClustersSDD(bins, anodeFired, NULL, clusters,jitter);
395           Int_t nClusters = clusters->GetEntriesFast();
396           nClustersSDD += nClusters;
397           vectModId[iMod]=-1;
398         }
399         for (Int_t s=0; s<2; s++){
400           Int_t indexHyb=iMod*2+s;
401           for(Int_t iAnode=0; iAnode<GetSeg()->NpzHalf(); iAnode++){
402             if(ddlAnodeFired[indexHyb]->TestBitNumber(iAnode)==kFALSE) continue;
403             for(Int_t iTimeBin=0; iTimeBin<GetSeg()->Npx(); iTimeBin++){
404               Int_t index=(iTimeBin+1)*fNZbins+(iAnode+1);
405               fDDLBins[indexHyb][index].Reset();
406             }
407           }
408         }
409         ddlAnodeFired[iMod*2]->ResetAllBits();
410         ddlAnodeFired[iMod*2+1]->ResetAllBits();
411       }
412     }else{
413     // fill the current digit into the bins array
414       if(iHybrid<0 || iHybrid>=kHybridsPerDDL){ 
415         AliWarning(Form("Invalid SDD hybrid number %d on module %d\n", iHybrid,iModule));
416         continue;
417       }
418       AliITSCalibrationSDD* cal = (AliITSCalibrationSDD*)GetResp(iModule);    
419       if(cal==0){
420         AliError(Form("Calibration object not present for SDD module %d\n",iModule));
421         continue;
422       }
423       Float_t charge=input->GetSignal();
424       Int_t chan=input->GetCoord1()+fNAnodes*iSide;
425       Float_t gain=cal->GetChannelGain(chan)/fDetTypeRec->GetAverageGainSDD();;
426       Float_t baseline = cal->GetBaseline(chan);
427       if(charge>baseline) charge-=baseline;
428       else charge=0;
429       if(gain>0.){ // Bad channels have gain=0
430         charge/=gain;
431         if(charge>=cal->GetThresholdAnode(chan)) {
432           Int_t q=(Int_t)(charge+0.5);
433           Int_t iz = input->GetCoord1();
434           Int_t itb = input->GetCoord2();
435           Int_t index = (itb+1) * fNZbins + (iz+1);
436           if((itb < fNTimeBins) && (iz < fNAnodes)) {
437             fDDLBins[iHybrid][index].SetQ(q);
438             fDDLBins[iHybrid][index].SetMask(1);
439             fDDLBins[iHybrid][index].SetIndex(index);
440             ddlAnodeFired[iHybrid]->SetBitNumber(iz);
441           }else{
442             AliWarning(Form("Invalid SDD cell: Anode=%d   TimeBin=%d",iz,itb));   
443           }
444         }
445       }
446     }
447   }
448   for(Int_t iHyb=0;iHyb<kHybridsPerDDL;iHyb++){ 
449    delete ddlAnodeFired[iHyb];
450   }
451   AliDebug(1,Form("found clusters in ITS SDD: %d", nClustersSDD));
452 }
453
454 //______________________________________________________________________
455 Bool_t AliITSClusterFinderV2SDD::NoiseSuppress(Int_t k, Int_t sid, AliBin* bins, AliITSCalibrationSDD* cal) const {
456   // applies zero suppression using the measured noise of each anode
457   // threshold values from ALICE-INT-1999-28 V10
458   // returns kTRUE if the digit should eb noise suppressed, kFALSE if it should be kept
459   Float_t xfactL=2.2; 
460   Float_t xfactH=4.0;
461   //
462
463   Int_t iAn=(k%fNZbins)-1;
464   if(iAn<0 || iAn>255) return kTRUE;
465   if(sid==1) iAn+=256;
466   Int_t nLow=0, nHigh=0;
467   Float_t noise=cal->GetNoiseAfterElectronics(iAn);
468   Float_t noisem1=noise;
469   if(iAn>1) noisem1=cal->GetNoiseAfterElectronics(iAn-1);
470   Float_t noisep1=noise;
471   if(iAn<511) noisep1=cal->GetNoiseAfterElectronics(iAn+1);
472   Float_t tL=noise*xfactL;
473   Float_t tH=noise*xfactH;
474   Float_t tLp1=noisep1*xfactL;
475   Float_t tHp1=noisep1*xfactH;
476   Float_t tLm1=noisem1*xfactL;
477   Float_t tHm1=noisem1*xfactH;
478   Int_t cC=bins[k].GetQ();
479   if(cC<=tL){
480     bins[k].SetQ(0);
481     bins[k].SetMask(0xFFFFFFFE);
482     return kTRUE;;
483   }
484   nLow++; // cC is greater than tL
485   if(cC>tH) nHigh++;
486   Int_t sS=bins[k-1].GetQ();
487   if(sS>tLm1) nLow++;
488   if(sS>tHm1) nHigh++;
489   Int_t nN=bins[k+1].GetQ();
490   if(nN>tLp1) nLow++;
491   if(nN>tHp1) nHigh++;
492   Int_t eE=bins[k-fNZbins].GetQ();
493   if(eE>tL) nLow++;
494   if(eE>tH) nHigh++;
495   Int_t wW=bins[k+fNZbins].GetQ();
496   if(wW>tL) nLow++;
497   if(wW>tH) nHigh++;
498   if(nLow<2 || nHigh<1) return kTRUE;
499   else return kFALSE;
500 }
501
502
503