Fixing NEGATIVE_RETURNS defect reported by Coverity
[u/mrichter/AliRoot.git] / MUON / AliMUONSimpleClusterServer.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 "AliMUONSimpleClusterServer.h"
19
20 #include "AliCodeTimer.h"
21 #include "AliLog.h"
22 #include "AliMUONCluster.h"
23 #include "AliMUONConstants.h"
24 #include "AliMUONGeometryTransformer.h"
25 #include "AliMUONPad.h"
26 #include "AliMUONTriggerTrackToTrackerClusters.h"
27 #include "AliMUONVCluster.h"
28 #include "AliMUONVClusterFinder.h"
29 #include "AliMUONVClusterStore.h"
30 #include "AliMUONVDigitStore.h"
31 #include "AliMUONRecoParam.h"
32 #include "AliMpArea.h"
33 #include "AliMpDEIterator.h"
34 #include "AliMpDEManager.h"
35 #include "AliMpExMap.h"
36 #include "AliMpExMapIterator.h"
37 #include "AliMpPad.h"
38 #include "AliMpSegmentation.h"
39 #include "AliMpVSegmentation.h"
40 #include <Riostream.h>
41 #include <TClonesArray.h>
42 #include <TString.h>
43 #include <float.h>
44
45 /// \class AliMUONSimpleClusterServer
46 ///
47 /// Implementation of AliMUONVClusterServer interface
48 /// 
49 /// 
50 /// \author Laurent Aphecetche, Subatech
51
52 /// \cond CLASSIMP  
53 ClassImp(AliMUONSimpleClusterServer)
54 /// \endcond
55
56 namespace
57 {
58   TString AsString(const AliMpArea& area)
59   {
60     return Form("(X,Y)=(%7.3f,%7.3f) (DX,DY)=(%7.3f,%7.3f)",
61                 area.GetPositionX(),
62                 area.GetPositionY(),
63                 area.GetDimensionX(),  /// TBCL was Y !!!
64                 area.GetDimensionY());
65   }
66 }
67
68 //_____________________________________________________________________________
69 AliMUONSimpleClusterServer::AliMUONSimpleClusterServer(AliMUONVClusterFinder* clusterFinder,
70                                                        const AliMUONGeometryTransformer& transformer)
71 : AliMUONVClusterServer(),
72   fDigitStore(0x0),
73   fClusterFinder(clusterFinder),
74   fkTransformer(transformer),
75   fPads(),
76   fTriggerTrackStore(0x0),
77   fBypass(0x0)
78 {
79     /// Ctor
80     /// Note that we take ownership of the clusterFinder
81     
82     fPads[0] = new AliMpExMap;
83     fPads[1] = new AliMpExMap;
84     
85     fPadsIterator[0] = fPads[0]->CreateIterator();
86     fPadsIterator[1] = fPads[1]->CreateIterator();
87 }
88
89 //_____________________________________________________________________________
90 AliMUONSimpleClusterServer::~AliMUONSimpleClusterServer()
91 {
92   /// Dtor
93   delete fClusterFinder;
94   delete fPads[0];
95   delete fPads[1];
96   delete fPadsIterator[0];
97   delete fPadsIterator[1];
98   delete fBypass;
99 }
100
101 //_____________________________________________________________________________
102 Int_t 
103 AliMUONSimpleClusterServer::Clusterize(Int_t chamberId,
104                                        AliMUONVClusterStore& clusterStore,
105                                        const AliMpArea& area,
106                                        const AliMUONRecoParam* recoParam)
107 {
108   /// Area is in absolute coordinate. If not valid, means clusterize all
109   /// the chamber.
110   ///
111   /// We first find out the list of DE that have a non-zero overlap with area,
112   /// and then use the clusterfinder to find clusters in those areas (and DE).
113   
114   AliCodeTimerAuto(Form("Chamber %d",chamberId),0);
115   
116   if ( fTriggerTrackStore && chamberId >= 6 ) 
117   {
118     return fBypass->GenerateClusters(chamberId,clusterStore);
119   }
120   
121   if (!recoParam) {
122     AliError("Reconstruction parameters are missing: unable to clusterize");
123     return 0;
124   }
125   
126   AliMpDEIterator it;
127   
128   it.First(chamberId);
129   
130   Int_t nofAddedClusters(0);
131   Int_t fNCluster = clusterStore.GetSize();
132
133   AliDebug(1,Form("chamberId = %2d NofClusters before = %d searchArea=%s",
134                   chamberId,fNCluster,AsString(area).Data()));
135   
136   while ( !it.IsDone() )
137   {
138     Int_t detElemId = it.CurrentDEId();
139     
140     TClonesArray* pads[2] = 
141     { 
142       static_cast<TClonesArray*>(fPads[0]->GetValue(detElemId)),
143       static_cast<TClonesArray*>(fPads[1]->GetValue(detElemId)) 
144     };
145     
146     if ( ( pads[0] && pads[0]->GetLast()>=0 ) || 
147          ( pads[1] && pads[1]->GetLast()>=0 ) )
148     {
149       AliMpArea deArea; // area in DE-local-coordinates
150       Bool_t ok(kTRUE);
151       
152       if ( area.IsValid() ) 
153       {
154         ok = Overlap(detElemId,area,deArea);
155       }
156       
157       if ( ok ) 
158       {      
159         const AliMpVSegmentation* seg[2] = 
160         { AliMpSegmentation::Instance()->GetMpSegmentation(detElemId,AliMp::kCath0),
161           AliMpSegmentation::Instance()->GetMpSegmentation(detElemId,AliMp::kCath1)
162         };
163         
164         fClusterFinder->SetChargeHints(recoParam->LowestPadCharge(),
165                                        recoParam->LowestClusterCharge());
166         
167         if ( fClusterFinder->NeedSegmentation() )
168         {
169           fClusterFinder->Prepare(detElemId,pads,deArea,seg);
170         }
171         else
172         {
173           fClusterFinder->Prepare(detElemId,pads,deArea);
174         }
175         
176         AliDebug(1,Form("Clusterizing DE %04d with %3d pads (cath0) and %3d pads (cath1)",
177                         detElemId,
178                         (pads[0] ? pads[0]->GetLast()+1 : 0),
179                         (pads[1] ? pads[1]->GetLast()+1 : 0)));
180         
181         AliMUONCluster* cluster;
182         
183         while ( ( cluster = fClusterFinder->NextCluster() ) ) 
184         {      
185           // add new cluster to the store with information to build its ID
186           // increment the number of clusters into the store
187           AliMUONVCluster* rawCluster = clusterStore.Add(chamberId, detElemId, fNCluster++);
188           
189           ++nofAddedClusters;
190           
191           // fill array of Id of digits attached to this cluster
192           Int_t nPad = cluster->Multiplicity();
193           if (nPad < 1) AliWarning("no pad attached to the cluster");
194           
195           for (Int_t iPad=0; iPad<nPad; iPad++) 
196           {
197             AliMUONPad *pad = cluster->Pad(iPad);
198             
199             // skip virtual pads
200             if (!pad->IsReal()) continue;
201             
202             rawCluster->AddDigitId(pad->GetUniqueID());
203           }
204           
205           // fill charge and other cluster informations
206           rawCluster->SetCharge(cluster->Charge());
207           rawCluster->SetChi2(cluster->Chi2());
208           
209           Double_t xg, yg, zg;
210           fkTransformer.Local2Global(detElemId, 
211                                     cluster->Position().X(), cluster->Position().Y(), 
212                                     0, xg, yg, zg);
213           rawCluster->SetXYZ(xg, yg, zg);
214           rawCluster->SetErrXY(recoParam->GetDefaultNonBendingReso(chamberId),recoParam->GetDefaultBendingReso(chamberId));
215           
216           // Set MC label
217           if (fDigitStore && fDigitStore->HasMCInformation()) 
218           {
219             rawCluster->SetMCLabel(FindMCLabel(*cluster, detElemId, seg));
220           }
221           
222           AliDebug(1,Form("Adding RawCluster detElemId %4d mult %2d charge %e (xl,yl,zl)=(%e,%e,%e) (xg,yg,zg)=(%e,%e,%e) label %d",
223                           detElemId,rawCluster->GetNDigits(),rawCluster->GetCharge(),
224                           cluster->Position().X(),cluster->Position().Y(),0.0,
225                           xg,yg,zg,rawCluster->GetMCLabel()));
226         }
227       }
228     }
229     it.Next();
230   }
231   
232   AliDebug(1,Form("chamberId = %2d NofClusters after = %d",chamberId,fNCluster));
233   
234   return nofAddedClusters;
235 }
236
237
238 //_____________________________________________________________________________
239 void
240 AliMUONSimpleClusterServer::Global2Local(Int_t detElemId, const AliMpArea& globalArea,
241                                          AliMpArea& localArea) const
242 {
243   /// Convert a global area in local area for a given DE
244   
245   Double_t xl,yl,zl;
246   
247   Int_t chamberId = AliMpDEManager::GetChamberId(detElemId);
248   if ( chamberId < 0 ) {
249     AliErrorStream() << "Cannot get chamberId from detElemId=" << detElemId << endl;
250     return;
251   }  
252   Double_t zg = AliMUONConstants::DefaultChamberZ(chamberId);
253   
254   fkTransformer.Global2Local(detElemId,
255                              globalArea.GetPositionX(),globalArea.GetPositionY(),zg,
256                              xl,yl,zl);
257   
258   localArea = AliMpArea(xl,yl, globalArea.GetDimensionX(), globalArea.GetDimensionY());
259 }
260
261 //_____________________________________________________________________________
262 Bool_t
263 AliMUONSimpleClusterServer::Overlap(Int_t detElemId,
264                                     const AliMpArea& area,
265                                     AliMpArea& deArea) const
266 {
267   /// Check whether (global) area overlaps with the given DE.
268   /// If it is, set deArea to the overlap region and convert it
269   /// in the local coordinate system of that DE.
270   
271   Bool_t overlap(kFALSE);
272   
273   AliMpArea* globalDEArea = fkTransformer.GetDEArea(detElemId);
274   
275   if (!globalDEArea) return kFALSE;
276   
277   AliMpArea overlapArea;
278   
279   if ( area.Overlap(*globalDEArea) )
280   {
281     overlapArea = area.Intersect(*globalDEArea);
282     Global2Local(detElemId,overlapArea,deArea);
283     overlap = kTRUE;
284   }
285   else
286   {
287     deArea = AliMpArea();
288   }
289   
290   AliDebug(1,Form("DE %04d area %s globalDEArea %s overlapArea %s deArea %s overlap=%d",
291                   detElemId,
292                   AsString(area).Data(),
293                   AsString(*globalDEArea).Data(),
294                   AsString(overlapArea).Data(),
295                   AsString(deArea).Data(),
296                   overlap));
297                   
298   return overlap;
299 }
300
301 //_____________________________________________________________________________
302 TClonesArray* 
303 AliMUONSimpleClusterServer::PadArray(Int_t detElemId, Int_t cathode) const
304 {
305   /// Return array for given cathode of given DE
306   
307   return static_cast<TClonesArray*>(fPads[cathode]->GetValue(detElemId));
308 }
309
310 //_____________________________________________________________________________
311 Bool_t 
312 AliMUONSimpleClusterServer::UseTriggerTrackStore(AliMUONVTriggerTrackStore* trackStore)
313 {
314   /// Tells us to use trigger track store, and thus to bypass St45 clusters
315   fTriggerTrackStore = trackStore; // not owner
316   delete fBypass;
317   fBypass = new AliMUONTriggerTrackToTrackerClusters(fkTransformer,fTriggerTrackStore);
318   return kTRUE;
319 }
320
321 //_____________________________________________________________________________
322 void 
323 AliMUONSimpleClusterServer::UseDigits(TIter& next, AliMUONVDigitStore* digitStore)
324 {
325   /// Convert digitStore into two arrays of AliMUONPads
326   
327   fDigitStore = digitStore;
328   
329   // Clear pads arrays in the maps
330   for ( Int_t i=0; i<2; i++ ) {
331     fPadsIterator[i]->Reset();
332     Int_t key; TObject* obj;
333     while ( ( obj = fPadsIterator[i]->Next(key) ) ) {
334       //cout << "clearing array for detElemId " << key <<  "  ";
335       obj->Clear();
336     }  
337   }   
338
339   AliMUONVDigit* d;
340   while ( ( d = static_cast<AliMUONVDigit*>(next()) ) )
341   {
342     if ( ! d->Charge() > 0 ) continue; // skip void digits.
343     if ( ! d->IsTracker() ) continue; // skip trigger digits
344     Int_t ix = d->PadX();
345     Int_t iy = d->PadY();
346     Int_t cathode = d->Cathode();
347     Int_t detElemId = d->DetElemId();
348     const AliMpVSegmentation* seg = AliMpSegmentation::Instance()->
349       GetMpSegmentation(detElemId,AliMp::GetCathodType(cathode));
350     AliMpPad pad = seg->PadByIndices(ix,iy);
351     
352     TClonesArray* padArray = PadArray(detElemId,cathode);
353     if (!padArray)
354     {
355       padArray = new TClonesArray("AliMUONPad",100);
356       fPads[cathode]->Add(detElemId,padArray);
357     }
358     
359     AliMUONPad mpad(detElemId,cathode,
360                     ix,iy,pad.GetPositionX(),pad.GetPositionY(),
361                     pad.GetDimensionX(),pad.GetDimensionY(),
362                     d->Charge());
363     if ( d->IsSaturated() ) mpad.SetSaturated(kTRUE);
364     mpad.SetUniqueID(d->GetUniqueID());
365     new ((*padArray)[padArray->GetLast()+1]) AliMUONPad(mpad);      
366   }
367 }
368
369 //_____________________________________________________________________________
370 Int_t
371 AliMUONSimpleClusterServer::FindMCLabel(const AliMUONCluster& cluster, Int_t detElemId, const AliMpVSegmentation* seg[2]) const
372 {
373   /// Find the label of the most contributing MC track (-1 in case of failure)
374   /// The data member fDigitStore must be set
375   
376   // --- get the digit (if any) located at the cluster position on both cathods ---
377   Int_t nTracks[2] = {0, 0};
378   AliMUONVDigit* digit[2] = {0x0, 0x0};
379   for (Int_t iCath = 0; iCath < 2; iCath++) {
380     AliMpPad pad 
381       = seg[AliMp::GetCathodType(iCath)]->PadByPosition(cluster.Position().X(), cluster.Position().Y(),kFALSE);
382     if (pad.IsValid()) {
383       digit[iCath] = fDigitStore->FindObject(detElemId, pad.GetManuId(), pad.GetManuChannel(), iCath);
384       if (digit[iCath]) nTracks[iCath] = digit[iCath]->Ntracks();
385     }
386   }
387   
388   if (nTracks[0] + nTracks[1] == 0) return -1;
389   
390   // --- build the list of contributing tracks and of the associated charge ---
391   Int_t* trackId = new Int_t[nTracks[0] + nTracks[1]];
392   Float_t* trackCharge = new Float_t[nTracks[0] + nTracks[1]];
393   Int_t nTracksTot = 0;
394   
395   // fill with contributing tracks on first cathod
396   for (Int_t iTrack1 = 0; iTrack1 < nTracks[0]; iTrack1++) {
397     trackId[iTrack1] = digit[0]->Track(iTrack1);
398     trackCharge[iTrack1] = digit[0]->TrackCharge(iTrack1);
399   }
400   nTracksTot = nTracks[0];
401   
402   // complement with contributing tracks on second cathod
403   for (Int_t iTrack2 = 0; iTrack2 < nTracks[1]; iTrack2++) {
404     Int_t trackId2 = digit[1]->Track(iTrack2);
405     // check if track exist
406     Bool_t trackExist = kFALSE;
407     for (Int_t iTrack1 = 0; iTrack1 < nTracks[0]; iTrack1++) {
408       if (trackId2 == trackId[iTrack1]) {
409         // complement existing track
410         trackCharge[iTrack1] += digit[1]->TrackCharge(iTrack2);
411         trackExist = kTRUE;
412         break;
413       }
414     }
415     // add the new track
416     if (!trackExist) {
417       trackId[nTracksTot] = trackId2;
418       trackCharge[nTracksTot] = digit[1]->TrackCharge(iTrack2);
419       nTracksTot++;
420     }
421   }
422   
423   // --- Find the most contributing track ---
424   Int_t mainTrackId = -1;
425   Float_t maxCharge = 0.;
426   for (Int_t iTrack = 0; iTrack < nTracksTot; iTrack++) {
427     if (trackCharge[iTrack] > maxCharge) {
428       mainTrackId = trackId[iTrack];
429       maxCharge = trackCharge[iTrack];
430     }
431   }
432   
433   delete[] trackId;
434   delete[] trackCharge;
435   
436   return mainTrackId;
437 }
438
439 //_____________________________________________________________________________
440 void 
441 AliMUONSimpleClusterServer::Print(Option_t*) const
442 {
443   /// Printout for debug only
444   
445   AliMpDEIterator it;
446   
447   it.First();
448   
449   while ( !it.IsDone() )
450   {
451     Int_t detElemId = it.CurrentDEId();
452     
453     // printout the number of pads / de, and number of used pads / de
454     
455     if ( ( PadArray(detElemId,0) && PadArray(detElemId,0)->GetLast() >= 0 ) || 
456          ( PadArray(detElemId,1) && PadArray(detElemId,1)->GetLast() >= 0 ) )
457     {
458       cout << Form("---- DE %04d",detElemId) << endl;
459       
460       for ( Int_t cathode = 0; cathode < 2; ++cathode ) 
461       {
462         cout << Form("  -- Cathode %1d",cathode) << endl;
463         
464         TClonesArray* padArray = PadArray(detElemId,cathode);
465         
466         if (!padArray)
467         {
468           cout << "no pad array" << endl;
469         }
470         else if ( padArray->GetLast() < 0 ) 
471         {
472           cout << "no pads" << endl;
473         }
474         else
475         {
476           TIter next(padArray);
477           AliMUONPad* pad;
478           while ( ( pad = static_cast<AliMUONPad*>(next()) ) )
479           {
480             pad->Print("full");
481           }
482         }
483       }
484     }
485     it.Next();
486   }
487 }  
488
489