Adding new classes (Haavard)
[u/mrichter/AliRoot.git] / MUON / AliMUONVDigit.cxx
CommitLineData
d6c3334d 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
3d1463c8 18//-----------------------------------------------------------------------------
d6c3334d 19/// \class AliMUONVDigit
20///
21/// This is the base class of a MUON digit that most client code should deal with.
22/// There should be no reason to have to use a concrete class in most cases.
23///
24/// All digits have basic features, like :
25///
26/// - a way to identify it : detection element, electronics card and
27/// channel, cathode. Note that some static methods exists to compact
28/// those 4 informations into a single 4 bytes integer (stored in the
29/// fUniqueID data member present in all TObjects).
30///
31/// - its charge
32///
33/// - a set of boolean methods to indicate whether the digit has been calibrated, etc...
34///
35/// In addition, if HasMCInformation is true, the digit store also the list
36/// of MC tracks that contributed to its charge
37///
38/// Also, if HasGeometryInformation is true, the digit knows the position and
39/// the (half) dimensions (in cm) of the pad it corresponds to.
40///
41/// \author Laurent Aphecetche, Subatech
3d1463c8 42//-----------------------------------------------------------------------------
d6c3334d 43
44#include "AliMUONVDigit.h"
45
46#include <Riostream.h>
47#include <TClass.h>
48
49/// \cond CLASSIMP
50ClassImp(AliMUONVDigit)
51/// \endcond
52
53//_____________________________________________________________________________
54AliMUONVDigit::AliMUONVDigit(Int_t detElemId, Int_t eCardId,
55 Int_t eCardChannel, Int_t cathode)
56: TObject()
57{
58 /// Normal constructor for trigger digits
59 SetUniqueID(BuildUniqueID(detElemId,eCardId,eCardChannel,cathode));
60}
61
62//_____________________________________________________________________________
63AliMUONVDigit::AliMUONVDigit()
64{
65 /// Default ctor
66}
67
68//_____________________________________________________________________________
69AliMUONVDigit::~AliMUONVDigit()
70{
71 /// dtor
72}
73
74//_____________________________________________________________________________
36a01415 75Bool_t
76AliMUONVDigit::IsEqual(const TObject* object) const
77{
22dce0e3 78 /// Whether we're equal to object.
79 /// WARNING : only based on our identifiers (de,manu,channel,cathode), not our
80 /// content (i.e. charge, status...)
81
36a01415 82 const AliMUONVDigit* d = static_cast<const AliMUONVDigit*>(object);
83
84 return ( DetElemId() == d->DetElemId() &&
85 Cathode() == d->Cathode() &&
86 ManuId() == d->ManuId() &&
87 ManuChannel() == d->ManuChannel() );
88}
89
90//_____________________________________________________________________________
91Int_t
92AliMUONVDigit::Compare(const TObject* object) const
93{
22dce0e3 94 /// Compare two digits, trying to get as complete an order as possible.
95 /// We sort by DE, then by charge, then by manu, etc...
96 ///
36a01415 97 const AliMUONVDigit* d = static_cast<const AliMUONVDigit*>(object);
98
99 if ( DetElemId() > d->DetElemId() )
100 {
101 return 1;
102 }
103 else if ( DetElemId() < d->DetElemId() )
104 {
105 return -1;
106 }
107 else
108 {
109 if ( Charge() > d->Charge() )
110 {
111 return 1;
112 }
113 else if ( Charge() < d->Charge() )
114 {
115 return -1;
116 }
117 else
118 {
119 if ( ManuId() < d->ManuId() )
120 {
121 return 1;
122 }
123 else if ( ManuId() > d->ManuId() )
124 {
125 return -1;
126 }
127 else
128 {
129 return ( ManuChannel() < d->ManuChannel() ) ? 1 : -1;
130 }
131 }
132 }
133 return 0;
134}
135
136//_____________________________________________________________________________
d6c3334d 137UInt_t
138AliMUONVDigit::BuildUniqueID(Int_t detElemId, Int_t manuId,
139 Int_t manuChannel, Int_t cathode)
140{
141 /// Build a single integer with id information
142 return ( ( detElemId ) | ( manuId << 12 ) | ( manuChannel << 24 )
143 | ( cathode << 30 ) );
144}
145
146//_____________________________________________________________________________
147Int_t
148AliMUONVDigit::DetElemId(UInt_t uniqueID)
149{
150 /// Return detection element id part of the uniqueID
151 return uniqueID & 0xFFF;
152}
153
154//_____________________________________________________________________________
155Int_t
156AliMUONVDigit::ManuChannel(UInt_t uniqueID)
157{
158 /// Return manuChannel part of the uniqueID
159 return ( uniqueID & 0x3F000000 ) >> 24;
160}
161
162//_____________________________________________________________________________
163Int_t
164AliMUONVDigit::ManuId(UInt_t uniqueID)
165{
166 /// Return manuId part of the uniqueID
167 return ( uniqueID & 0xFFF000 ) >> 12;
168}
169
170//_____________________________________________________________________________
171Int_t
172AliMUONVDigit::Cathode(UInt_t uniqueID)
173{
174 /// Return the cathode part of the uniqueID
175 return ( uniqueID & 0x40000000 ) >> 30;
176}
177
178//_____________________________________________________________________________
179void
180AliMUONVDigit::DecodeUniqueID(UInt_t uniqueID,
181 Int_t& detElemId, Int_t& manuId,
182 Int_t& manuChannel, Int_t& cathode)
183{
184 /// Unpack uniqueID into 4 elements
185 detElemId = DetElemId(uniqueID);
186 manuId = ManuId(uniqueID);
187 manuChannel = ManuChannel(uniqueID);
188 cathode = Cathode(uniqueID);
189}
190
191//_____________________________________________________________________________
192const char*
193AliMUONVDigit::GetName() const
194{
195 /// Return the name of this digit, composed of its id parts.
196 return Form("DE%04d-%04d-%02d-%d",
197 DetElemId(),ManuId(),ManuChannel(),Cathode());
198}
199
200//_____________________________________________________________________________
201void
202AliMUONVDigit::Print(Option_t* opt) const
203{
204 /// Dump to screen.
205 /// If opt=="tracks", info on tracks are printed too.
206
207 cout << Form("<%s>: ID %12u DE %4d Cath %d (Ix,Iy)=(%3d,%3d) (Manu,Channel)=(%4d,%2d)"
208 ", Charge=%7.2f",
209 ClassName(),GetUniqueID(),
210 DetElemId(),Cathode(),PadX(),PadY(),ManuId(),ManuChannel(),Charge());
211 if ( IsSaturated() )
212 {
213 cout << "(S)";
214 }
215 else
216 {
217 cout << " ";
218 }
219
220 if ( IsCalibrated() )
221 {
222 cout << "(C)";
223 }
224 else
225 {
226 cout << " ";
227 }
228
229 if ( IsUsed() )
230 {
231 cout << "(U)";
232 }
233 else
234 {
235 cout << " ";
236 }
237
238 cout << Form(" ADC=%4d StatusMap=%04x",ADC(),StatusMap());
239
240 TString options(opt);
241 options.ToLower();
242 if ( options.Contains("tracks") && HasMCInformation() )
243 {
244 cout << " Hit " << setw(3) << Hit();
245 Int_t ntracks = Ntracks();
246 if (ntracks)
247 {
248 cout << " Tracks : " << setw(2) << ntracks;
249 for ( Int_t i = 0; i < ntracks; ++i )
250 {
251 cout << " Track(" << i << ")=" << setw(3) << Track(i)
252 << " Charge(" << i << ")=" << setw(5) << TrackCharge(i);
253 }
254 }
255 else
256 {
257 cout << " no track info.";
258 }
259 }
260 cout << endl;
261}