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