Replacement of AliMpIntPair object with algoritmic
[u/mrichter/AliRoot.git] / MUON / mapping / AliMpSlatSegmentation.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 // $MpId: AliMpSlatSegmentation.cxx,v 1.12 2006/05/24 13:58:50 ivana Exp $
18
19 //-----------------------------------------------------------------------------
20 // Caution !!
21 // Implementation note.
22 // The position(s) used in the interface are supposed to be relative
23 // to the slat center (AliMpSlat::Position()), whereas internally
24 // the x,y are relative to bottom-left corner.
25 //-----------------------------------------------------------------------------
26
27 #include "AliMpSlatSegmentation.h"
28
29 #include "AliLog.h"
30 #include "AliMpArea.h"
31 #include "AliMpConnection.h"
32 #include "AliMpConstants.h"
33 #include "AliLog.h"
34 #include "AliMpMotif.h"
35 #include "AliMpMotifPosition.h"
36 #include "AliMpMotifType.h"
37 #include "AliMpSlat.h"
38 #include "AliMpSlatPadIterator.h"
39 #include "AliMpEncodePair.h"
40
41 /// \cond CLASSIMP
42 ClassImp(AliMpSlatSegmentation)
43 /// \endcond
44
45 //_____________________________________________________________________________
46 AliMpSlatSegmentation::AliMpSlatSegmentation() 
47 : AliMpVSegmentation(),
48   fkSlat(0),
49   fIsOwner(false)
50 {
51   ///
52   /// Default ctor. Not to be used really.
53   ///
54   AliDebug(1,Form("this=%p Empty ctor",this));
55 }
56
57 //_____________________________________________________________________________
58 AliMpSlatSegmentation::AliMpSlatSegmentation(const AliMpSlat* slat, Bool_t own) 
59 : AliMpVSegmentation(), 
60   fkSlat(slat),
61   fIsOwner(own)
62 {
63   ///
64   /// Normal ctor.
65   ///
66   AliDebug(1,Form("this=%p Normal ctor slat=%p",this,slat));
67 }
68
69 //_____________________________________________________________________________
70 AliMpSlatSegmentation::~AliMpSlatSegmentation()
71 {
72   ///
73   /// Dtor (empty).
74   ///
75  
76   if ( fIsOwner ) delete fkSlat;
77  
78   // Int_t i(0);//just to be able to put a breakpoint in gdb
79   AliDebug(1,Form("this=%p",this));                     
80 }
81
82 //_____________________________________________________________________________
83 AliMpVPadIterator*
84 AliMpSlatSegmentation::CreateIterator(const AliMpArea& area) const
85 {
86   ///
87   /// Returns an iterator to loop over the pad contained within given area.
88   ///
89   AliMpArea a(area.Position()+fkSlat->Position(),area.Dimensions());
90   AliDebug(3,Form("Converted input area wrt to slat center : "
91                   "%7.2f,%7.2f->%7.2f,%7.2f to wrt slat lower-left : "
92                   "%7.2f,%7.2f->%7.2f,%7.2f ",
93                   area.LeftBorder(),area.DownBorder(),
94                   area.RightBorder(),area.UpBorder(),
95                   a.LeftBorder(),a.DownBorder(),
96                   a.RightBorder(),a.UpBorder()));
97                   
98   return new AliMpSlatPadIterator(fkSlat,a);
99 }
100
101 //_____________________________________________________________________________
102 AliMpVPadIterator*
103 AliMpSlatSegmentation::CreateIterator() const
104 {
105   /// Returns an iterator to loop over all pads of that segmentation
106   ///
107   /// FIXME: we currently just forward this to the other CreateIterator,
108   /// with the proper region. Might be more efficient to write a dedicated
109   /// iterator ? Test that idea.
110   
111   AliMpArea area(TVector2(0.0,0.0),fkSlat->Dimensions());
112   return CreateIterator(area);
113 }
114
115 //_____________________________________________________________________________
116 Int_t 
117 AliMpSlatSegmentation::GetNeighbours(const AliMpPad& pad, 
118                                      TObjArray& neighbours,
119                                      Bool_t includeSelf,
120                                      Bool_t includeVoid) const
121 {
122   /// Uses default implementation
123   return AliMpVSegmentation::GetNeighbours(pad,neighbours,includeSelf,includeVoid);
124 }
125
126 //_____________________________________________________________________________
127 TVector2
128 AliMpSlatSegmentation::Dimensions() const
129 {
130   /// Return dimensions
131
132   return Slat()->Dimensions();
133 }
134
135 //_____________________________________________________________________________
136 void 
137 AliMpSlatSegmentation::GetAllElectronicCardIDs(TArrayI& ecn) const
138 {
139   /// Fill the array ecn with all manuIds
140
141   Slat()->GetAllMotifPositionsIDs(ecn);
142 }
143
144 //_____________________________________________________________________________
145 const char*
146 AliMpSlatSegmentation::GetName() const
147 {
148   /// The name of this segmentation is "SlatSegmentation"+slatName
149
150   TString name("SlatSegmentation");
151   if ( fkSlat) 
152   {
153     name += ".";
154     name += fkSlat->GetName();
155   }
156   return name.Data();
157 }
158
159 //_____________________________________________________________________________
160 Int_t 
161 AliMpSlatSegmentation::MaxPadIndexX() const
162 {
163   ///
164   /// Returns the value of the largest pad index in x-direction.
165   ///
166   
167   return fkSlat->GetMaxPadIndexX();
168 }
169
170 //_____________________________________________________________________________
171 Int_t 
172 AliMpSlatSegmentation::MaxPadIndexY() const
173 {
174   ///
175   /// Returns the value of the largest pad index in y-direction.
176   ///
177   
178   return fkSlat->GetMaxNofPadsY()-1;
179 }
180
181 //_____________________________________________________________________________
182 Int_t 
183 AliMpSlatSegmentation::NofPads() const
184 {
185 /// Return number of pads defined in the slat
186   
187   return fkSlat->NofPads();
188 }
189
190 //_____________________________________________________________________________
191 AliMpPad
192 AliMpSlatSegmentation::PadByLocation(Int_t manuId, Int_t manuChannel, 
193                                      Bool_t warning) const
194 {
195   ///
196   /// Returns the pad specified by its location, where location is the 
197   /// pair (ManuID,ManuChannel).
198   /// If warning=kTRUE and the pad does not exist, a warning message is 
199   /// printed.
200   ///
201   /// AliMpPad::Invalid() is returned if there's no pad at the given location.
202   ///
203   AliMpMotifPosition* motifPos = fkSlat->FindMotifPosition(manuId);
204         
205   if (!motifPos)
206   {
207     if (warning)
208     {
209       AliWarning(Form("Manu ID %d not found in slat %s",
210                        manuId, fkSlat->GetID()));
211     }
212     return AliMpPad::Invalid();
213   }
214   AliMpVMotif* motif = motifPos->GetMotif();
215   MpPair_t localIndices = 
216     motif->GetMotifType()->FindLocalIndicesByGassiNum(manuChannel);
217         
218   if ( localIndices < 0 ) 
219   {
220     if (warning) 
221     {
222       AliWarning(Form("The pad number %d doesn't exists",
223                  manuChannel));
224     }
225     return AliMpPad::Invalid();
226   }
227         
228   return AliMpPad(manuId, manuChannel,
229                   motifPos->GlobalIndices(localIndices),
230                   motifPos->Position() 
231                   + motif->PadPositionLocal(localIndices) 
232                   - fkSlat->Position(),
233                   motif->GetPadDimensionsByIndices(localIndices));  
234 }
235
236 //_____________________________________________________________________________
237 AliMpPad
238 AliMpSlatSegmentation::PadByIndices(Int_t ix, Int_t iy, 
239                                     Bool_t warning) const
240 {
241   ///
242   /// Returns the pad specified by its integer indices.
243   /// If warning=kTRUE and the pad does not exist, a warning message is 
244   /// printed.
245   ///
246   /// AliMpPad::Invalid() is returned if there's no pad at the given location.
247   ///
248   ///  
249   /// FIXME: except for the FindMotifPosition below, this method
250   /// is exactly as the one in AliMpSectorSegmentation.
251   /// See if we can merge them somehow.
252         
253   AliMpMotifPosition* motifPos = fkSlat->FindMotifPosition(ix,iy);
254   
255   if (!motifPos)
256   {
257     if ( warning ) 
258     {
259       AliWarning(Form("No motif found containing pad location (%d,%d)",ix,iy));   
260     }
261     return AliMpPad::Invalid();
262   }
263         
264   AliMpVMotif* motif = motifPos->GetMotif();
265   AliMpMotifType* motifType = motif->GetMotifType();
266   MpPair_t localIndices = AliMp::Pair(ix,iy) - motifPos->GetLowIndicesLimit();
267   AliMpConnection* connection 
268     = motifType->FindConnectionByLocalIndices(localIndices);
269   
270   if (!connection)
271   {
272     if ( warning )
273     {
274       AliWarning(Form("No connection for pad location (%d,%d)",ix,iy));
275     }
276     return AliMpPad::Invalid();
277   }
278
279   return AliMpPad(motifPos->GetID(),connection->GetManuChannel(),
280                   ix, iy,
281                   motifPos->Position()
282                   + motif->PadPositionLocal(localIndices)
283                   - fkSlat->Position(),
284                   motif->GetPadDimensionsByIndices(localIndices));
285 }
286
287 //_____________________________________________________________________________
288 AliMpPad
289 AliMpSlatSegmentation::PadByPosition(const TVector2& position, 
290                                      Bool_t warning) const
291 {
292   ///
293   /// Returns the pad specified by its (floating point) position.
294   /// If warning=kTRUE and the pad does not exist, a warning message is 
295   /// printed.
296   ///
297   /// AliMpPad::Invalid() is returned if there's no pad at the given location.
298   ///
299   
300   TVector2 blPos(position);
301   
302   blPos += fkSlat->Position(); // position relative to bottom-left of the slat.
303   
304   AliMpMotifPosition* motifPos = fkSlat->FindMotifPosition(blPos.X(),blPos.Y());
305         
306   if (!motifPos)
307         {
308                 if (warning) 
309                 {
310                         AliWarning(Form("Slat %s Position (%e,%e)/center (%e,%e)/bottom-left cm "
311                       " outside limits",fkSlat->GetID(),
312                       position.X(),position.Y(),
313                       blPos.X(),blPos.Y()));
314                 }
315                 return AliMpPad::Invalid();
316         }
317         
318   AliMpVMotif* motif =  motifPos->GetMotif();  
319   blPos -= motifPos->Position();
320   MpPair_t localIndices = motif->PadIndicesLocal(blPos);
321         
322   AliMpConnection* connect = 
323     motif->GetMotifType()->FindConnectionByLocalIndices(localIndices);
324         
325   if (!connect)
326         {
327                 if (warning) 
328                 {
329                       AliWarning(Form("Slat %s localIndices (%d,%d) outside motif %s limits",
330                       fkSlat->GetID(),AliMp::PairFirst(localIndices),
331                       AliMp::PairSecond(localIndices),motif->GetID().Data()));
332                 }
333                 return AliMpPad::Invalid();
334         }
335   
336   return AliMpPad(motifPos->GetID(),connect->GetManuChannel(),
337                   motifPos->GlobalIndices(localIndices),
338                   motifPos->Position()
339                   + motif->PadPositionLocal(localIndices)
340                   - fkSlat->Position(),
341                   motif->GetPadDimensionsByIndices(localIndices));  
342 }
343
344 //_____________________________________________________________________________
345 AliMp::PlaneType
346 AliMpSlatSegmentation::PlaneType() const
347 {
348   return Slat()->PlaneType();
349 }
350
351 //_____________________________________________________________________________
352 void
353 AliMpSlatSegmentation::Print(Option_t* opt) const
354 {
355 /// Printing
356
357   fkSlat->Print(opt);
358 }
359
360 //_____________________________________________________________________________
361 const AliMpSlat* 
362 AliMpSlatSegmentation::Slat() const
363 {
364   ///
365   /// Returns the pointer to the referenced slat.
366   ///
367   
368   return fkSlat;
369 }
370
371 //_____________________________________________________________________________
372 Bool_t 
373 AliMpSlatSegmentation::HasPadByIndices(Int_t ix, Int_t iy) const
374 {
375   /// Tell whether we have a pad at indices=(ix,iy)
376   
377   AliMpMotifPosition* motifPos = Slat()->FindMotifPosition(ix, iy);
378   
379   if (motifPos) return motifPos->HasPadByIndices(AliMp::Pair(ix, iy));
380   
381   return kFALSE;
382 }
383
384 //_____________________________________________________________________________
385 Bool_t 
386 AliMpSlatSegmentation::HasPadByLocation(Int_t manuId, Int_t manuChannel) const
387 {
388   /// Tell whether we have a pad at location=(manuId,manuChannel)
389   
390   AliMpMotifPosition* motifPos = Slat()->FindMotifPosition(manuId);
391   
392   if ( motifPos ) return motifPos->HasPadByManuChannel(manuChannel);
393   
394   return kFALSE;  
395 }
396
397
398 //_____________________________________________________________________________
399 Int_t 
400 AliMpSlatSegmentation::GetNofElectronicCards() const
401 {
402   /// Get the number of manus of this slat
403   return Slat()->GetNofElectronicCards();
404
405 }
406
407 //_____________________________________________________________________________
408 TVector2 
409 AliMpSlatSegmentation::Position() const
410 {
411   /// Return position of origin
412   
413   return Slat()->Position();
414 }
415
416 //_____________________________________________________________________________
417 Bool_t 
418 AliMpSlatSegmentation::HasMotifPosition(Int_t manuId) const
419 {
420   /// Use default implementation
421   return AliMpVSegmentation::HasMotifPosition(manuId);
422 }
423
424 //_____________________________________________________________________________
425 AliMpMotifPosition* 
426 AliMpSlatSegmentation::MotifPosition(Int_t manuId) const
427 {
428   /// Get back a given manu
429   return Slat()->FindMotifPosition(manuId);
430 }
431