bug fixed
[u/mrichter/AliRoot.git] / MUON / AliMUONPreClusterFinderV3.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 #include "AliMUONPreClusterFinderV3.h"
19
20 #include "AliLog.h"
21 #include "AliMUONCluster.h"
22 #include "AliMpVSegmentation.h"
23 #include "TClonesArray.h"
24 #include "AliMpArea.h"
25 #include "TVector2.h"
26 #include "AliMUONPad.h"
27 #include "AliMUONVDigit.h"
28 #include "AliMUONVDigitStore.h"
29 #include <Riostream.h>
30 //#include "AliCodeTimer.h"
31
32 //-----------------------------------------------------------------------------
33 /// \class AliMUONPreClusterFinderV3
34 ///
35 /// Implementation of AliMUONVClusterFinder
36 ///
37 /// This version uses a 2 steps approach :
38 ///
39 /// we first clusterize each cathode independently to form proto-preclusters, 
40 /// and then we try to "merge" proto-preclusters from the two cathodes
41 /// when thoses proto-preclusters overlap, thus ending up with preclusters
42 /// spanning the two cathodes.
43 ///
44 /// This implementation, on the contrary to PreClusterFinder or PreClusterFinderV2
45 /// should not depend on the order of the input digits.
46 ///
47 /// \author Laurent Aphecetche
48 //-----------------------------------------------------------------------------
49
50 ClassImp(AliMUONPreClusterFinderV3)
51
52 namespace
53 {
54   //___________________________________________________________________________
55   Bool_t
56   AreOverlapping(const AliMUONPad& pad, const AliMUONCluster& cluster)
57   {
58     /// Whether the pad overlaps with the cluster
59     
60     static Double_t precision = 1E-4; // cm
61     static TVector2 precisionAdjustment(precision,precision);//-precision,-precision);
62       for ( Int_t i = 0; i < cluster.Multiplicity(); ++i )
63       {
64         AliMUONPad* testPad = cluster.Pad(i);
65         // Note: we use negative precision numbers, meaning
66         // the area of the pads will be *increased* by these small numbers
67         // prior to check the overlap by the AreOverlapping method,
68         // so pads touching only by the corners will be considered as
69         // overlapping.    
70         if ( AliMUONPad::AreOverlapping(*testPad,pad,precisionAdjustment) )
71         {
72           return kTRUE;
73         }
74       }
75       return kFALSE;
76   }
77 }
78
79 //_____________________________________________________________________________
80 AliMUONPreClusterFinderV3::AliMUONPreClusterFinderV3()
81 : AliMUONVClusterFinder(),
82   fClusters(new TClonesArray("AliMUONCluster",10)),
83   fkSegmentations(0x0),
84   fPads(0x0),
85   fDetElemId(0),
86   fIterator(0x0)
87 {
88     /// ctor
89     AliInfo("")
90   for ( Int_t i = 0; i < 2; ++i )
91   {
92     fPreClusters[i] = new TClonesArray("AliMUONCluster",10);
93   } 
94 }
95
96 //_____________________________________________________________________________
97 AliMUONPreClusterFinderV3::~AliMUONPreClusterFinderV3()
98 {
99   /// dtor
100   delete fClusters;
101   for ( Int_t i = 0; i < 2; ++i )
102   {
103     delete fPreClusters[i];
104   } 
105 }
106
107 //_____________________________________________________________________________
108 Bool_t
109 AliMUONPreClusterFinderV3::UsePad(const AliMUONPad& pad)
110 {
111   /// Add a pad to the list of pads to be considered
112   if ( pad.DetElemId() != fDetElemId )
113   {
114     AliError(Form("Cannot add pad from DE %d to this cluster finder which is "
115                   "currently dealing with DE %d",pad.DetElemId(),fDetElemId));
116     return kFALSE;
117   }
118   
119   AliMUONPad* p = new ((*fPads[pad.Cathode()])[fPads[pad.Cathode()]->GetLast()+1]) AliMUONPad(pad); 
120   p->SetClusterId(-1);
121   return kTRUE;
122 }
123
124 //_____________________________________________________________________________
125 Bool_t
126 AliMUONPreClusterFinderV3::Prepare(Int_t detElemId,
127                                    TClonesArray* pads[2],
128                                    const AliMpArea& area,
129                                    const AliMpVSegmentation* seg[2])
130 {
131   /// Prepare for clustering, by giving access to segmentations and digit lists
132   
133   if ( area.IsValid() ) 
134   {
135     AliError("Handling of area not yet implemented for this class. Please check.");
136   }
137   
138   fkSegmentations = seg;
139   fPads = pads;
140   
141   fClusters->Clear("C");
142   for ( Int_t i = 0; i < 2; ++i )
143   {
144     fPreClusters[i]->Clear("C");
145   }
146   
147   fDetElemId = detElemId;
148   
149   if ( fPads[0]->GetLast() < 0 && fPads[1]->GetLast() < 0 )
150   {
151     // no pad at all, nothing to do...
152     return kFALSE;
153   }
154   
155   MakeCathodePreClusters(0);  
156   MakeCathodePreClusters(1);  
157   MakeClusters();
158   
159   delete fIterator;
160   fIterator = fClusters->MakeIterator();
161   
162   return kTRUE;
163 }
164
165 //_____________________________________________________________________________
166 void
167 AliMUONPreClusterFinderV3::DumpPreClusters() const
168 {
169   /// Dump preclusters 
170   AliMUONCluster *c;
171   TIter next0(fPreClusters[0]);
172   TIter next1(fPreClusters[1]);
173   cout << "Cath0" << endl;
174   while ( ( c = static_cast<AliMUONCluster*>(next0())) ) 
175   {
176     cout << c->AsString().Data() << endl;
177   }
178   cout << "Cath1" << endl;
179   while ( ( c = static_cast<AliMUONCluster*>(next1())) ) 
180   {
181     cout << c->AsString().Data() << endl;
182   }
183 }
184
185 //_____________________________________________________________________________
186 void
187 AliMUONPreClusterFinderV3::AddPreCluster(AliMUONCluster& cluster, AliMUONCluster* preCluster)
188 {
189   /// Add a pad to a cluster
190
191   AliMUONCluster a(*preCluster);
192
193   Int_t cathode = preCluster->Cathode();
194   if ( cathode < 0 ) {
195     AliError(Form("Cathod undefined: %d",cathode));
196     AliFatal("");
197     return;
198   }
199   
200   if ( cathode <=1 && !fPreClusters[cathode]->Remove(preCluster) ) 
201   {
202     AliError(Form("Could not remove %s from preclusters[%d]",
203                   preCluster->AsString().Data(),cathode));
204     StdoutToAliDebug(1,DumpPreClusters());
205     AliFatal("");
206     return;
207   }
208              
209   cluster.AddCluster(a);
210   
211   // loop on the *other* cathode
212   TIter next(fPreClusters[1-cathode]);
213   AliMUONCluster* testCluster;
214   
215   while ( ( testCluster = static_cast<AliMUONCluster*>(next())))
216   {
217     if ( AliMUONCluster::AreOverlapping(a,*testCluster) )
218     {
219       AddPreCluster(cluster,testCluster);
220     }
221   }
222 }
223
224
225 //_____________________________________________________________________________
226 void
227 AliMUONPreClusterFinderV3::AddPad(AliMUONCluster& cluster, AliMUONPad* pad)
228 {
229   /// Add a pad to a cluster
230   AliMUONPad* addedPad = cluster.AddPad(*pad);
231   
232   Int_t cathode = pad->Cathode();
233   TClonesArray& padArray = *fPads[cathode];
234   padArray.Remove(pad);
235   TIter next(&padArray);
236   AliMUONPad* testPad;
237   
238   while ( ( testPad = static_cast<AliMUONPad*>(next())))
239   {
240     if ( AliMUONPad::AreNeighbours(*testPad,*addedPad) )
241     {
242       AddPad(cluster,testPad);
243     }
244   }
245 }
246
247 //_____________________________________________________________________________
248 AliMUONCluster* 
249 AliMUONPreClusterFinderV3::NextCluster()
250 {
251   /// Returns the next cluster
252   
253   return static_cast<AliMUONCluster*>(fIterator->Next());
254 }
255
256 //_____________________________________________________________________________
257 void
258 AliMUONPreClusterFinderV3::MakeClusters()
259 {
260   /// Associate (proto)preclusters to form (pre)clusters
261   
262 //  AliCodeTimerAuto("",0)
263   
264   for ( Int_t cathode = 0; cathode < 2; ++cathode ) 
265   {
266     TClonesArray& preclusters = *(fPreClusters[cathode]);
267     
268     TIter next(&preclusters);
269     AliMUONCluster* preCluster(0x0);
270     
271     while ( ( preCluster = static_cast<AliMUONCluster*>(next()) ) )
272     {
273       Int_t id(fClusters->GetLast()+1);
274       AliMUONCluster* cluster = new((*fClusters)[id]) AliMUONCluster;
275       cluster->SetUniqueID(id);      
276       AddPreCluster(*cluster,preCluster);
277     }
278   }
279 }
280
281 //_____________________________________________________________________________
282 void
283 AliMUONPreClusterFinderV3::MakeCathodePreClusters(Int_t cathode)
284 {
285   /// Build (proto)preclusters from digits on a given cathode
286   
287 //  AliCodeTimerAuto(Form("Cathode %d",cathode),0)
288   
289   while ( fPads[cathode]->GetLast() > 0  )
290   {  
291     TIter next(fPads[cathode]);
292     AliMUONPad* pad = static_cast<AliMUONPad*>(next());
293   
294     if (!pad) AliFatal("");
295
296     Int_t id = fPreClusters[cathode]->GetLast()+1;
297     AliMUONCluster* cluster = new ((*fPreClusters[cathode])[id]) AliMUONCluster;
298     cluster->SetUniqueID(id);
299     
300     // Builds (recursively) a cluster on first cathode only
301     AddPad(*cluster,pad);
302     
303     if ( cluster->Multiplicity() <= 1 )
304     {
305       if ( cluster->Multiplicity() == 0 ) 
306       {
307         // no pad is suspicious
308         AliWarning("Got an empty cluster...");
309       }
310       // else only 1 pad (not suspicious, but kind of useless, probably noise)
311       // so we remove it from our list
312       fPreClusters[cathode]->Remove(cluster);
313       // then proceed further
314     }
315   }
316   
317 }