CPV clusterization updated
[u/mrichter/AliRoot.git] / PHOS / AliPHOSClusterizerv1.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 /* $Log:
19    1 October 2000. Yuri Kharlov:
20      AreNeighbours()
21      PPSD upper layer is considered if number of layers>1
22
23    18 October 2000. Yuri Kharlov:
24      AliPHOSClusterizerv1()
25      CPV clusterizing parameters added
26
27      MakeClusters()
28      After first PPSD digit remove EMC digits only once
29 */
30
31 //_________________________________________________________________________
32 //  Implementation version 1 of the clusterization algorithm 
33 // 
34 //*-- Author: Yves Schutz (SUBATECH) 
35 //////////////////////////////////////////////////////////////////////////////
36
37 // --- ROOT system ---
38
39 #include "TMath.h" 
40
41 // --- Standard library ---
42
43 #include <iostream.h>
44
45 // --- AliRoot header files ---
46
47 #include "AliPHOSClusterizerv1.h"
48 #include "AliPHOSDigit.h"
49 #include "AliPHOSEmcRecPoint.h"
50 #include "AliPHOSPpsdRecPoint.h"
51 #include "AliPHOSCpvRecPoint.h"
52 #include "AliPHOSv0.h" 
53 #include "AliRun.h" 
54
55 ClassImp(AliPHOSClusterizerv1)
56
57 //____________________________________________________________________________
58 AliPHOSClusterizerv1::AliPHOSClusterizerv1()
59 {
60   // default ctor (to be used)
61
62   fA                       = 0.;
63   fB                       = 0.01 ;
64   fGeom                    = AliPHOSGeometry::GetInstance();
65   fNumberOfEmcClusters     = 0 ; 
66   fNumberOfPpsdClusters    = 0 ; 
67   fEmcClusteringThreshold  = 0.1;   
68   fEmcEnergyThreshold      = 0.01;    
69   fPpsdClusteringThreshold = 0.0;
70   fPpsdEnergyThreshold     = 0.1;  
71   fW0                      = 4.5 ;
72   fLocMaxCut               = 0.06 ;
73   fW0CPV                   = 4.5 ;
74   fLocMaxCutCPV            = 0.06 ;
75 }
76
77 //____________________________________________________________________________
78 Int_t AliPHOSClusterizerv1::AreNeighbours(AliPHOSDigit * d1, AliPHOSDigit * d2)
79 {
80   // Gives the neighbourness of two digits = 0 are not neighbour but continue searching 
81   //                                       = 1 are neighbour
82   //                                       = 2 are not neighbour but do not continue searching
83   // neighbours are defined as digits having at least common vertex
84   // The order of d1 and d2 is important: first (d1) should be a digit already in a cluster 
85   //                                      which is compared to a digit (d2)  not yet in a cluster  
86
87   Int_t rv = 0 ; 
88
89   Int_t relid1[4] ; 
90   fGeom->AbsToRelNumbering(d1->GetId(), relid1) ; 
91
92   Int_t relid2[4] ; 
93   fGeom->AbsToRelNumbering(d2->GetId(), relid2) ; 
94  
95   if ( (relid1[0] == relid2[0]) && (relid1[1]==relid2[1]) ) { // inside the same PHOS module and the same PPSD Module 
96     Int_t rowdiff = TMath::Abs( relid1[2] - relid2[2] ) ;  
97     Int_t coldiff = TMath::Abs( relid1[3] - relid2[3] ) ;  
98     
99     if (( coldiff <= 1 )  && ( rowdiff <= 1 )){
100       rv = 1 ; 
101     }
102     else {
103       if((relid2[2] > relid1[2]) && (relid2[3] > relid1[3]+1)) 
104         rv = 2; //  Difference in row numbers is too large to look further 
105     }
106
107   } 
108   else {
109     
110     if( (relid1[0] < relid2[0]) || (relid1[1] < relid2[1]) )  
111       rv=2 ;
112
113   }
114
115   //Do NOT clusterize upper PPSD  
116   if(fGeom->GetNumberOfCPVLayers() > 1 &&
117      relid1[1] > 0                     &&
118      relid1[1] < fGeom->GetNumberOfPadsPhi()*fGeom->GetNumberOfPadsPhi() ) rv = 2 ;
119
120   return rv ; 
121 }
122
123 //____________________________________________________________________________
124 void AliPHOSClusterizerv1::FillandSort(const DigitsList * dl, TObjArray * tl) 
125 {
126   // Copies the digits with energy above thershold and sorts the list
127   // according to increasing Id number
128
129   Int_t relid[4] ;  
130   
131   TIter next(dl) ; 
132   AliPHOSDigit * digit ;
133   
134   while ( (digit = (AliPHOSDigit *)next()) ) { 
135
136 //     cout << " clusterizerv1 " << endl ;
137 //     int nprim = digit->GetNprimary() ;
138 //     int * aprim = digit->GetPrimary() ;
139 //     for ( int ii = 0 ; ii < nprim ; ii++)
140 //       cout << ii << " prim = " << aprim[ii] << endl ;
141
142     Int_t id    = digit->GetId() ; 
143     Float_t ene = Calibrate(digit->GetAmp()) ; 
144     fGeom->AbsToRelNumbering(id, relid) ;
145     if(relid[1]==0){ // EMC
146       if ( ene > fEmcEnergyThreshold )
147         tl->Add(digit) ;
148     }
149
150     else { //Ppsd
151       if ( ene > fPpsdEnergyThreshold )
152         tl->Add(digit) ; 
153     }
154
155   }
156   tl->Sort() ; 
157 }
158
159 //____________________________________________________________________________
160 void AliPHOSClusterizerv1:: GetNumberOfClustersFound(Int_t * numb) 
161 {
162   // Fills numb with the number of EMC  (numb[0]) clusters found
163   //                               PPSD (numb[1]) clusters found
164
165   numb[0] = fNumberOfEmcClusters ; 
166   numb[1] = fNumberOfPpsdClusters ; 
167 }
168
169 //____________________________________________________________________________
170 Bool_t AliPHOSClusterizerv1::IsInEmc(AliPHOSDigit * digit) 
171 {
172   // Tells if (true) or not (false) the digit is in a PHOS-EMC module
173  
174   Bool_t rv = kFALSE ; 
175
176   Int_t relid[4] ; 
177   fGeom->AbsToRelNumbering(digit->GetId(), relid) ; 
178
179   if ( relid[1] == 0  )
180     rv = kTRUE; 
181
182   return rv ; 
183 }
184
185 //____________________________________________________________________________
186 void AliPHOSClusterizerv1::MakeClusters(const DigitsList * dl, 
187                                         AliPHOSRecPoint::RecPointsList * emcl, 
188                                         AliPHOSRecPoint::RecPointsList * ppsdl)
189 {
190   // Steering method to construct the clusters stored in a list of Reconstructed Points
191   // A cluster is defined as a list of neighbour digits
192
193   fNumberOfEmcClusters = 0 ;
194   fNumberOfPpsdClusters = 0 ;
195
196   // Fill and sort the working digits list
197   TObjArray tempodigitslist( dl->GetEntries() ) ;
198   FillandSort(dl, &tempodigitslist) ; 
199
200   // Clusterization starts  
201   TIter nextdigit(&tempodigitslist) ; 
202   AliPHOSDigit * digit ; 
203   Bool_t notremoved = kTRUE ;
204
205   while ( (digit = (AliPHOSDigit *)nextdigit()) ) { // scan over the list of digits
206     AliPHOSRecPoint * clu ; 
207
208     AliPHOSDigit ** clusterdigitslist = new AliPHOSDigit*[dl->GetEntries()] ;   
209     Int_t index ;
210     if (( (  IsInEmc(digit) ) && ( Calibrate(digit->GetAmp() ) > fEmcClusteringThreshold  ) ) || 
211         ( ( !IsInEmc(digit) ) && ( Calibrate(digit->GetAmp() ) > fPpsdClusteringThreshold ) ) ) {
212   
213       Int_t iDigitInCluster = 0 ; 
214
215       if  ( IsInEmc(digit) ) {   
216         // start a new EMC RecPoint
217         if(fNumberOfEmcClusters >= emcl->GetSize()) emcl->Expand(2*fNumberOfEmcClusters+1) ;
218         (*emcl)[fNumberOfEmcClusters] = new  AliPHOSEmcRecPoint(fW0, fLocMaxCut) ;
219         clu = (AliPHOSEmcRecPoint *) emcl->At(fNumberOfEmcClusters) ; 
220         fNumberOfEmcClusters++ ; 
221         clu->AddDigit(*digit, Calibrate(digit->GetAmp())) ; 
222         clusterdigitslist[iDigitInCluster] = digit ;    
223         iDigitInCluster++ ; 
224         tempodigitslist.Remove(digit) ; 
225
226       } else { 
227         
228         // start a new PPSD cluster
229         if(fNumberOfPpsdClusters >= ppsdl->GetSize()) ppsdl->Expand(2*fNumberOfPpsdClusters+1);
230         if      (strcmp(fGeom->GetName(),"GPS2") == 0) {
231           (*ppsdl)[fNumberOfPpsdClusters] = new AliPHOSPpsdRecPoint() ;
232           clu =  (AliPHOSPpsdRecPoint *) ppsdl->At(fNumberOfPpsdClusters)  ;  
233         }
234         else if (strcmp(fGeom->GetName(),"IHEP") == 0) {
235           (*ppsdl)[fNumberOfPpsdClusters] = new AliPHOSCpvRecPoint(fW0CPV, fLocMaxCutCPV) ;
236           clu =  (AliPHOSCpvRecPoint *) ppsdl->At(fNumberOfPpsdClusters)  ;  
237         }
238         fNumberOfPpsdClusters++ ; 
239         clu->AddDigit(*digit, Calibrate(digit->GetAmp()) ) ;    
240         clusterdigitslist[iDigitInCluster] = digit  ;   
241         iDigitInCluster++ ; 
242         tempodigitslist.Remove(digit) ; 
243         nextdigit.Reset() ;
244         
245         // Here we remove resting EMC digits, which cannot make cluster
246
247         if( notremoved ) { 
248           while( ( digit = (AliPHOSDigit *)nextdigit() ) ) {
249             if( IsInEmc(digit) ) 
250               tempodigitslist.Remove(digit) ;
251             else 
252               break ;
253           }
254           notremoved = kFALSE ;
255         }
256         
257       } // else        
258       
259       nextdigit.Reset() ;
260
261       AliPHOSDigit * digitN ; 
262       index = 0 ;
263       while (index < iDigitInCluster){ // scan over digits already in cluster 
264         digit =  clusterdigitslist[index]  ;      
265         index++ ; 
266         while ( (digitN = (AliPHOSDigit *)nextdigit()) ) { // scan over the reduced list of digits 
267           Int_t ineb = AreNeighbours(digit, digitN);       // call (digit,digitN) in THAT oder !!!!!
268           switch (ineb ) {
269           case 0 :   // not a neighbour
270             break ;
271           case 1 :   // are neighbours 
272             clu->AddDigit(*digitN, Calibrate( digitN->GetAmp() ) ) ;
273             clusterdigitslist[iDigitInCluster] = digitN ; 
274             iDigitInCluster++ ; 
275             tempodigitslist.Remove(digitN) ;
276             break ;
277           case 2 :   // too far from each other
278             goto endofloop;   
279           } // switch
280           
281         } // while digitN
282
283       endofloop: ;
284         nextdigit.Reset() ; 
285         
286       } // loop over cluster     
287     }  //below energy theshold  
288     
289     delete[] clusterdigitslist ; 
290     
291   } // while digit
292
293   tempodigitslist.Clear() ; 
294
295   ppsdl->Sort() ;
296   Int_t index ;
297   for(index = 0; index < ppsdl->GetEntries(); index++)
298     ((AliPHOSPpsdRecPoint *)ppsdl->At(index))->SetIndexInList(index) ;
299 }
300
301 //____________________________________________________________________________
302 void AliPHOSClusterizerv1::PrintParameters() 
303 {
304   // Print the energy thresholds 
305
306   cout << "PHOS Clusterizer version 1 :" << endl 
307        << "                       EMC  Clustering threshold = " << fEmcClusteringThreshold << endl
308        << "                       EMC  Energy threshold     = " << fEmcEnergyThreshold << endl                  
309        << "                      PPSD  Clustering threshold = " << fPpsdClusteringThreshold << endl
310        << "                      PPSD  Energy threshold     = " << fPpsdEnergyThreshold << endl ;                
311 }