Some changes to make it possible to run the DA's
[u/mrichter/AliRoot.git] / FMD / AliFMDBaseDigit.cxx
1 /*************************************************************************
2  * Copyright(c) 2004, 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  * $Id$ */
16 /**
17  * @file    AliFMDBaseDigit.cxx
18  * @author  Christian Holm Christensen <cholm@nbi.dk>
19  * @date    Mon Mar 27 12:37:41 2006
20  * @brief   Digits for the FMD 
21  * @ingroup FMD_base
22  */
23 //////////////////////////////////////////////////////////////////////
24 //
25 //  Digits classes for the FMD                
26 //
27 //  Digits consists of
28 //   - Detector #
29 //   - Ring ID                                             
30 //   - Sector #     
31 //   - Strip #
32 //   - ADC count in this channel                                  
33 //
34 //  Digits consists of
35 //   - Detector #
36 //   - Ring ID                                             
37 //   - Sector #     
38 //   - Strip #
39 //   - Total energy deposited in the strip
40 //   - ADC count in this channel                                  
41 //
42 // As the Digits and SDigits have so much in common, the classes
43 // AliFMDDigit and AliFMDSDigit are implemented via a base
44 // class AliFMDBaseDigit.
45 ///
46 //              +-----------------+
47 //              | AliFMDBaseDigit |
48 //              +-----------------+
49 //                      ^
50 //                      |
51 //                +------------+
52 //                |            |
53 //      +-------------+ +--------------+
54 //      | AliFMDDigit | | AliFMDSDigit |
55 //      +-------------+ +--------------+
56 //
57 // (Note, that I'd really would have liked to implement AliFMDHit as a
58 // derived class from some base class - say AliFMDStrip, and the Digit
59 // classes would (eventually) have derived from that as well.
60 // However, ROOT doesn't do well with multiple inheritance, so I chose
61 // not to anyway).
62 //
63 // Latest changes by Christian Holm Christensen
64 //
65 //////////////////////////////////////////////////////////////////////
66
67 #include "AliFMDBaseDigit.h"    // ALIFMDDIGIT_H
68 #include "AliFMDStripIndex.h"
69 #include "Riostream.h"          // ROOT_Riostream
70 // #include <TString.h>
71 // #include <AliLog.h>
72 #include "AliFMDDebug.h" // Better debug macros
73
74 //====================================================================
75 using std::cout;
76 using std::flush;
77 ClassImp(AliFMDBaseDigit)
78 #if 0
79   ; // This is here to keep Emacs from indenting the next line
80 #endif
81
82 //____________________________________________________________________
83 AliFMDBaseDigit::AliFMDBaseDigit()
84   : fDetector(0), 
85     fRing('\0'), 
86     fSector(0), 
87     fStrip(0), 
88     fName("")
89 {
90   // 
91   // CTOR 
92   //
93 }
94
95 //____________________________________________________________________
96 AliFMDBaseDigit::AliFMDBaseDigit(UShort_t detector, 
97                                  Char_t   ring, 
98                                  UShort_t sector, 
99                                  UShort_t strip)
100   : AliDigit(), 
101     fDetector(detector), 
102     fRing(ring), 
103     fSector(sector), 
104     fStrip(strip),
105     fName("")
106 {
107   //
108   // Creates a base data digit object
109   //
110   // Parameters 
111   //
112   //    detector  Detector # (1, 2, or 3)                      
113   //    ring      Ring ID ('I' or 'O')
114   //    sector    Sector # (For inner/outer rings: 0-19/0-39)
115   //    strip     Strip # (For inner/outer rings: 0-511/0-255)
116 }
117
118 //____________________________________________________________________
119 AliFMDBaseDigit::AliFMDBaseDigit(Int_t*   tracks, 
120                                  UShort_t detector, 
121                                  Char_t   ring, 
122                                  UShort_t sector, 
123                                  UShort_t strip)
124   : AliDigit(tracks), 
125     fDetector(detector), 
126     fRing(ring), 
127     fSector(sector), 
128     fStrip(strip),
129     fName("")
130 {
131   //
132   // Creates a base data digit object
133   //
134   // Parameters 
135   //
136   //    tracks    Array of 3 track labels
137   //    detector  Detector # (1, 2, or 3)                      
138   //    ring      Ring ID ('I' or 'O')
139   //    sector    Sector # (For inner/outer rings: 0-19/0-39)
140   //    strip     Strip # (For inner/outer rings: 0-511/0-255)
141 }
142
143 //____________________________________________________________________
144 void
145 AliFMDBaseDigit::Print(Option_t* /* option*/) const 
146 {
147   // Print digit to standard out 
148   cout << ClassName() << ": " << GetName() << flush;
149 }
150
151 //____________________________________________________________________
152 const char*
153 AliFMDBaseDigit::GetName() const 
154
155   // Get the name of a FMD digit.
156   if (fName.IsNull()) 
157     fName = Form("FMD%d%c[%2d,%3d]", fDetector, fRing, fSector, fStrip);
158   return fName.Data();
159 }
160 #define fMaxStrips  512
161 #define fMaxSectors 40
162 #define fMaxRings   2
163
164 //____________________________________________________________________
165 ULong_t
166 AliFMDBaseDigit::Hash() const
167 {
168   // Calculate a hash value based on the detector coordinates. 
169 #if 1  
170   return AliFMDStripIndex::Pack(fDetector, fRing, fSector, fStrip);
171 #else
172   size_t ringi = (fRing == 'I' ||  fRing == 'i' ? 0 : 1);
173   return fStrip + fMaxStrips * 
174     (fSector + fMaxSectors * (ringi + fMaxRings * (fDetector - 1)));
175 #endif
176 }
177
178
179 //____________________________________________________________________
180 Int_t
181 AliFMDBaseDigit::Compare(const TObject* o) const
182 {
183   // Compare to other digit.  If the passed pointer to TObject does
184   // not point to an object of class AliFMDBaseDigit (or one of it's
185   // derived classes), then a fatal exception is made. 
186   // 
187   // Returns -1, if this object's detector coordinates are smaller
188   // than passed object's detector coordinates. 
189   // 
190   // Returns  0, if this object's detector coordinates is the same as
191   // passed object's detector coordinates.  
192   // 
193   // Returns  1, if this object's detector coordinates are larger
194   // than passed object's detector coordinates. 
195   if (!o) 
196     AliFatal("Can not compare to NULL!");
197   if (o->IsA() != AliFMDBaseDigit::Class()) 
198     AliFatal(Form("Cannot compare to a %s object", o->ClassName()));
199   // AliFMDBaseDigit* of = static_cast<AliFMDBaseDigit*>(o);
200   if (Hash() == o->Hash()) return 0;
201   if (Hash() < o->Hash()) return -1;
202   return 1;
203 }
204
205 //____________________________________________________________________
206 void
207 AliFMDBaseDigit::AddTrack(Int_t track)
208 {
209   // 
210   // Add a track referenc
211   // 
212   // Parameters:
213   //    trackno The track number
214   //  
215   if      (fTracks[0] == -1) fTracks[0] = track;
216   else if (fTracks[1] == -1) fTracks[1] = track;
217   else if (fTracks[2] == -1) fTracks[2] = track;
218   else 
219     AliFMDDebug(1, ("While adding track label to %s for %s: "
220                     "All 3 track labels used, can't add "
221                     "reference to track %d",
222                     ClassName(), GetName(), track));
223 }
224
225 //____________________________________________________________________
226 UShort_t
227 AliFMDBaseDigit::GetNTrack() const
228 {
229   // 
230   // Get the number of track references (max 3)
231   // 
232   // 
233   // Return:
234   //    Number of valid track references. 
235   //
236   for (Int_t i = 3; i > 0; i--) 
237     if (fTracks[i-1] != -1) return i;
238   return 0;
239 }
240
241
242 //____________________________________________________________________
243 //
244 // EOF
245 //