01-sep-2003 NvE Explicit initialisation of TObject() introduced in default constructo...
[u/mrichter/AliRoot.git] / RALICE / AliJet.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 ///////////////////////////////////////////////////////////////////////////
19 // Class AliJet
20 // Creation and investigation of a jet of particle tracks.
21 // An AliJet can be constructed by adding AliTracks.
22 //
23 // To provide maximal flexibility to the user, two modes of track storage
24 // are provided by means of the memberfunction SetTrackCopy().
25 //
26 // a) SetTrackCopy(0) (which is the default).
27 //    Only the pointers of the 'added' tracks are stored.
28 //    This mode is typically used by making jet studies based on a fixed list
29 //    of tracks which stays under user control or is contained for instance
30 //    in an AliEvent.  
31 //    In this way the AliJet just represents a 'logical structure' for the
32 //    physics analysis which can be embedded in e.g. an AliEvent or AliVertex.
33 //
34 //    Note :
35 //    Modifications made to the original tracks also affect the AliTrack objects
36 //    which are stored in the AliJet. 
37 //
38 // b) SetTrackCopy(1).
39 //    Of every 'added' track a private copy will be made of which the pointer
40 //    will be stored.
41 //    In this way the AliJet represents an entity on its own and modifications
42 //    made to the original tracks do not affect the AliTrack objects which are
43 //    stored in the AliJet. 
44 //    This mode will allow 'adding' many different AliTracks into an AliJet by
45 //    creating only one AliTrack instance in the main programme and using the
46 //    AliTrack::Reset() and AliTrack parameter setting memberfunctions.
47 //
48 // See also the documentation provided for the memberfunction SetOwner(). 
49 //
50 // Coding example to make 2 jets j1 and j2.
51 // ----------------------------------------
52 // j1 contains the AliTracks t1 and t2
53 // j2 contains 10 different AliTracks via tx
54 //
55 // AliTrack t1,t2;
56 //  ...
57 //  ... // code to fill the AliTrack data
58 //  ...
59 // AliJet j1();
60 // j1.AddTrack(t1);
61 // j1.AddTrack(t2);
62 //
63 // AliJet j2();
64 // j2.SetTrackCopy(1);
65 // AliTrack* tx=new AliTrack();
66 // for (Int_t i=0; i<10; i++)
67 // {
68 //  ...
69 //  ... // code to set momentum etc... of the track tx
70 //  ...
71 //  j2.AddTrack(tx);
72 //  tx->Reset();
73 // }
74 //
75 // j1.Data();
76 // j2.Data("sph");
77 //
78 // Float_t e1=j1.GetEnergy();
79 // Float_t pnorm=j1->GetMomentum();
80 // Ali3Vector p=j1->Get3Momentum();
81 // Float_t m=j1.GetInvmass();
82 // Int_t ntk=j1.GetNtracks();
83 // AliTrack* tj=j1.GetTrack(1);
84 //
85 // delete tx;
86 //
87 // Note : All quantities are in GeV, GeV/c or GeV/c**2
88 //
89 //--- Author: Nick van Eijndhoven 10-jul-1997 UU-SAP Utrecht
90 //- Modified: NvE $Date$ UU-SAP Utrecht
91 ///////////////////////////////////////////////////////////////////////////
92
93 #include "AliJet.h"
94 #include "Riostream.h"
95  
96 ClassImp(AliJet) // Class implementation to enable ROOT I/O
97  
98 AliJet::AliJet() : TObject(),Ali4Vector()
99 {
100 // Default constructor
101 // All variables initialised to 0
102 // Initial maximum number of tracks is set to the default value
103  Init();
104  Reset();
105  SetNtinit();
106 }
107 ///////////////////////////////////////////////////////////////////////////
108 void AliJet::Init()
109 {
110 // Initialisation of pointers etc...
111  fTracks=0;
112  fNtinit=0;
113  fTrackCopy=0;
114 }
115 ///////////////////////////////////////////////////////////////////////////
116 AliJet::AliJet(Int_t n) : TObject(),Ali4Vector()
117 {
118 // Create a jet to hold initially a maximum of n tracks
119 // All variables initialised to 0
120  Init();
121  Reset();
122  if (n > 0)
123  {
124   SetNtinit(n);
125  }
126  else
127  {
128   cout << endl;
129   cout << " *AliJet* Initial max. number of tracks entered : " << n << endl;
130   cout << " This is invalid. Default initial maximum will be used." << endl;
131   cout << endl;
132   SetNtinit();
133  }
134 }
135 ///////////////////////////////////////////////////////////////////////////
136 AliJet::~AliJet()
137 {
138 // Default destructor
139  if (fTracks)
140  {
141   delete fTracks;
142   fTracks=0;
143  }
144 }
145 ///////////////////////////////////////////////////////////////////////////
146 void AliJet::SetOwner(Bool_t own)
147 {
148 // Set ownership of all added objects. 
149 // The default parameter is own=kTRUE.
150 //
151 // Invokation of this memberfunction also sets all the copy modes
152 // (e.g. TrackCopy & co.) according to the value of own.
153 //
154 // This function (with own=kTRUE) is particularly useful when reading data
155 // from a tree/file, since Reset() will then actually remove all the
156 // added objects from memory irrespective of the copy mode settings
157 // during the tree/file creation process. In this way it provides a nice way
158 // of preventing possible memory leaks in the reading/analysis process.
159 //
160 // In addition this memberfunction can also be used as a shortcut to set all
161 // copy modes in one go during a tree/file creation process.
162 // However, in this case the user has to take care to only set/change the
163 // ownership (and copy mode) for empty objects (e.g. newly created objects
164 // or after invokation of the Reset() memberfunction) otherwise it will
165 // very likely result in inconsistent destructor behaviour.
166
167  Int_t mode=1;
168  if (!own) mode=0;
169  if (fTracks) fTracks->SetOwner(own);
170  fTrackCopy=mode;
171 }
172 ///////////////////////////////////////////////////////////////////////////
173 AliJet::AliJet(AliJet& j) : TObject(j),Ali4Vector(j)
174 {
175 // Copy constructor
176  fNtinit=j.fNtinit;
177  fNtmax=j.fNtmax;
178  fQ=j.fQ;
179  fNtrk=j.fNtrk;
180  fTrackCopy=j.fTrackCopy;
181  fUserId=j.fUserId;
182
183  fTracks=0;
184  if (fNtrk)
185  {
186   fTracks=new TObjArray(fNtmax);
187   if (fTrackCopy) fTracks->SetOwner();
188  }
189
190  for (Int_t i=1; i<=fNtrk; i++)
191  {
192   AliTrack* tx=j.GetTrack(i);
193   if (fTrackCopy)
194   {
195    fTracks->Add(new AliTrack(*tx));
196   }
197   else
198   {
199    fTracks->Add(tx);
200   }
201  } 
202 }
203 ///////////////////////////////////////////////////////////////////////////
204 void AliJet::SetNtinit(Int_t n)
205 {
206 // Set the initial maximum number of tracks for this jet
207  fNtinit=n;
208  fNtmax=n;
209  if (fTracks)
210  {
211   delete fTracks;
212   fTracks=0;
213  }
214 }
215 ///////////////////////////////////////////////////////////////////////////
216 void AliJet::Reset()
217 {
218 // Reset all variables to 0
219 // The max. number of tracks is set to the initial value again
220  fNtrk=0;
221  fQ=0;
222  fUserId=0;
223  Double_t a[4]={0,0,0,0};
224  SetVector(a,"sph");
225  if (fNtinit > 0) SetNtinit(fNtinit);
226 }
227 ///////////////////////////////////////////////////////////////////////////
228 void AliJet::AddTrack(AliTrack& t)
229 {
230 // Add a track to the jet.
231 // In case the maximum number of tracks has been reached
232 // space will be extended to hold an additional amount of tracks as
233 // was initially reserved.
234 // See SetTrackCopy() to tailor the functionality of the stored structures.
235  AddTrack(t,1);
236 }
237 ///////////////////////////////////////////////////////////////////////////
238 void AliJet::AddTrack(AliTrack& t,Int_t copy)
239 {
240 // Internal memberfunction to actually add a track to the jet.
241 // In case the maximum number of tracks has been reached
242 // space will be extended to hold an additional amount of tracks as
243 // was initially reserved.
244 //
245 // If copy=0 NO copy of the track will be made, irrespective of the setting
246 // of the TrackCopy flag.
247 // This allows a proper treatment of automatically generated connecting
248 // tracks between vertices.
249  if (!fTracks)
250  {
251   fTracks=new TObjArray(fNtmax);
252   if (fTrackCopy) fTracks->SetOwner();
253  }
254  if (fNtrk == fNtmax) // Check if maximum track number is reached
255  {
256   fNtmax+=fNtinit;
257   fTracks->Expand(fNtmax);
258  }
259  
260  // Add the track to this jet
261  fNtrk++;
262  if (fTrackCopy && copy)
263  {
264   fTracks->Add(new AliTrack(t));
265  }
266  else
267  {
268   fTracks->Add(&t);
269  }
270
271  (*this)+=(Ali4Vector&)t;
272  fQ+=t.GetCharge();
273
274 }
275 ///////////////////////////////////////////////////////////////////////////
276 void AliJet::Data(TString f)
277 {
278 // Provide jet information within the coordinate frame f
279  cout << " *AliJet::Data* Id : " << fUserId << " Invmass : " << GetInvmass() << " Charge : " << fQ
280       << " Momentum : " << GetMomentum() << " Ntracks : " << fNtrk << endl;
281
282  Ali4Vector::Data(f); 
283
284 ///////////////////////////////////////////////////////////////////////////
285 void AliJet::List(TString f)
286 {
287 // Provide jet and primary track information within the coordinate frame f
288
289  Data(f); // Information of the current jet
290
291  // The tracks of this jet
292  AliTrack* t; 
293  for (Int_t it=1; it<=fNtrk; it++)
294  {
295   t=GetTrack(it);
296   if (t)
297   {
298    cout << "  ---Track no. " << it << endl;
299    cout << " ";
300    t->Data(f); 
301   }
302   else
303   {
304    cout << " *AliJet::List* Error : No track present." << endl; 
305   }
306  }
307
308 ///////////////////////////////////////////////////////////////////////////
309 void AliJet::ListAll(TString f)
310 {
311 // Provide jet and prim.+sec. track information within the coordinate frame f
312
313  Data(f); // Information of the current jet
314
315  // The tracks of this jet
316  AliTrack* t; 
317  for (Int_t it=1; it<=fNtrk; it++)
318  {
319   t=GetTrack(it);
320   if (t)
321   {
322    cout << "  ---Track no. " << it << endl;
323    cout << " ";
324    t->ListAll(f); 
325   }
326   else
327   {
328    cout << " *AliJet::List* Error : No track present." << endl; 
329   }
330  }
331
332 ///////////////////////////////////////////////////////////////////////////
333 Int_t AliJet::GetNtracks()
334 {
335 // Return the current number of tracks of this jet
336  return fNtrk;
337 }
338 ///////////////////////////////////////////////////////////////////////////
339 Double_t AliJet::GetEnergy()
340 {
341 // Return the total energy of the jet
342  return GetScalar();
343 }
344 ///////////////////////////////////////////////////////////////////////////
345 Double_t AliJet::GetMomentum()
346 {
347 // Return the value of the total jet 3-momentum
348 // The error can be obtained by invoking GetResultError() after
349 // invokation of GetMomentum().
350  Double_t norm=fV.GetNorm();
351  fDresult=fV.GetResultError();
352  return norm;
353 }
354 ///////////////////////////////////////////////////////////////////////////
355 Ali3Vector AliJet::Get3Momentum()
356 {
357 // Return the the total jet 3-momentum
358  Ali3Vector p=Get3Vector();
359  return p;
360 }
361 ///////////////////////////////////////////////////////////////////////////
362 Double_t AliJet::GetInvmass()
363 {
364 // Return the invariant mass of the jet
365  Double_t m2=Dot(*this);
366  if (m2>0)
367  {
368   return sqrt(m2);
369  }
370  else
371  {
372   return 0;
373  }
374 }
375 ///////////////////////////////////////////////////////////////////////////
376 Float_t AliJet::GetCharge()
377 {
378 // Return the total charge of the jet
379  return fQ;
380 }
381 ///////////////////////////////////////////////////////////////////////////
382 AliTrack* AliJet::GetTrack(Int_t i)
383 {
384 // Return the i-th track of this jet
385  if (!fTracks)
386  {
387   cout << " *AliJet*::GetTrack* No tracks present." << endl;
388   return 0;
389  }
390  else
391  {
392   if (i<=0 || i>fNtrk)
393   {
394    cout << " *AliJet*::GetTrack* Invalid argument i : " << i
395         << " Ntrk = " << fNtrk << endl;
396    return 0;
397   }
398   else
399   {
400    return (AliTrack*)fTracks->At(i-1);
401   }
402  }
403 }
404 ///////////////////////////////////////////////////////////////////////////
405 AliTrack* AliJet::GetIdTrack(Int_t id)
406 {
407 // Return the track with user identifier "id" of this jet
408  AliTrack* tx=0;
409  AliTrack* t=0;
410  if (!fTracks)
411  {
412   cout << " *AliJet*::GetIdTrack* No tracks present." << endl;
413   return 0;
414  }
415  else
416  {
417   for (Int_t i=0; i<fNtrk; i++)
418   {
419    tx=(AliTrack*)fTracks->At(i);
420    if (id == tx->GetId()) t=tx;
421   }
422   return t;
423  }
424 }
425 ///////////////////////////////////////////////////////////////////////////
426 Double_t AliJet::GetPt()
427 {
428 // Provide trans. momentum value w.r.t. z-axis.
429 // The error on the value can be obtained by GetResultError()
430 // after invokation of GetPt().
431  Ali3Vector v;
432  v=GetVecTrans();
433  Double_t norm=v.GetNorm();
434  fDresult=v.GetResultError();
435
436  return norm;
437 }
438 ///////////////////////////////////////////////////////////////////////////
439 Double_t AliJet::GetPl()
440 {
441 // Provide long. momentum value w.r.t. z-axis.
442 // Note : the returned value can also be negative.
443 // The error on the value can be obtained by GetResultError()
444 // after invokation of GetPl().
445  Ali3Vector v;
446  v=GetVecLong();
447
448  Double_t pl=v.GetNorm();
449  fDresult=v.GetResultError();
450
451  Double_t a[3];
452  v.GetVector(a,"sph");
453  if (cos(a[1])<0) pl=-pl;
454
455  return pl;
456 }
457 ///////////////////////////////////////////////////////////////////////////
458 Double_t AliJet::GetEt()
459 {
460 // Provide trans. energy value w.r.t. z-axis.
461 // The error on the value can be obtained by GetResultError()
462 // after invokation of GetEt().
463  Double_t et=GetScaTrans();
464
465  return et;
466 }
467 ///////////////////////////////////////////////////////////////////////////
468 Double_t AliJet::GetEl()
469 {
470 // Provide long. energy value w.r.t. z-axis.
471 // Note : the returned value can also be negative.
472 // The error on the value can be obtained by GetResultError()
473 // after invokation of GetEl().
474  Double_t el=GetScaLong();
475
476  return el;
477 }
478 ///////////////////////////////////////////////////////////////////////////
479 Double_t AliJet::GetMt()
480 {
481 // Provide transverse mass value w.r.t. z-axis.
482 // The error on the value can be obtained by GetResultError()
483 // after invokation of GetMt().
484  Double_t pt=GetPt();
485  Double_t dpt=GetResultError();
486  Double_t m=GetInvmass();
487  Double_t dm=GetResultError();
488
489  Double_t mt=sqrt(pt*pt+m*m);
490  Double_t dmt2=0;
491  if (mt) dmt2=(pow((pt*dpt),2)+pow((m*dm),2))/(mt*mt);
492
493  fDresult=sqrt(dmt2);
494  return mt;
495 }
496 ///////////////////////////////////////////////////////////////////////////
497 Double_t AliJet::GetRapidity()
498 {
499 // Provide rapidity value w.r.t. z-axis.
500 // The error on the value can be obtained by GetResultError()
501 // after invokation of GetRapidity().
502 // Note : Also GetPseudoRapidity() is available since this class is
503 //        derived from Ali4Vector.
504  Double_t e=GetEnergy();
505  Double_t de=GetResultError();
506  Double_t pl=GetPl();
507  Double_t dpl=GetResultError();
508  Double_t sum=e+pl;
509  Double_t dif=e-pl;
510
511  Double_t y=9999,dy2=0;
512  if (sum && dif) y=0.5*log(sum/dif);
513
514  if (sum*dif) dy2=(1./(sum*dif))*(pow((pl*de),2)+pow((e*dpl),2));
515
516  fDresult=sqrt(dy2);
517  return y;
518 }
519 ///////////////////////////////////////////////////////////////////////////
520 void AliJet::SetTrackCopy(Int_t j)
521 {
522 // (De)activate the creation of private copies of the added tracks.
523 // j=0 ==> No private copies are made; pointers of original tracks are stored.
524 // j=1 ==> Private copies of the tracks are made and these pointers are stored.
525 //
526 // Note : Once the storage contains pointer(s) to AliTrack(s) one cannot
527 //        change the TrackCopy mode anymore.
528 //        To change the TrackCopy mode for an existing AliJet containing
529 //        tracks one first has to invoke Reset().
530  if (!fTracks)
531  {
532   if (j==0 || j==1)
533   {
534    fTrackCopy=j;
535   }
536   else
537   {
538    cout << "*AliJet::SetTrackCopy* Invalid argument : " << j << endl;
539   }
540  }
541  else
542  {
543   cout << "*AliJet::SetTrackCopy* Storage already contained tracks."
544        << "  ==> TrackCopy mode not changed." << endl; 
545  }
546 }
547 ///////////////////////////////////////////////////////////////////////////
548 Int_t AliJet::GetTrackCopy()
549 {
550 // Provide value of the TrackCopy mode.
551 // 0 ==> No private copies are made; pointers of original tracks are stored.
552 // 1 ==> Private copies of the tracks are made and these pointers are stored.
553  return fTrackCopy;
554 }
555 ///////////////////////////////////////////////////////////////////////////
556 void AliJet::SetId(Int_t id)
557 {
558 // Set a user defined identifier for this jet.
559  fUserId=id;
560 }
561 ///////////////////////////////////////////////////////////////////////////
562 Int_t AliJet::GetId()
563 {
564 // Provide the user defined identifier of this jet.
565  return fUserId;
566 }
567 ///////////////////////////////////////////////////////////////////////////